https://github.com/Sanderhuisman/home-assistant-custom-components
🏡 Custom components for Home-Assistant
https://github.com/Sanderhuisman/home-assistant-custom-components
home-assistant home-assistant-custom python3
Last synced: about 1 year ago
JSON representation
🏡 Custom components for Home-Assistant
- Host: GitHub
- URL: https://github.com/Sanderhuisman/home-assistant-custom-components
- Owner: Sanderhuisman
- License: apache-2.0
- Created: 2019-01-17T11:45:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T16:37:04.000Z (almost 6 years ago)
- Last Synced: 2024-08-02T16:00:07.872Z (almost 2 years ago)
- Topics: home-assistant, home-assistant-custom, python3
- Language: Python
- Homepage: https://www.home-assistant.io/
- Size: 164 KB
- Stars: 33
- Watchers: 7
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Custom components for Home Assistant
[](https://github.com/Sanderhuisman)
## About
This repository contains custom components I developed for my own [Home-Assistant](https://www.home-assistant.io) 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](#docker_monitor)
* [Eetlijst sensor](#eetlijst)
* [Luftdaten](#luftdaten)
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](https://github.com/nicolargo/glances) and [ha-dockermon](https://github.com/philhawthorne/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](https://github.com/home-assistant/home-assistant/pull/20807), the current version requires HA versions 0.88 and above. For older versions, use version [0.0.1](https://github.com/Sanderhuisman/home-assistant-custom-components/releases/tag/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_event` with name the same set in the configuration.
The event will contain the following data:
* `Container`: Container name
* `Image`: Container image
* `Status`: Container satus
* `Id`: Container ID (long)
#### Configuration
To use the `docker_monitor` in your installation, add the following to your `configuration.yaml` file:
```yaml
# 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_usage
```
##### Configuration 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 |
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:
```yaml
# Example configuration.yaml entry
sensor:
- platform: eetlijst
username: !secret eetlijst_username
password: !secret eetlijst_password
```
##### Configuration variables
| Parameter | Type | Description |
| --------------------- | ----------------------- | ------------- |
| username | string (Required) | Username |
| password | string (Required) | Password |
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:
```yaml
# Example configuration.yaml entry
sensor:
- platform: luftdaten_cu
sensorid: 15307
monitored_conditions:
- P1
- P2
```
##### Configuration 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](https://github.com/ciotlosm/custom-lovelace) cards with the [custom_updater](https://github.com/custom-cards/tracker-card) card.
In your configuration.yaml
```yaml
custom_updater:
component_urls:
- 'https://raw.githubusercontent.com/Sanderhuisman/home-assistant-custom-components/master/custom_updater.json'
```
## Credits
* [frenck](https://github.com/frenck/home-assistant-config)
* [robmarkcole](https://github.com/robmarkcole/Hue-sensors-HASS)