Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2026-01-27 12:50:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos and small inconsistencies (#12)

Browse Source 
Co-authored-by: CaCO3 <caco3@ruinelli.ch>
This commit is contained in:
tljuniper
2023-02-03 20:35:37 +01:00
committed by GitHub
parent 7c599658cd
commit 7c3821357f
29 changed files with 140 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/Integration-Home-Assistant.md
View File

@@ -1,17 +1,17 @@
# Integration into Home Assistant
There are 3 ways to get the data into your Home Assistant:
1. Using MQTT (Automatically Setup Entities using Homeassistant MQTT Discovery)
1. Using MQTT (Automatically Setup Entities using Home Assistant MQTT Discovery)
1. Using MQTT (Manually Setup Entities)
2. Using REST calls
The first one is the easier way if you already have MQTT in use.
## Using MQTT (Automatically Setup Entities using Homeassistant MQTT Discovery)
## Using MQTT (Automatically Setup Entities using Home Assistant MQTT Discovery)
:bangbang: This feature will be available with the next release!
Starting with Version `>12.0.1`, AI-on-the-edge-devices support Homeassistant Discovery.
Starting with Version `>12.0.1`, AI-on-the-edge-devices support Home Assistant Discovery.
1. Check [here](https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery) to learn more about it and how to enable it in Homeassistant.
1. You also have to enable it in the MQTT settings of your device:
@@ -20,7 +20,7 @@ Starting with Version `>12.0.1`, AI-on-the-edge-devices support Homeassistant Di
Make sure to select the right Meter Type to get the right units!
On the next start of the device, it will send discovery topics and Homeassistant should pick them up and show them under `Settings > Integrations > MQTT`:
On the next start of the device, it will send discovery topics and Home Assistant should pick them up and show them under `Settings > Integrations > MQTT`:
![grafik](https://user-images.githubusercontent.com/1783586/199352538-ddcc3484-39ef-44f4-a853-53286807d30b.png)
![grafik](https://user-images.githubusercontent.com/1783586/199352565-9b0ade28-cb43-47b4-821f-7909cad41a73.png)
@@ -39,7 +39,7 @@ mqtt:
unique_id: watermeter_value
unit_of_measurement: 'm³'
state_class: total_increasing
device_class: water # Needs Homeassistant 2022.11!
device_class: water # Needs Home Assistant 2022.11!
icon: 'mdi:water-pump'
availability_topic: wasserzaehler/connection
payload_available: connected
@@ -50,7 +50,7 @@ mqtt:
unique_id: watermeter_rate
unit_of_measurement: 'm³/min'
state_class: measurement
device_class: water # Needs Homeassistant 2022.11!
device_class: water # Needs Home Assistant 2022.11!
icon: 'mdi:water-pump'
availability_topic: wasserzaehler/connection
payload_available: connected
@@ -126,7 +126,7 @@ Note that you also can add it using the UI.
![grafik](https://user-images.githubusercontent.com/1783586/193472091-1484aac4-ddc2-48ba-896c-28370963fc2d.png)
### Statistics Graph
Creating Statistics Graphs (eg. usage per day) is easy using the [Energy Dashboard](https://www.home-assistant.io/home-energy-management/):
Creating Statistics Graphs (e.g. usage per day) is easy using the [Energy Dashboard](https://www.home-assistant.io/home-energy-management/):
![grafik](https://user-images.githubusercontent.com/1783586/193471893-d8ab8f5f-0906-4076-8926-8b5a69a24bce.png)
Note that there seems to be a bug in the graph, see [https://github.com/home-assistant/frontend/issues/13995](https://github.com/home-assistant/frontend/issues/13995)!
@@ -136,7 +136,7 @@ Note that there seems to be a bug in the graph, see [https://github.com/home-ass
See also [Influx-DB](../Influx-DB).
If you have setup InfluxDB already, it is also possible to fetch statistics from there, eg. daily usage:
If you have setup InfluxDB already, it is also possible to fetch statistics from there, e.g. daily usage:
```
from(bucket: "HomeAssistant")
|> range(start: v.timeRangeStart, stop: v.timeRangeStop)
@@ -155,7 +155,7 @@ When using REST, Home Assistant has to periodically call an URL on the ESP32 whi
See [REST API](../REST-API) for a list of available URLs.
The most practical one is the `json` entrypoint which provides the most relevant data JSON formated:
The most practical one is the `json` entrypoint which provides the most relevant data JSON formatted:
`http://<IP>/json`
This would return:
```JSON