This commit is contained in:
61
README.md
61
README.md
@@ -1,12 +1,8 @@
|
||||
# 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.
|
||||
Welcome to my Home Assistant setup repository.
|
||||
This repository documents and maintains the Home Assistant instance running in my home, hosted on homesrv01/casa server.
|
||||
All essential Docker containers, such as MQTT and speech recognition, are hosted on the same server for seamless integration.
|
||||
|
||||
<!-- omit in toc -->
|
||||
## Table of Contents
|
||||
@@ -16,7 +12,7 @@ All necessary docker containers (example: mqtt, speech recognition) hosted on s
|
||||
- [ZigBee - Smart Plugs](#zigbee---smart-plugs)
|
||||
- [Shelly - Smart Plugs](#shelly---smart-plugs)
|
||||
- [Integrations](#integrations)
|
||||
- [mqtt](#mqtt)
|
||||
- [MQTT](#mqtt)
|
||||
- [zigbee2mqtt](#zigbee2mqtt)
|
||||
- [Broadlink](#broadlink)
|
||||
- [Wyoming Protocol](#wyoming-protocol)
|
||||
@@ -33,10 +29,12 @@ All necessary docker containers (example: mqtt, speech recognition) hosted on s
|
||||
- [Sun](#sun)
|
||||
- [Time \& Date](#time--date)
|
||||
- [Xbox](#xbox)
|
||||
- [Deploy and Maintenance](#deploy-and-maintenance)
|
||||
- [Setup](#setup)
|
||||
- [Docker](#docker)
|
||||
- [Deploy and update](#deploy-and-update)
|
||||
- [Volumes](#volumes)
|
||||
- [has\_config](#has_config)
|
||||
- [`has_config`](#has_config)
|
||||
- [Development Environment](#development-environment)
|
||||
|
||||
## Devices
|
||||
|
||||
@@ -81,15 +79,19 @@ Devices connected to IOT lan.
|
||||
|
||||
## Integrations
|
||||
|
||||
### mqtt
|
||||
### 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 (Message Queuing Telemetry Transport) is a lightweight, publish/subscribe messaging protocol designed for machine-to-machine (M2M) communication and the Internet of Things (IoT). It operates on top of TCP/IP, making it ideal for resource-constrained devices.
|
||||
|
||||
[mqtt integration](https://www.home-assistant.io/integrations/mqtt)
|
||||
**Setup:**
|
||||
The Mosquitto MQTT broker is configured as the central messaging hub. For setup details, refer to the [Mosquitto setup repository](https://git.limbosolutions.com/marcio.fernandes/mosquitto).
|
||||
|
||||
[mosquitto setup git repo](https://git.limbosolutions.com/marcio.fernandes/mosquitto)
|
||||
**Requirements:**
|
||||
Ensure port `1883` is accessible from Home Assistant to the Mosquitto server (`mqtt.lan`).
|
||||
|
||||
Requires port 1883 access from home assistant to mosquitto server (mqtt.lan).
|
||||
**Links:**
|
||||
|
||||
- [Home Assistant MQTT Integration Documentation](https://www.home-assistant.io/integrations/mqtt)
|
||||
|
||||
### zigbee2mqtt
|
||||
|
||||
@@ -103,7 +105,7 @@ The [broadlink integration](https://www.home-assistant.io/integrations/broadlink
|
||||
|
||||
.
|
||||
|
||||
Devices:
|
||||
Devices:
|
||||
|
||||
- RM4 mini (IR Blaster)
|
||||
|
||||
@@ -113,7 +115,7 @@ Requires port 80 access from home assistant to Broadlink devices.
|
||||
|
||||
A peer-to-peer protocol for voice assistants (basically JSONL + PCM audio)
|
||||
|
||||
``` json
|
||||
```json
|
||||
{ "type": "...", "data": { ... }, "data_length": ..., "payload_length": ... }
|
||||
<data_length bytes (optional)>
|
||||
<payload_length bytes (optional)>
|
||||
@@ -161,7 +163,7 @@ The Mobile App integration allows Home Assistant mobile apps to easily integrate
|
||||
**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.
|
||||
@@ -248,18 +250,25 @@ Home Assistant authenticates with Xbox Live through OAuth2 using the Home Assist
|
||||
|
||||
- [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.
|
||||
## Setup
|
||||
|
||||
### Docker
|
||||
|
||||
[Docker compose](./docker-compose.yaml).
|
||||
The deployment and maintenance of this Home Assistant setup are managed using Docker. A [Docker Compose file](./docker-compose.yaml) is used to define and run the multi-container environment.
|
||||
|
||||
#### Deploy and update
|
||||
|
||||
A [Git Action workflow](./.gitea/workflows/deploy.yml) is configured to:
|
||||
|
||||
- Automatically pull the latest Docker images daily.
|
||||
- Execute `docker-compose up` to ensure the environment remains up-to-date and operational.
|
||||
|
||||
#### Volumes
|
||||
|
||||
##### has_config
|
||||
##### `has_config`
|
||||
|
||||
Check home assistant [config files repo](/marcio.fernandes/homeassistant.config).
|
||||
The `has_config` volume stores the Home Assistant configuration files. For more details, refer to the [Home Assistant configuration repository](/marcio.fernandes/homeassistant.config).
|
||||
|
||||
### Development Environment
|
||||
|
||||
Development and maintenance tasks are performed using Visual Studio Code on the Lazarus development device. The Docker context is set to the host [homesrv01.dev.lan](/marcio.fernandes/homesrv01.dev.lan) for seamless integration and management.
|
||||
|
||||
Reference in New Issue
Block a user