Márcio Fernandes
18f27615a3
All checks were successful
/ deploy-to-homesrv01 (push) Successful in 4m51s
266 lines
8.0 KiB
Markdown
266 lines
8.0 KiB
Markdown
# Home Assistant
|
|
|
|
Welcome to my home assistant setup repo.
|
|
|
|
This repository serves to document and maintain home assistant running in my house.
|
|
|
|
Currently hosted on [homesrv01.dev.lan](marcio.fernandes/homesrv01.dev.lan).
|
|
|
|
All necessary docker containers (example: mqtt, speech recognition) hosted on same server.
|
|
|
|
<!-- omit in toc -->
|
|
## 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)
|
|
- [Broadlink](#broadlink)
|
|
- [Wyoming Protocol](#wyoming-protocol)
|
|
- [HACS](#hacs)
|
|
- [Google Cast](#google-cast)
|
|
- [LG webOS Smart TV](#lg-webos-smart-tv)
|
|
- [Mobile App](#mobile-app)
|
|
- [Meteorologisk institutt (Met.no)](#meteorologisk-institutt-metno)
|
|
- [Pi-hole](#pi-hole)
|
|
- [Proxmox VE](#proxmox-ve)
|
|
- [Shelly](#shelly)
|
|
- [Speedtest.net](#speedtestnet)
|
|
- [Squeezebox (Lyrion Music Server)](#squeezebox-lyrion-music-server)
|
|
- [Sun](#sun)
|
|
- [Time \& Date](#time--date)
|
|
- [Xbox](#xbox)
|
|
- [Deploy and Maintenance](#deploy-and-maintenance)
|
|
- [Docker](#docker)
|
|
- [Volumes](#volumes)
|
|
- [has\_config](#has_config)
|
|
|
|
## Devices
|
|
|
|
### Broadlink - RM4 Pro
|
|
|
|
Using as Ir blaster for living room devices and temperature meter.
|
|
|
|
|
|
|
|
**Integrations:**
|
|
|
|
- [broadlink](#broadlink)
|
|
|
|
### ZigBee - Smart Plugs
|
|
|
|
Currently controlling:
|
|
|
|
- bed room lights
|
|
- dining table lights
|
|
|
|
|
|
|
|
**Integrations:**
|
|
|
|
- [zigbee2mqtt](#zigbee2mqtt)
|
|
- [mqtt](#mqtt)
|
|
|
|
### Shelly - Smart Plugs
|
|
|
|
Currently controlling and monitoring:
|
|
|
|
- brutus.dev.lan (proxmox server)
|
|
- office light
|
|
|
|
|
|
|
|
Devices connected to IOT lan.
|
|
|
|
**Integrations:**
|
|
|
|
- [shelly](#shelly)
|
|
|
|
## Integrations
|
|
|
|
### mqtt
|
|
|
|
MQTT (aka MQ Telemetry Transport) is a machine-to-machine or “Internet of Things” connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport.
|
|
|
|
[mqtt integration](https://www.home-assistant.io/integrations/mqtt)
|
|
|
|
[mosquitto setup git repo](https://git.limbosolutions.com/marcio.fernandes/mosquitto)
|
|
|
|
Requires port 1883 access from home assistant to mosquitto server (mqtt.lan).
|
|
|
|
### zigbee2mqtt
|
|
|
|
Configured as a docker container on [homesrv01](/marcio.fernandes/homesrv01.dev.lan#zigbee2mqtt).
|
|
|
|
Using SONOFF Universal Zigbee 3.0 USB Dongle Plus.
|
|
|
|
### Broadlink
|
|
|
|
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.
|
|
|
|
.
|
|
|
|
Devices:
|
|
|
|
- RM4 mini (IR Blaster)
|
|
|
|
Requires port 80 access from home assistant to Broadlink devices.
|
|
|
|
### Wyoming Protocol
|
|
|
|
A peer-to-peer protocol for voice assistants (basically JSONL + PCM audio)
|
|
|
|
``` json
|
|
{ "type": "...", "data": { ... }, "data_length": ..., "payload_length": ... }
|
|
<data_length bytes (optional)>
|
|
<payload_length bytes (optional)>
|
|
```
|
|
|
|
Used in Rhasspy and Home Assistant for communication with voice services.
|
|
|
|
This is an open standard of the Open Home Foundation.
|
|
|
|
Docker containers currently hosted at [homesrv01.dev.lan](https://git.limbosolutions.com/marcio.fernandes/homesrv01.dev.lan#wyoming).
|
|
|
|
**Links:**
|
|
|
|
- <https://github.com/home-assistant/addons/blob/master/whisper/DOCS.md>
|
|
- <https://github.com/rhasspy/wyoming-faster-whisper>
|
|
|
|
### HACS
|
|
|
|
**Links:**
|
|
|
|
- [Official git repo](https://github.com/hacs/integration)
|
|
|
|
### Google Cast
|
|
|
|
**Links:**
|
|
|
|
- [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.
|
|
|
|
There is currently support for the following device types within Home Assistant:
|
|
|
|
- Media player
|
|
- Notifications
|
|
|
|
To begin with enable LG Connect Apps feature in Network settings of the TV.
|
|
|
|
### Mobile App
|
|
|
|
The Mobile App integration allows Home Assistant mobile apps to easily integrate with Home Assistant.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/mobile_app)
|
|
|
|
### Meteorologisk institutt (Met.no)
|
|
|
|
The met platform uses the Met.no web service as a source for meteorological data for your location. The weather forecast is delivered by the Norwegian Meteorological Institute and the NRK.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/met)
|
|
|
|
### Pi-hole
|
|
|
|
The Pi-hole integration allows you to retrieve statistics and interact with a Pi-hole system.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/pi_hole)
|
|
|
|
### Proxmox VE
|
|
|
|
Proxmox VE Custom Integration Home Assistant
|
|
|
|
**Links:**
|
|
|
|
- [Official integration repo](https://github.com/dougiteixeira/proxmoxve)
|
|
|
|
### Shelly
|
|
|
|
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)
|
|
|
|
### Speedtest.net
|
|
|
|
The Speedtest.net integration uses the Speedtest.net web service to measure network bandwidth performance.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/speedtestdotnet)
|
|
|
|
### Squeezebox (Lyrion Music Server)
|
|
|
|
The Squeezebox integration allows you to control music players from the Lyrion Music Server (LMS) ecosystem. Lyrion Music Server was previously known as Logitech Media Server.
|
|
|
|
The Squeezebox music player ecosystem, which can be controlled through this integration, includes hardware audio players from Logitech, including Squeezebox 3rd Generation, Squeezebox Boom, Squeezebox Receiver, Transporter, Squeezebox2, Squeezebox and SLIMP3, and many software emulators like Squeezelite, SqueezeSlave, SoftSqueeze and SqueezePlay.
|
|
|
|
[Check git repo](/marcio.fernandes/lms) for more information how to setup Lyrion Music Server docker container.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/squeezebox)
|
|
|
|
### Sun
|
|
|
|
The sun integration will use the location as configured in your Home Assistant configuration to track if the sun is above or below the horizon. The sun can be used within automation's as a trigger with an optional offset to simulate dawn/dusk or as a condition with an optional offset to test if the sun has already set or risen.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/sun)
|
|
|
|
### Time & Date
|
|
|
|
The time and date (time_date) integration allows one to create sensors for the current date or time in different formats. All values are based on the timezone which is set in “General Configuration”.
|
|
|
|
**Links:**
|
|
|
|
- [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.
|
|
|
|
Home Assistant authenticates with Xbox Live through OAuth2 using the Home Assistant Cloud account linking service.
|
|
|
|
**Links:**
|
|
|
|
- [Home Assistant - Official integration documentation](https://www.home-assistant.io/integrations/xbox)
|
|
|
|
## Deploy and Maintenance
|
|
|
|
Using vscode on lazarus dev device with docker context set to host [homesrv01.dev.lan](/marcio.fernandes/homesrv01.dev.lan).
|
|
|
|
[git action](./.gitea/workflows/deploy.yml) with daily latest image pull and docker compose up.
|
|
|
|
### Docker
|
|
|
|
[Docker compose](./docker-compose.yaml).
|
|
|
|
#### Volumes
|
|
|
|
##### has_config
|
|
|
|
Check home assistant [config files repo](/marcio.fernandes/homeassistant.config).
|