mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-07 20:16:57 +03:00
403 lines
17 KiB
HTML
403 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>MQTT API - AI on the Edge Device</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "MQTT API";
|
|
var mkdocs_page_input_path = "MQTT-API.md";
|
|
var mkdocs_page_url = "/AI-on-the-edge-device-docs/MQTT-API/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<img src=https://jomjol.github.io/AI-on-the-edge-device-docs//img/logo.png>
|
|
<a href=".." class="icon icon-home"> AI on the Edge Device
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Welcome</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Installation/">Installation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../initial-setup/">Initial Setup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Hardware-Compatibility/">Hardware Compatibility</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Best-Practice/">Best Practice</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../FAQs/">Frequently Asked Questions</a>
|
|
</li>
|
|
</ul>
|
|
<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>
|
|
<li class="toctree-l1"><a class="" href="https://jomjol.github.io/AI-on-the-edge-device/index.html">Web Installer/Console</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/issues">Create an Issue</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/discussions">Join a Discussion</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Configuration</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Reference-Image/">Reference Image</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Alignment/">Alignment References</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROIs (Regions of Interest)</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../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="../ota/">Over-The-Air (OTA) Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Advanced</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Parameters/">Parameters</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Integration-Home-Assistant/">Integration into Home Assistant</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="../data-logging/">Data Logging</a>
|
|
</li>
|
|
<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="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Water Meters</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../collect-new-images/">Collect images to improve the models</a>
|
|
</li>
|
|
<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="../Neural-Network-Types/">Neural Network Types</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Additional-Information/">Additional Information</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../New-Releases-Notification/">Notification about new Releases</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="../StatusLED-BlinkCodes/">StatusLED BlinkCodes</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>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">API's</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">MQTT API</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#published-topics">Published topics</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#status">Status</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#connection">Connection</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#interval">Interval</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#mac">MAC</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#ip">IP</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#hostname">Hostname</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#uptime">Uptime</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#freemem">FreeMem</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#wifirssi">WifiRSSI</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#cputemp">CPUTemp</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#status_1">Status</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#result">Result</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#value">Value</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#raw">Raw</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#error">Error</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#json">JSON</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#rate">Rate</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#rate_per_time_unit">Rate_per_time_unit</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#rate_per_digitalization_round">Rate_per_digitalization_round</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#changeabsolut">Changeabsolut</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#timestamp">Timestamp</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#json_1">JSON</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#gpio">GPIO</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#gpiogpiopinnumber">GPIO/GPIO{PinNumber}</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#subscibed-topics">Subscibed topics</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#control">Control</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#ctrlflow_start">ctrl/flow_start</a>
|
|
</li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#gpiogpiopinnumber_1">GPIO/GPIO{PinNumber}</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</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="../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="../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>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Assorted Pages</span></p>
|
|
<ul>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">AI on the Edge Device</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<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>API's »</li>
|
|
<li>MQTT API</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/docs/MQTT-API.md" class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<h1 id="mqtt-api">MQTT API</h1>
|
|
<p>The device is capable to register to a MQTT broker to publish data and subscribe to specific topics.</p>
|
|
<p>The MQTT service has to be enabled and configured properly in the device configuration via web interface (<code>Settings</code> -> <code>Configuration</code> -> section <code>MQTT</code>)</p>
|
|
<p>The following parameters have to be defined:
|
|
* URI
|
|
* MainTopic (optional, if not set, the hostname is used)
|
|
* ClientID (optional, if not set, <code>AIOTED-</code> + the MAC address gets used to make sure the ID is unique)
|
|
* User (optional)
|
|
* Password (optional)
|
|
* RetainFlag (optional)</p>
|
|
<h2 id="published-topics">Published topics</h2>
|
|
<h3 id="status">Status</h3>
|
|
<p><code>MainTopic</code>/{status topic}, e.g. <code>watermeter/status</code></p>
|
|
<ul>
|
|
<li>
|
|
<h4 id="connection">Connection</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="interval">Interval</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="mac">MAC</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="ip">IP</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="hostname">Hostname</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="uptime">Uptime</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="freemem">FreeMem</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="wifirssi">WifiRSSI</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="cputemp">CPUTemp</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="status_1">Status</h4>
|
|
</li>
|
|
</ul>
|
|
<h3 id="result">Result</h3>
|
|
<p><code>MainTopic</code>/{NumberName}/{result topic}, e.g. <code>watermeter/main/value</code></p>
|
|
<ul>
|
|
<li>
|
|
<h4 id="value">Value</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="raw">Raw</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="error">Error</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="json">JSON</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="rate">Rate</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="rate_per_time_unit">Rate_per_time_unit</h4>
|
|
<p>The time Unit gets set with the Home Assistant Discovery, e.g. <code>h</code> or <code>m</code> (minutes)</p>
|
|
</li>
|
|
<li>
|
|
<h4 id="rate_per_digitalization_round">Rate_per_digitalization_round</h4>
|
|
<p>The <code>interval</code> defines when the next round gets triggered</p>
|
|
</li>
|
|
<li>
|
|
<h4 id="changeabsolut">Changeabsolut</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="timestamp">Timestamp</h4>
|
|
</li>
|
|
<li>
|
|
<h4 id="json_1">JSON</h4>
|
|
<p>All relevant results in JSON syntax</p>
|
|
</li>
|
|
</ul>
|
|
<h3 id="gpio">GPIO</h3>
|
|
<p><code>MainTopic</code>/{GPIO topic}, e.g. <code>watermeter/GPIO/GPIO12</code></p>
|
|
<ul>
|
|
<li>
|
|
<h4 id="gpiogpiopinnumber">GPIO/GPIO{PinNumber}</h4>
|
|
Depending on device configuration (<code>Settings</code> --> <code>Configuration</code> --> Chapter <code>GPIO</code>)</li>
|
|
</ul>
|
|
<h2 id="subscibed-topics">Subscibed topics</h2>
|
|
<p><code>MainTopic</code>/{subscribed topic}, e.g. <code>watermeter/ctrl/flow_start</code></p>
|
|
<h3 id="control">Control</h3>
|
|
<ul>
|
|
<li>
|
|
<h4 id="ctrlflow_start">ctrl/flow_start</h4>
|
|
<p>Trigger a flow start by publishing to this topic (any character, length > 0)</p>
|
|
</li>
|
|
<li>
|
|
<h4 id="gpiogpiopinnumber_1">GPIO/GPIO{PinNumber}</h4>
|
|
<p>Depending on device configuration (<code>Settings</code> --> <code>Configuration</code> --> Chapter <code>GPIO</code>)</p>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../REST-API/" class="btn btn-neutral float-left" title="REST API"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../Influx-DB/" class="btn btn-neutral float-right" title="Influx DB">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../REST-API/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../Influx-DB/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|