mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-11 05:56:59 +03:00
Deployed 030dc27 with MkDocs version: 1.4.2
This commit is contained in:
github-actions[bot]
@@ -54,26 +54,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../FAQs/">Frequently Asked Questions</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Configuration</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Advanced</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Build-Instructions/">Build the project yourself</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Upload-files-by-script/">Scripted File Upload</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API's</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../MQTT-API/">MQTT API</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Links</span></p>
|
||||
<p class="caption"><span class="caption-text">External Links</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases</a>
|
||||
</li>
|
||||
@@ -84,34 +65,21 @@
|
||||
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/discussions">Join a Discussions</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Asorted Pages</span></p>
|
||||
<p class="caption"><span class="caption-text">Configuration</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROI (Region of Interest)</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Graphical-Configuration/">Graphical Configuration</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Neural-Network-Types/">Neural Network Types</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ota/">Over-The-Air (OTA) Update</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Advanced</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Addditional-Information/">Addditional Information</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Configuration-Parameter-Details/">Configuration Parameter Details</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Configuration/">Configuration</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Correction%20Algorithm/">Correction Algorithm</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Error-Codes/">Error Codes</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Error-Debugging/">Error Debugging</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Frequent%20Reboots/">Frequent reboots</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Gasmeter-Log-Downloader/">Gasmeter Log Downloader</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Graphical-configuration/">Graphical configuration</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Install-a-rolling-%28unstable%29-release/">:bangbang: Living on the edge :bangbang:</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Integrated%20Functions/">Integrated Functions</a>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Integration into Home Assistant</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="#using-mqtt-automatically-setup-entities-using-homeassistant-mqtt-discovery">Using MQTT (Automatically Setup Entities using Homeassistant MQTT Discovery)</a>
|
||||
@@ -134,23 +102,66 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Learn-models-with-your-own-images/">Learn models with your own images</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../rolling-installation/">Living on the edge</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Neural-Network-Types/">Neural Network Types</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Configuration-Parameter-Details/">Configuration Parameter Details</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../OTA---Update-Firmware-and-Web-Interface/">Over-The-Air (OTA) Update</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Configuration/">Configuration</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROI (Region of Interest) Configuration</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Watermeters</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Release-creation/">Release creation</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Learn-models-with-your-own-images/">Learn a model with your own images</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Correction%20Algorithm/">Correction Algorithm</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Additional-Information/">Additional Information</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Error-Codes/">Error Codes</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Error-Debugging/">Error Debugging</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Frequent-Reboots/">Frequent Reboots</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API's</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../MQTT-API/">MQTT API</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Influx-DB/">Influx DB</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Build-Instructions/">Build the Project</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Upload-files-by-script/">Scripted File Upload</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Testing/">Testing</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Understanding the problem</a>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Release-creation/">Preparing for Release</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Old Pages (no longer maintained)</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Integrated-Functions/">Integrated Functions</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Gasmeter-Log-Downloader/">Gasmeter Log-Downloader</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Asorted Pages</span></p>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
@@ -165,7 +176,7 @@
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>Asorted Pages »</li>
|
||||
<li>Advanced »</li>
|
||||
<li>Integration into Home Assistant</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/docs/Integration-Home-Assistant.md" class="icon icon-github"> Edit on GitHub</a>
|
||||
@@ -177,20 +188,24 @@
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="integration-into-home-assistant">Integration into Home Assistant</h1>
|
||||
<p>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 (Manually Setup Entities)
|
||||
2. Using REST calls</p>
|
||||
<p>There are 3 ways to get the data into your Home Assistant:</p>
|
||||
<ol>
|
||||
<li>Using MQTT (Automatically Setup Entities using Homeassistant MQTT Discovery)</li>
|
||||
<li>Using MQTT (Manually Setup Entities)</li>
|
||||
<li>Using REST calls</li>
|
||||
</ol>
|
||||
<p>The first one is the easier way if you already have MQTT in use.</p>
|
||||
<h2 id="using-mqtt-automatically-setup-entities-using-homeassistant-mqtt-discovery">Using MQTT (Automatically Setup Entities using Homeassistant MQTT Discovery)</h2>
|
||||
<p>‼️ This feature will be available with the next release!</p>
|
||||
<p>Starting with Version <code>>12.0.1</code>, AI-on-the-edge-devices support Homeassistant Discovery.
|
||||
1. Check <a href="https://www.home-assistant.io/docs/mqtt/discovery/">here</a> 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:</p>
|
||||
<pre><code>
|
||||
|
||||
Make sure to select the right Meter Type to get the right units!
|
||||
</code></pre>
|
||||
<p>Starting with Version <code>>12.0.1</code>, AI-on-the-edge-devices support Homeassistant Discovery.</p>
|
||||
<ol>
|
||||
<li>Check <a href="https://www.home-assistant.io/docs/mqtt/discovery/">here</a> to learn more about it and how to enable it in Homeassistant.</li>
|
||||
<li>
|
||||
<p>You also have to enable it in the MQTT settings of your device:</p>
|
||||
<p><img alt="grafik" src="https://user-images.githubusercontent.com/1783586/199350781-e2a59eeb-b5bb-407b-9c0d-2aafab50daab.png" /></p>
|
||||
<p>Make sure to select the right Meter Type to get the right units!</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p>On the next start of the device, it will send discovery topics and Homeassistant should pick them up and show them under <code>Settings > Integrations > MQTT</code>:</p>
|
||||
<p><img alt="grafik" src="https://user-images.githubusercontent.com/1783586/199352538-ddcc3484-39ef-44f4-a853-53286807d30b.png" />
|
||||
<img alt="grafik" src="https://user-images.githubusercontent.com/1783586/199352565-9b0ade28-cb43-47b4-821f-7909cad41a73.png" />
|
||||
@@ -284,8 +299,9 @@ it is a helper and can be used to reset the total increasing values once a day</
|
||||
<h3 id="statistics-graph">Statistics Graph</h3>
|
||||
<p>Creating Statistics Graphs (eg. usage per day) is easy using the <a href="https://www.home-assistant.io/home-energy-management/">Energy Dashboard</a>:
|
||||
<img alt="grafik" src="https://user-images.githubusercontent.com/1783586/193471893-d8ab8f5f-0906-4076-8926-8b5a69a24bce.png" /></p>
|
||||
<p>Note that there seems to be a bug in the graph, see https://github.com/home-assistant/frontend/issues/13995!</p>
|
||||
<p>Note that there seems to be a bug in the graph, see <a href="https://github.com/home-assistant/frontend/issues/13995">https://github.com/home-assistant/frontend/issues/13995</a>!</p>
|
||||
<h3 id="influxdb-graphs">InfluxDb Graphs</h3>
|
||||
<p>See also <a href="../Influx-DB">Influx-DB</a>.</p>
|
||||
<p>If you have setup InfluxDB already, it is also possible to fetch statistics from there, eg. daily usage:</p>
|
||||
<pre><code>from(bucket: "HomeAssistant")
|
||||
|> range(start: v.timeRangeStart, stop: v.timeRangeStop)
|
||||
@@ -352,8 +368,8 @@ template:
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../Integrated%20Functions/" class="btn btn-neutral float-left" title="Integrated Functions"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../Learn-models-with-your-own-images/" class="btn btn-neutral float-right" title="Learn models with your own images">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
<a href="../ota/" class="btn btn-neutral float-left" title="Over-The-Air (OTA) Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../External-LED/" class="btn btn-neutral float-right" title="External LED">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
@@ -380,10 +396,10 @@ template:
|
||||
</span>
|
||||
|
||||
|
||||
<span><a href="../Integrated%20Functions/" style="color: #fcfcfc">« Previous</a></span>
|
||||
<span><a href="../ota/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../Learn-models-with-your-own-images/" style="color: #fcfcfc">Next »</a></span>
|
||||
<span><a href="../External-LED/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user