Merge pull request airalab#734 from tubleronchik/master

add article "Connect SDS011 Sensor to Home Assistant"
0xSamsara · Sep 25, 2023 · c86246c · c86246c
2 parents 3afd04e + 8cd55b6
commit c86246c
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 0 deletions.
diff --git a/data/sidebar_docs.yaml b/data/sidebar_docs.yaml
@@ -118,6 +118,8 @@
       link: /docs/how-to-update-collator-node-version
     - title_en: How to Connect SDS011 Sensor
       link: /docs/sds-sensor-connect
+    - title_en: Connect SDS011 Sensor to Home Assistant
+      link: /docs/sds-sensor-hass
     #- title_en: Configure Metrics With Prometheus And Grafana
     #  link: /docs/robonomics-prometheus-grafana
     - title_en: How to Edit Wiki

diff --git a/docs/docsCovers/sds-sensor-hass-en.png b/docs/docsCovers/sds-sensor-hass-en.png
diff --git a/docs/images/sds-configuration-card.png b/docs/images/sds-configuration-card.png
diff --git a/docs/images/sds-hacs.png b/docs/images/sds-hacs.png
diff --git a/docs/sds-sensor-hass.md b/docs/sds-sensor-hass.md
@@ -0,0 +1,67 @@
+---
+title: Connect SDS011 Sensor to Home Assistant
+
+contributors: [tubleronchik]
+---
+
+This arcticle explains, how to connect SDS Air Quality sensor with [Luftdaten](https://github.com/opendata-stuttgart/sensors-software) & [Robonomics](https://github.com/airalab/sensors-software) Firmware to Home Assistant.
+
+## Installation 
+There are two installation options available:
+
+### Option 1: HACS
+
+The easiest way to add a Local Luftdaten Sensor is through HACS. [Here](https://hacs.xyz/docs/setup/download/) you can find a brief explanation on how to set up HACS.
+
+Once HACS is installed, navigate to HACS -> Integrations and search for the `Local Luftdaten Sensor` integration. Click on the download button and restart Home Assistant once the integration is downloaded.
+<robo-wiki-picture src="sds-hacs.png"/>
+
+### Option 2: Manual Installation
+
+Under the homeassistant user, clone the project repository:
+```
+git clone https://github.com/lichtteil/local_luftdaten.git
+```
+If you already have any custom integrations, copy the `custom_components/local_luftdaten/` to your `custom_components` directory, For example:
+```
+cd local_luftdaten
+mv custom_components/local_luftdaten ~/.homeassistant/custom_components/
+```
+If you don't have any custom integrations, copy the whole `custom_components` directory to your Home Assistant configuration directory. For example:
+
+```
+cd local_luftdaten
+mv custom_components/ ~/.homeassistant/
+```
+
+## Configuration
+
+Create a new sensor entry in your `configuration.yaml` and adjust the host name or the ip address. To find the local ip address of you sensor you can use [Fing mobile app](https://www.fing.com/products) or [nmap CLI tool](https://vitux.com/find-devices-connected-to-your-network-with-nmap/). Name can be any.
+
+|Parameter              |Type    | Necessity    | Description
+|:----------------------|:-------|:------------ |:------------
+|`host`                 | string | required     | IP address of the sensor
+|`scan_interval`        | number | default: 180 | Frequency (in seconds) between updates
+|`name`                 | string | required     | Name of the sensor
+|`monitored_conditions` | list   | required     | List of the monitored sensors
+
+
+```yaml
+sensor:
+  - platform: local_luftdaten
+    host: 192.168.0.100
+    scan_interval: 150
+    name: Air quality sensor
+    monitored_conditions:
+      - SDS_P1
+      - SDS_P2
+      - HTU21D_temperature
+      - HTU21D_humidity
+      - signal
+```
+
+> List of all supported sensors can be found in the [repository](https://github.com/lichtteil/local_luftdaten).
+
+Restart you Home Assistant.
+After that you can add sensor to your dashboard. Name of the entity will be the name you added to `configuration.yaml`.
+<robo-wiki-picture src="sds-configuration-card.png"/>