Custom components for Home Assistant
About
This repository contains custom components I developed for my own Home-Assistant setup. Feel free to use the components and report bugs if you find them. If you want to contribute, please report a bug or pull request and I will reply as soon as possible. Please star & watch my project such I can see how many people like my components and for you to stay in the loop as updates come along.
Components
Docker Monitor
The Docker monitor allows you to monitor statistics and turn on/off containers. The monitor can connected to a daemon through the url parameter. When home assistant is used within a Docker container, the daemon can be mounted as follows -v /var/run/docker.sock:/var/run/docker.sock. The monitor is based on Glances and ha-dockermon and combines (in my opinion the best of both integrated in HA :)).
Important note: as the loading path of platforms have been changed in issue #20807, the current version requires HA versions 0.88 and above. For older versions, use version 0.0.1.
Events
The monitor can listen for events on the Docker event bus and can fire an event on the Home Assistant Bus. The monitor will use the following event:
{name}_container_eventwith name the same set in the configuration.
The event will contain the following data:
Container: Container nameImage: Container imageStatus: Container satusId: Container ID (long)
Configuration
To use the docker_monitor in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
docker_monitor:
containers:
- homeassistant_homeassistant_1
- homeassistant_mariadb_1
- homeassistant_mosquitto_1
monitored_conditions:
- utilization_version
- container_status
- container_memory_usage
- container_memory_percentage_usage
- container_cpu_percentage_usageConfiguration variables
| Parameter | Type | Description |
|---|---|---|
| name | string (Optional) | Client name of Docker daemon. Defaults to Docker. |
| url | string (Optional) | Host URL of Docker daemon. Defaults to unix://var/run/docker.sock. |
| scan_interval | time_period (Optional) | Update interval. Defaults to 10 seconds. |
| events | boolean (Optional) | Listen for events from Docker. Defaults to false. |
| containers | list (Optional) | Array of containers to monitor. Defaults to all containers. |
| monitored_conditions | list (Optional) | Array of conditions to be monitored. Defaults to all conditions |
| Condition | Description | Unit |
|---|---|---|
| utilization_version | Docker version | - |
| container_status | Container status | - |
| container_uptime | Container start time | - |
| container_image | Container image | - |
| container_cpu_percentage_usage | CPU usage | % |
| container_memory_usage | Memory usage | MB |
| container_memory_percentage_usage | Memory usage | % |
| container_network_speed_up | Network total speed upstream | kB/s |
| container_network_speed_down | Network total speed downstream | kB/s |
| container_network_total_up | Network total upstream | MB |
| container_network_total_down | Network total downstream | MB |
Eetlijst Sensor
An Eetlijst sensor to monitor the eat/cook status of your student home.
Configuration
To use eetlijst in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
- platform: eetlijst
username: !secret eetlijst_username
password: !secret eetlijst_passwordConfiguration variables
| Parameter | Type | Description |
|---|---|---|
| username | string (Required) | Username |
| password | string (Required) | Password |
Lufdaten Sensor
A custom Luftdaten sensor to monitor polution of a station.
Configuration
To use luftdaten_cu in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
- platform: luftdaten_cu
sensorid: 15307
monitored_conditions:
- P1
- P2Configuration variables
| Parameter | Type | Description |
|---|---|---|
| sensorid | int (Required) | Sensor id of the lufdaten sensor to be monitored. |
| monitored_conditions | list (Optional) | Array of conditions to be monitored. Defaults to all conditions |
| Condition | Description | Unit |
|---|---|---|
| temperature | Temperature | °C |
| humidity | Container status | % |
| pressure | Air pressure | Pa |
| P1 | PM10 | µg/m3 |
| P2 | PM2.5 | µg/m3 |
Track Updates
This custom component can be tracked with the help of custom-lovelace cards with the custom_updater card.
In your configuration.yaml
custom_updater:
component_urls:
- 'https://raw.githubusercontent.com/Sanderhuisman/home-assistant-custom-components/master/custom_updater.json'