🏡 Home | 🐛 Report Bug | 👍 Request Feature | 🗒 ChangeLog
Home Assistant is an awesome open-source home automation product that I have deployed to run my house.
I created this project to: -
- Document my configuration (always a good thing)
- Have a backup of my configuration (another good thing)
- Contribute to the open-source community
- Learn GitHub
As I continue to make improvements to my smart home, I will be updating my configuration. Be sure to ⭐ my page and stay tuned for the latest updates.
Hopefully, as I have learned from others and "borrowed" sectons of their code, others can benefit from my configuration.
Sadly, I didn't keep a good record of the initial Home Assistant configurations that inspired me. If I stumble over them again, I will add them to the Acknowledgements section.
I am now blogging about my GitHub and Home Assistant experiences. Why not check out my blog created using GitHub Pages and Jekyll: -
| Preferred Theme | Alternate Theme |
|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
I have opted to maintain my Dashboards using the Home Assistant UI (.storage mode). As such, I don't have a ui-lovalace.yml file accessible in my config folder.
In the interests of completeness, I have copied the YAML code from the Raw Dashboard editor into a YAML file. It can be found here. Last update: 2023/03/24.
I will endeavour to update this occassionally.
| Automation | Repository |
|---|---|
| Config Check | https://github.com/apop880/config-check |
| Addon | Repository |
|---|---|
| AppDaemon | https://github.com/hassio-addons/addon-appdaemon |
| VS Code | https://github.com/hassio-addons/addon-vscode |
| Terminal and SSH | https://github.com/home-assistant/hassio-addons/tree/master/ssh |
| Equipment | Website |
|---|---|
| Ubiquiti Unifi USG 3 Router | https://ui.com/consoles |
| Ubiquiti Unifi AP Lite | https://ui.com/wi-fi |
| Ubiquiti Unifi Switches | https://ui.com/switching |
| Ubiquiti Unifi Cloud Key GEN 1 | https://ui.com/consoles |
| Brother L8250CDN Printer | No longer available |
| Synology DS1812+ NAS | No longer available |
| Synology DS1618+ NAS | No longer available |
| Sonos One Speakers | https://www.sonos.com/en-au/shop/one-sl |
| Google Home Mini Speakers | https://store.google.com/product/google_nest_mini?hl=en-AU |
| Apple iPhone | https://www.apple.com/au/iphone/ |
| Apple iPad | https://www.apple.com/au/ipad/ |
Roadmap completed
- Review project files for items that should be in the secrets.yaml file
- Disable Bluetooth Tracker
- Update the README
- Complete Integrations list (with links)
- Complete Custom Components section (with links)
- Improve the content in the About The Project section
- Update the Roadmap section
- Add a Devices section (with links)
- IoT devices
- Other devices
- Update Built-With section, describing the hardware and OS configuration
- Logo
- Use a file stored in the project
- Design a project specific image (Canva)
- Add Roadmap items as Feature Requests in the Issues list
- Add a Change Log
- Redo screenshots with preferred theme colour
- Write a Git Guide
- Adopt a git commit message convention
- Publish the lovelace-ui.yaml
- Publish fake secrets.yaml for completeness
See the open issues for a full list of proposed features (and known issues).
| Description | Link |
|---|---|
| My primary theme - iOS Themes | https://github.com/basnijholt/lovelace-ios-themes/ |
| My alternate theme - Metrology (Fluent) | https://github.com/Madelena/Metrology-for-Hass |
| Description | Link |
|---|---|
| My inspiration - @frenck's configuration | https://github.com/frenck/home-assistant-config |
| More inspiration - @Metbril's configuration | https://github.com/metbril/home-assistant-config |
| Well documented - @basnijholt's configuration | https://github.com/basnijholt/home-assistant-config |
| Also well documented - @pqpxo configuration | https://github.com/pqpxo/SWAKES_hassio |
| Amazing documentation - @CCOSTAN configuration | https://github.com/CCOSTAN/Home-AssistantConfig |
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on https://github.com/nzrunner/home-assistant ✨.
Read our Code of Conduct to keep our community approachable and respectable.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Mark Matheson |
If you like what I've done, please consider sponsoring me. Like everyone, I have costs associated with maintaining this repository. Any little bit will help.
|
Mark Matheson |
Distributed under the MIT License. See LICENSE.md for more information.
| Name | Handle | Link |
|---|---|---|
| Mark Matheson | @nzrunner | https://twitter.com/nzrunner |
| Project Link | https://github.com/nzrunner/home-assistant |