diff --git a/README.md b/README.md index 0ceb986..ea1ddd9 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,17 @@ Welcome to my home assistant setup repo. -This repository serves to document and maintain the home assistant that runs in my house. +This repository serves to document and maintain home assistant running in my house. -Currently this runs in a docker container hosted at [homesrv01](#hosting). All necessary docker containers (example: mqtt, speech recognition) are hosted on the same [server](#hosting). +Currently runs on docker hosted at [homesrv01](#hosting). All necessary docker containers (example: mqtt, speech recognition) are hosted on the same [server](#hosting). ## Table of Contents +- [Devices](#devices) + - [Broadlink - RM4 Pro](#broadlink---rm4-pro) + - [ZigBee - Smart Plugs](#zigbee---smart-plugs) + - [Shelly - Smart Plugs](#shelly---smart-plugs) - [Integrations](#integrations) - [mqtt](#mqtt) - [zigbee2mqtt](#zigbee2mqtt) @@ -30,6 +34,47 @@ Currently this runs in a docker container hosted at [homesrv01](#hosting). All n - [Hosting](#hosting) - [Editing and Maintenance](#editing-and-maintenance) +## Devices + +### Broadlink - RM4 Pro + +Using as Ir blaster for living room devices and temperature meter. + +![ZigBee Smart Plugs](doc/images/broadlink-universal-remote-irwifi-rm4-mini.jpg) + +**Integrations:** + +- [broadlink](#broadlink) + +### ZigBee - Smart Plugs + +Currently controlling: + +- bed room lights +- dining table lights + +![ZigBee Smart Plugs](doc/images/51ojy7qoMmL._SL1500_.jpg) + +**Integrations:** + +- [zigbee2mqtt](#zigbee2mqtt) +- [mqtt](#mqtt) + +### Shelly - Smart Plugs + +Currently controlling and monitoring: + +- brutus.dev.lan (proxmox server) +- office light + +![Shelly - Smart Plug](doc/images/shellysmartplug.png) + +Devices connected to IOT lan. + +**Integrations:** + +- [shelly](#shelly) + ## Integrations ### mqtt @@ -52,7 +97,7 @@ Using SONOFF Universal Zigbee 3.0 USB Dongle Plus. The [broadlink integration](https://www.home-assistant.io/integrations/broadlink) allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. -![broadlink integration](./documentation/images/integrations-broadlink.png) +![broadlink integration](./doc/images/integrations-broadlink.png) Devices: @@ -94,7 +139,6 @@ Docker containers currently hosted at [homesrv01.dev.lan](https://git.limbosolut - [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/cast) - [Official git repo](https://github.com/home-assistant/core/tree/dev/homeassistant/components/cast) - ### LG webOS Smart TV The webostv platform allows you to control a LG webOS Smart TV. @@ -142,6 +186,14 @@ Proxmox VE Custom Integration Home Assistant Integrate Shelly devices into Home Assistant. +[Devices](#shelly---smart-plugs) connected to IOT lan. + +**Firewall rules:** + +- allow TCP:80(HTTP) from server homesrv to vlan IOT +- allow TCP:5683(CoIoT) from vlan IOT to server homesrv +- allow TCP:80(HTTP) from vlan IOT to server homesrv + **Links:** - [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/shelly) @@ -182,7 +234,6 @@ The time and date (time_date) integration allows one to create sensors for the c - [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/time_date) - ### Xbox The Xbox integration allows you to control Xbox One (or newer) consoles from Home Assistant. @@ -199,7 +250,7 @@ Currently hosted on [homesrv01.dev.lan](marcio.fernandes/homesrv01.dev.lan). Using [portainer stack (name: has)](./docker-compose.yaml) connected to this repo. -![alt text](documentation/images/portainer-has.png) +![portainer - home assistant](documentation/images/portainer-has.png) Docker volumes should be restored from backups. Repo version of docker volumes exists only for history and documentation. diff --git a/doc/images/51ojy7qoMmL._SL1500_.jpg b/doc/images/51ojy7qoMmL._SL1500_.jpg new file mode 100644 index 0000000..53fd87e Binary files /dev/null and b/doc/images/51ojy7qoMmL._SL1500_.jpg differ diff --git a/doc/images/broadlink-universal-remote-irwifi-rm4-mini.jpg b/doc/images/broadlink-universal-remote-irwifi-rm4-mini.jpg new file mode 100644 index 0000000..65c8b8d Binary files /dev/null and b/doc/images/broadlink-universal-remote-irwifi-rm4-mini.jpg differ diff --git a/documentation/images/integrations-broadlink.png b/doc/images/integrations-broadlink.png similarity index 100% rename from documentation/images/integrations-broadlink.png rename to doc/images/integrations-broadlink.png diff --git a/documentation/images/portainer-has.png b/doc/images/portainer-has.png similarity index 100% rename from documentation/images/portainer-has.png rename to doc/images/portainer-has.png diff --git a/doc/images/shellysmartplug.png b/doc/images/shellysmartplug.png new file mode 100644 index 0000000..ba8ca45 Binary files /dev/null and b/doc/images/shellysmartplug.png differ