Skip to content

Commit

Permalink
Inital Push
Browse files Browse the repository at this point in the history
  • Loading branch information
biofects committed Oct 29, 2024
0 parents commit 7ebf75a
Show file tree
Hide file tree
Showing 10 changed files with 934 additions and 0 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2024 biofects

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

108 changes: 108 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# 🚀 Enhanced Biofects Theme
**Enhanced Biofects Theme** is a Home Assistant theme showcases a sleek, futuristic design with a neon blue color scheme and glowing accents. The theme features a dark background with subtle circuit patterns, giving the dashboard a high-tech, sci-fi look. Cards appear to float with illuminated borders, enhancing readability and adding depth. Elements such as the sidebar, clock, and interactive panels have consistent color highlights, creating a cohesive, immersive experience. The dashboard layout efficiently organizes information, including a personalized greeting, daily quotes, weather data, and a to-do list, all accessible at a glance in a visually striking interface. **[WIP]**

<p align="center">
<img src="images/enhanced-biofects-ui.png" alt="Enhanced Biofects UI Theme" width="400"/>
<img src="images/enhanced-biofects-custom.png" alt="Enhanced Biofects custom theme" width="400"/>
</p>

---

## 🔍 About this Theme
**Enhanced Biofects Theme** This custom Home Assistant theme combines a sleek, high-tech look with a practical layout, designed to make smart home interactions more enjoyable and immersive.

## Features
- Sci-Fi Aesthetic: A dark background with neon blue accents and circuit-like patterns creates a sophisticated, futuristic vibe.
- Enhanced Readability: Neon-glowing borders around cards and text improve readability, especially in low-light conditions.
- Optimized Layout: Key elements such as weather, to-do lists, calendar events, and daily quotes are prominently displayed for easy access.
- Personalized Design: Adds a "wow" factor to your dashboard, turning it into a unique expression of style.
- Why Use This Theme?
-- This theme is ideal for anyone looking to elevate their Home Assistant dashboard with an immersive, sci-fi inspired interface that enhances both aesthetics and usability. Perfect for those who want a personalized, visually appealing, and organized smart home experience.

## Notes
My Home Assistant runs in Docker on a server. I don't use the supervised version, nor do I send any data to Home Assistant servers. This is my personal choice, despite it requiring more manual management.

<strong style="color:red;">I don’t know how it works with HAOS.</strong>

- I prioritize securing my network by blocking **phone home** calls from IoT devices, ensuring data privacy.
- My Home Assistant setup includes an array of devices, with plans to expand further. Here’s a snapshot of what I manage:

- 💡 Hue
- 🏠 Tuya
- 📊 Grafana for monitoring
- 🎞 Emby for media
- 🚪 Door locks
- 🔒 Cameras
- 💻 Local AI (on server)
- 🚦 Pi Hole for ad-blocking
- 🖥 Full network & server monitoring, including GPU & storage
- 🌀 Fans
- And much more to come!

---

## 💸 Donations Welcome!
If you find this theme useful, please consider donating. Your support is greatly appreciated!

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TWRQVYJWC77E6)

---

## 🔧 Plugins I Use to Achieve My Layout
These are the essential plugins that helped me craft my use of the Enhanced Biofects Theme experience:
- [ha-biofects-fullmenu](https://github.com/biofects/ha-biofects-fullmenu) - My Home page is a dynamic full page animated enu.
- [simple_sticky_note](https://github.com/biofects/simple_sticky_note) - A simple card to leave real time messages in the card, without leaving the page or popups.
- [Sidebar Card](https://github.com/DBuit/sidebar-card) – For an easy-to-navigate sidebar.
- [Wall Panel](https://github.com/j-a-n/lovelace-wallpanel) – A powerful screen saver.
- [Kiosk Mode](https://github.com/maykar/kiosk-mode) – Hides UI elements for a streamlined experience.
- [Card Mod](https://github.com/thomasloven/lovelace-card-mod) – Add custom styling to cards.
- [layout-card](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins) - For my custom layouts

## 🔧 Optional plugins I validated that work
- [Restriction Card](https://github.com/iantrich/restriction-card) – Lock access to things like thermostats. 🔒
- [Unifi Gateway](https://github.com/custom-components/sensor.unifigateway)
- [Unifi Counter Sensors](https://github.com/clyra/unifics)
- [Clock Weather Card](https://github.com/pkissling/clock-weather-card)
- [Kiosk Mode](https://github.com/maykar/kiosk-mode) – Hides UI elements for a streamlined experience.

---

## 🚀 Installation Instructions

### HACS (Recommended)

#### Step-by-Step Guide

1. Ensure [HACS](https://hacs.xyz/) is installed in your Home Assistant.
2. Open the HACS panel, click the three dots in the top-right corner, and select **"Custom Repositories."**
3. Add the following URL as a **Custom Repository**:
[https://github.com/biofects/Enhanced-Biofects](https://github.com/biofects/Enhanced-Biofects)
and select **"Theme"** as the category.
4. Click **"Add,"** then navigate to the **"Theme"** tab, click **"+ Explore & Download Repositories"** and search for "Biofects."
5. Install the theme and restart Home Assistant.
6. Go to **User Profile** in Home Assistant and select the Enhanced Biofects theme.

---

## 🛠 How I Created My Layouts

To get the layout I wanted with the Enhanced Biofects Theme, I combined various plugins and customization:

1. Updated each dashboard to support **Wall Panel**, **Sidebar Card** and **Kiosk Mode**.
2. YAML for content and views should be placed above the dashboard views.
3. Example using UI and Sections:
[ui.yaml](./examples/ui.yaml)
4. Example With a custom header and Greeting Sensor:
[lovelace-dashboard.yaml](./examples/lovelace-dashboard.yaml)
- Please note for the Custom Header with greeting and Quote you will need some additional templates and sensors in your configuration yaml files.
[otherconfigs.yaml](./examples/otherconfigs.yaml)
---

## 🐛 Support & Issues
If you encounter bugs or have feature requests, feel free to [open an issue](https://github.com/biofects/Enhanced-Biofects/issues) on the GitHub repository.

---

## 📜 License
This project is licensed under the MIT License.

Loading

0 comments on commit 7ebf75a

Please sign in to comment.