Git Product home page Git Product logo

nzrunner / home-assistant Goto Github PK

View Code? Open in Web Editor NEW
4.0 2.0 1.0 65.58 MB

🏑 My Home Assistant configuration. Modelled off the configurations of @frenck and @metbril. Their work makes my life easier! πŸ‘

Home Page: https://nzrunner.github.io/home-assistant

License: MIT License

homeassistant homeassistant-config homeassistant-configuration homeassistant-frontend hassio home-assistant home-assistant-config home-automation smart-home automation hacs iot lovelace

home-assistant's Introduction


Logo

Matho's Home Assistant Configuration

HA Version GitHub Sponsor Me Buy Me A Coffee
Contributors Forks Stargazers Bugs Feature Requests Pull Requests MIT License GitHub Sponsors
Project Maintenance GitHub Activity GitHub Last Commit Home Assistant CI


🏑 Home | πŸ› Report Bug | πŸ‘ Request Feature | πŸ—’ ChangeLog


Overview

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.

Blog πŸ†•

I am now blogging about my GitHub and Home Assistant experiences. Why not check out my blog created using GitHub Pages and Jekyll: -

Home Assistant Blog

Built With

Home Assistant Raspberry Pi Debian

(back to top)

Dashboards

Screenshots

Preferred Theme Alternate Theme
Home Assistant Home Assistant
Alerts Alerts
System System
Network Network
Security Security
Entertainment Entertainment
Debugging Debugging
Docker Server Docker Server
Docker Containers Docker Containers

Lovelace UI

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.

(back to top)

Integrations

Integration Repository
Apple iCloud https://www.home-assistant.io/integrations/icloud
Apple TV https://www.home-assistant.io/integrations/apple_tv
Brother Printer https://www.home-assistant.io/integrations/brother
Sony Bravia TV https://www.home-assistant.io/integrations/dlna_dmr
HD HomeRun DMS https://www.home-assistant.io/integrations/dlna_dms
My IP https://www.home-assistant.io/integrations/dnsip
Google Cast https://www.home-assistant.io/integrations/cast
Home Assistant Supervisor https://www.home-assistant.io/integrations/hassio
HomeKit https://www.home-assistant.io/integrations/homekit
Local IP https://www.home-assistant.io/integrations/local_ip
Mobile App https://www.home-assistant.io/integrations/mobile_app
NextCloud https://www.home-assistant.io/integrations/nextcloud/
Philips Hue https://www.home-assistant.io/integrations/hue
Pi-Hole https://www.home-assistant.io/integrations/pi_hole
Plex Media Server https://www.home-assistant.io/integrations/pi_hole
Radarr https://www.home-assistant.io/integrations/radarr
SABnzbd https://www.home-assistant.io/integrations/sabnzbd
Season https://www.home-assistant.io/integrations/season
Sonarr https://www.home-assistant.io/integrations/sonarr
Sonos https://www.home-assistant.io/integrations/sonos
SpeedTest https://www.home-assistant.io/integrations/speedtestdotnet
Sun https://www.home-assistant.io/integrations/sun
Synology DSM https://www.home-assistant.io/integrations/synology_dsm
Tautulli https://www.home-assistant.io/integrations/tautulli
TP-Link Kasa Smart https://www.home-assistant.io/integrations/tplink
Unifi Network https://www.home-assistant.io/integrations/unifi
Uptime https://www.home-assistant.io/integrations/uptime
CONBEE II (Zigbee Home Automation) https://www.home-assistant.io/integrations/zha

(back to top)

Custom Components

Integrations

Custom Component Repository
HACS https://github.com/hacs/integration
Unifi Gateway https://github.com/custom-components/sensor.unifigateway
Auto Backup https://github.com/jcwillox/hass-auto-backup
Local Tuya https://github.com/rospogrigio/localtuya
Font Awesome https://github.com/thomasloven/hass-fontawesome
Browser Mod https://github.com/thomasloven/hass-browser_mod
Monitor Docker https://github.com/ualex73/monitor_docker
Simple Icons https://github.com/vigonotion/hass-simpleicons
Garbage Collection https://github.com/bruxy70/Garbage-Collection
Radarr Upcoming Media https://github.com/custom-components/sensor.radarr_upcoming_media
Sonarr Upcoming Media https://github.com/custom-components/sensor.sonarr_upcoming_media
Lidarr Upcoming Media https://github.com/JackJPowell/sensor.lidarr_upcoming_media
Bereau of Meteorology https://github.com/bremor/bureau_of_meteorology
Plex Recently Added https://github.com/custom-components/sensor.plex_recently_added
Average Sensor https://github.com/Limych/ha-average
Garmin Conenct https://github.com/cyberjunky/home-assistant-garmin_connect
ICS Calendar (iCalendar) https://github.com/franc6/ics_calendar
Uptime Kuma https://github.com/meichthys/uptime_kuma
Medisafe https://github.com/c99koder/ha-medisafe

Frontend

Custom Component Repository Notes
Multiple Entity Row https://github.com/benct/lovelace-multiple-entity-row
Bar Card https://github.com/custom-cards/bar-card
Button Card https://github.com/custom-cards/button-card Major Use
Decluttering Card https://github.com/custom-cards/decluttering-card Not currently used
ZHA Network Card https://github.com/dmulcahey/zha-network-card
Mini Media Player https://github.com/kalkih/mini-media-player
Auto Entities https://github.com/thomasloven/lovelace-auto-entities
Card Mod https://github.com/thomasloven/lovelace-card-mod
Fold Entity Row https://github.com/thomasloven/lovelace-fold-entity-row
Slider Entity Row https://github.com/thomasloven/lovelace-slider-entity-row
IOS Themes - Dark Mode and Light Mode https://github.com/basnijholt/lovelace-ios-themes My primary theme
Custom Brand Icons https://github.com/elax46/custom-brand-icons
Digital Clock https://github.com/wassy92x/lovelace-digital-clock
Custom Animated Weather Card https://github.com/DavidFW1960/bom-weather-card Swapped to Platinum Weather Card
Battery State Card https://github.com/maxwroc/battery-state-card
Mini Graph Card https://github.com/kalkih/mini-graph-card
Upcoming Media Card https://github.com/custom-cards/upcoming-media-card
Layout Card https://github.com/thomasloven/lovelace-layout-card
Hass Hue Icons https://github.com/arallsopp/hass-hue-icons
Metrology - Metro and Fluent Themese https://github.com/Madelena/Metrology-for-Hass My alternate theme
Platinum Weather Card https://github.com/Makin-Things/platinum-weather-card

Automation

Automation Repository
Config Check https://github.com/apop880/config-check

Addons

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

(back to top)

Devices

Network

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/

IOT

Equipment Number Website Notes
Aqara Motion Sensors 8 https://www.aqara.com/en/human_motion_sensor.html
Aqara Door Sensors 8 https://www.aqara.com/en/door_and_window_sensor.html
Aqara Temperature Sensors 4 https://www.aqara.com/en/temperature_humidity_sensor.html
Aqara Mini Switch 1 https://www.aqara.com/en/smart_wireless_mini_switch.html
Aqara Blind Controller 1 https://www.aqara.com/en/product/roller-shade-driver-e1
Philips Hue Bridge 1 https://www.philips-hue.com/en-au/p/hue-bridge/8719514342569
Philips Hue Smart Bulbs 13 https://www.philips-hue.com/en-au/products/smart-light-bulbs
Philips Hue Light Strips 1 https://www.philips-hue.com/en-au/products/smart-light-strips
Philips Hue Motion Sensors 2 https://www.philips-hue.com/en-au/p/hue-motion-sensor/8719514342149
Philips Hue Dimmer Switch 1 https://www.philips-hue.com/en-au/p/hue-dimmer-switch--latest-model-/8719514274631
IKEA Tradfri Motion Sensors 2 https://www.ikea.com/au/en/p/tradfri-wireless-motion-sensor-smart-white-90370469/
IKEA Tradfri Buttons 2 https://www.ikea.com/au/en/p/tradfri-shortcut-button-white-smart-80356384/
IKEA Tradfri Smart Bulbs 2 https://www.ikea.com/au/en/p/tradfri-led-bulb-e14-470-lumen-smart-wireless-dimmable-white-spectrum-globe-20489730/
IKIEA Tradfri Signal repeater 1 https://www.ikea.com/au/en/p/tradfri-signal-repeater-30400412/
Arlec Smart Plugs 8 https://www.bunnings.com.au/arlec-grid-connect-smart-plug-in-socket-with-energy-meter-4-pack_p0273368
TP-Link HS110 Smart Plug 1 https://www.tp-link.com/au/home-networking/smart-plug/hs110/
TP-Link KP303 Smart Powerboard 1 https://www.tp-link.com/au/home-networking/smart-plug/kp303/ Garbage
Security Cameras 2 N/A

(back to top)

Roadmap

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).

(back to top)

Acknowledgments

Themes

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

Inspiration

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

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Our Contributors

nzrunner
Mark Matheson

(back to top)

Sponsorship

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.

GitHub Sponsor Me Buy Me A Coffee

Our Sponsors

nzrunner
Mark Matheson

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Name Handle Link
Mark Matheson @nzrunner https://twitter.com/nzrunner
Project Link https://github.com/nzrunner/home-assistant

(back to top)

home-assistant's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar nzrunner avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

virus514

home-assistant's Issues

Use ?raw=true suffix on images

Describe the bug
Add ?raw=true to the end of image url's so they open full-screen when clicked

To Reproduce
N/A

Expected behavior
Images open full-screen when clicked rather than in the GitHub file browser

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

Lovelace UI file missing from README

Need to include a link to my Lovelace UI file and a brief explanation of how I use and maintain the file. I.e. I use Dashboards and copy/paste the file for the documentation.

[BUG]: custoimize.yaml missing from includes folder

Summary

Customisations not loading. The YAML file is missing from includes folder.

Issue Type

Bug Report

Configuration File Name

customize.yaml

Home Assistant Version

2023.3.6

Configuration code

n/a

OS / Environment

All

Steps to Reproduce

N/a

Expected Results

Customisation showing against the entities

Actual Results

Entertainment entities are missing

Code of Conduct

  • I agree to follow the Code of Conduct

Change TOC and header styling

Describe the bug
The headers are inconsistent. They shouldn't be sub-headers of About.

Rename About as part of the process.

Fix the TOC as well

To Reproduce
N/A

Expected behavior
Headers are all ##

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

[BUG]: Greetings workflow fails

Summary

Invalid workflow file: .github/workflows/greetings.yml#L4
The workflow is not valid. .github/workflows/greetings.yml (Line: 4, Col: 1): Unexpected value 'types'

Issue Type

Bug Report

Configuration File Name

.github/workflows/greetings.yml

Home Assistant Version

N/A

Configuration code

N/A

OS / Environment

N/A

Steps to Reproduce

Run the Greetings workflow

Expected Results

N/A

Actual Results

N/A

Code of Conduct

  • I agree to follow the Code of Conduct

Review all project files

Describe the bug
Review all the project files for key values that should be in the secrets.yaml file

To Reproduce
N/A

Expected behavior
Remove all personally identifiable codes.

Screenshots
N/A

Desktop (please complete the following information):

  • OS: All
  • Browser All
  • Version All

Smartphone (please complete the following information):

  • Device: All
  • OS: All
  • Browser: All
  • Version: All

Additional context
N/A

Quantity of lights wrongly calculated

Describe the bug
The quantity of light entities is wrongly calculated

To Reproduce
Count the lights in the Hue pp and compare to the light entity

Expected behavior
Hue and Home Assistant to match

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Update the Lights - All group with all correct entities.

Write A Git Guide

Is your feature request related to a problem? Please describe.
N/A

Describe the solution you'd like
Include links to documents on Commit Messages and ChangeLogs. Adopt the Conventional Commits standard for messages. Deploy docker container for GitHub ChamgeLog Generator.

Describe alternatives you've considered
Consider other ChangeLog generators

Additional context
Store in Docs folder

[FEATURE REQUEST] Split Acknowledgements

Is your feature request related to a problem? Please describe.
Not a problem

Describe the solution you'd like
Create a Resources document and move the appropriate items from the Acknowledgements section into it.

Describe alternatives you've considered
N/A

Additional context
N/A

[FEATURE REQUEST] Use Git Issues Forms

Is your feature request related to a problem? Please describe.
I'm not a fan of the Git Issue Templates

Describe the solution you'd like
Implement the Beta feature of Git Issue Forms. Model the forms off this repository:-

Link to this page as part of the form narrative:-

Describe alternatives you've considered
Retain Git Issue Templates

Additional context
Useful links:-

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.