mirror of
https://github.com/alexhopeoconnor/arduino-home-assistant.git
synced 2026-10-04 02:48:13 +10:00
Added support for the configuration_url parameter in the HADevice (#220)
* added support for the configuration_url parameter in the HADevice * update docs
This commit is contained in:
@@ -6,6 +6,7 @@
|
||||
* Added support for setting MQTT's keep alive ([https://github.com/dawidchyrzynski/arduino-home-assistant/issues/153](#153))
|
||||
* Added support for the `state_class` property in the `HASensor` ([#179](https://github.com/dawidchyrzynski/arduino-home-assistant/pull/179) by [@https://github.com/Starzu])
|
||||
* Implemented extended unique ID support for all device types. This allows you to prefix each device type's unique ID with the device ID, ensuring smooth deployment of identical code on multiple devices without encountering unique ID conflicts [#212](https://github.com/dawidchyrzynski/arduino-home-assistant/issues/212#issuecomment-1919832684)
|
||||
* Added support for the `configuration_url` parameter in the `HADevice` [#182](https://github.com/dawidchyrzynski/arduino-home-assistant/issues/182)
|
||||
|
||||
**Fixes:**
|
||||
* Fixed a bug with the maximum number of device types ([#190](https://github.com/dawidchyrzynski/arduino-home-assistant/issues/190) by [@martaisty](https://github.com/martaisty))
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -302,6 +302,17 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N8HADevice19setConfigurationUrlEPKc">
|
||||
<span id="_CPPv3N8HADevice19setConfigurationUrlEPKc"></span><span id="_CPPv2N8HADevice19setConfigurationUrlEPKc"></span><span id="HADevice::setConfigurationUrl__cCP"></span><span class="target" id="class_h_a_device_1a70cd536783b2b994e9d903d6daa30f44"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setConfigurationUrl</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">url</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8HADevice19setConfigurationUrlEPKc" title="Permalink to this definition">¶</a><br /></dt>
|
||||
<dd><p>Sets the “configuration URL” property that’s going to be used by the Home Assistant.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>url</strong> – Configuration URL to publish. </p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N8HADevice15setAvailabilityEb">
|
||||
<span id="_CPPv3N8HADevice15setAvailabilityEb"></span><span id="_CPPv2N8HADevice15setAvailabilityEb"></span><span id="HADevice::setAvailability__b"></span><span class="target" id="class_h_a_device_1a3eac570f51a76789f0564714166c674a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setAvailability</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">online</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N8HADevice15setAvailabilityEb" title="Permalink to this definition">¶</a><br /></dt>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -101,7 +101,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -161,6 +161,7 @@ Enabling optional properties can lead to increased flash and RAM usage, therefor
|
||||
<li><p>software version</p></li>
|
||||
<li><p>manufacturer</p></li>
|
||||
<li><p>model</p></li>
|
||||
<li><p>configuration url</p></li>
|
||||
</ul>
|
||||
<section id="unique-id">
|
||||
<h2>Unique ID<a class="headerlink" href="#unique-id" title="Permalink to this headline">¶</a></h2>
|
||||
@@ -238,6 +239,7 @@ Please note that all of these methods accept a const char pointer whose <strong>
|
||||
<span class="w"> </span><span class="n">device</span><span class="p">.</span><span class="n">setSoftwareVersion</span><span class="p">(</span><span class="s">"1.0.0"</span><span class="p">);</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">device</span><span class="p">.</span><span class="n">setManufacturer</span><span class="p">(</span><span class="s">"Developer Corp."</span><span class="p">);</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">device</span><span class="p">.</span><span class="n">setModel</span><span class="p">(</span><span class="s">"ABC-123"</span><span class="p">);</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">device</span><span class="p">.</span><span class="n">setConfigurationUrl</span><span class="p">(</span><span class="s">"http://192.168.1.55:1234"</span><span class="p">);</span><span class="w"></span>
|
||||
|
||||
<span class="w"> </span><span class="c1">// ...</span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>Device types - ArduinoHA</title>
|
||||
<title>Device types (entities) - ArduinoHA</title>
|
||||
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/theme.css " type="text/css" />
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Device types</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -128,7 +128,7 @@
|
||||
|
||||
<li><a href="index.html">Library</a> »</li>
|
||||
|
||||
<li>Device types</li>
|
||||
<li>Device types (entities)</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -147,8 +147,8 @@
|
||||
<hr>
|
||||
<div class="content" role="main" v-pre>
|
||||
|
||||
<section id="device-types">
|
||||
<h1>Device types<a class="headerlink" href="#device-types" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="device-types-entities">
|
||||
<h1>Device types (entities)<a class="headerlink" href="#device-types-entities" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Device type represents a single entity within the Home Assistant panel, which could be a sensor, lock, camera, or any other item listed in the table below.</p>
|
||||
<p>Your physical device, such as an ESP-01 board, can have multiple device types assigned to it.
|
||||
These types will then appear as child entities in the Home Assistant panel.</p>
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="Device types" href="device-types.html" />
|
||||
<link rel="next" title="Device types (entities)" href="device-types.html" />
|
||||
<link rel="prev" title="Connection parameters" href="connection-params.html" />
|
||||
</head>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -139,7 +139,7 @@
|
||||
</li>
|
||||
<li class="next">
|
||||
<a href="device-types.html"
|
||||
title="next chapter">Device types →</a>
|
||||
title="next chapter">Device types (entities) →</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -199,7 +199,7 @@ The data topic’s prefix can be changed using <code class="docutils literal not
|
||||
</li>
|
||||
<li class="next">
|
||||
<a href="device-types.html"
|
||||
title="next chapter">Device types →</a>
|
||||
title="next chapter">Device types (entities) →</a>
|
||||
</li>
|
||||
</ul><div class="footer" role="contentinfo">
|
||||
© Copyright 2022, Dawid Chyrzynski.
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -172,7 +172,7 @@ Solid understanding of foundations will allow you to utilize full potential of t
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html#topics-prefix">Topics prefix</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="device-types.html">Device types</a><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="device-types.html">Device types (entities)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html#identifiers">Identifiers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html#limitations">Limitations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html#supported-device-types">Supported device types</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
<link rel="next" title="MQTT advanced features" href="mqtt-advanced.html" />
|
||||
<link rel="prev" title="Device types" href="device-types.html" />
|
||||
<link rel="prev" title="Device types (entities)" href="device-types.html" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
@@ -102,7 +102,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -135,7 +135,7 @@
|
||||
<ul class="page-nav">
|
||||
<li class="prev">
|
||||
<a href="device-types.html"
|
||||
title="previous chapter">← Device types</a>
|
||||
title="previous chapter">← Device types (entities)</a>
|
||||
</li>
|
||||
<li class="next">
|
||||
<a href="mqtt-advanced.html"
|
||||
@@ -191,7 +191,7 @@ Please take a look at <a class="reference external" href="https://github.com/daw
|
||||
<div class="inner"><ul class="page-nav">
|
||||
<li class="prev">
|
||||
<a href="device-types.html"
|
||||
title="previous chapter">← Device types</a>
|
||||
title="previous chapter">← Device types (entities)</a>
|
||||
</li>
|
||||
<li class="next">
|
||||
<a href="mqtt-advanced.html"
|
||||
|
||||
+5
-3
@@ -100,7 +100,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -410,6 +410,8 @@
|
||||
<li><a href="documents/api/core/ha-device.html#_CPPv4NK8HADevice19publishAvailabilityEv">HADevice::publishAvailability (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/core/ha-device.html#_CPPv4N8HADevice15setAvailabilityEb">HADevice::setAvailability (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/core/ha-device.html#_CPPv4N8HADevice19setConfigurationUrlEPKc">HADevice::setConfigurationUrl (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/core/ha-device.html#_CPPv4N8HADevice15setManufacturerEPKc">HADevice::setManufacturer (C++ function)</a>
|
||||
</li>
|
||||
@@ -864,11 +866,11 @@
|
||||
<li><a href="documents/api/device-types/ha-hvac.html#_CPPv4N6HAHVAC15TemperatureUnit11CelsiusUnitE">HAHVAC::TemperatureUnit::CelsiusUnit (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/device-types/ha-hvac.html#_CPPv4N6HAHVAC15TemperatureUnit11DefaultUnitE">HAHVAC::TemperatureUnit::DefaultUnit (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/device-types/ha-hvac.html#_CPPv4N6HAHVAC15TemperatureUnit14FahrenheitUnitE">HAHVAC::TemperatureUnit::FahrenheitUnit (C++ enumerator)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="documents/api/device-types/ha-hvac.html#_CPPv4N6HAHVAC15TemperatureUnit14FahrenheitUnitE">HAHVAC::TemperatureUnit::FahrenheitUnit (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/device-types/ha-hvac.html#_CPPv4N6HAHVACD0Ev">HAHVAC::~HAHVAC (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="documents/api/device-types/ha-light.html#_CPPv47HALight">HALight (C++ class)</a>
|
||||
|
||||
+2
-2
@@ -101,7 +101,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/compiler-macros.html">Compiler macros</a></li>
|
||||
@@ -194,7 +194,7 @@ but I successfully use it on ESP8266/ESP8255 boards in my projects.</p>
|
||||
<li class="toctree-l3"><a class="reference internal" href="documents/library/discovery.html#topics-prefix">Topics prefix</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types (entities)</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="documents/library/device-types.html#identifiers">Identifiers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="documents/library/device-types.html#limitations">Limitations</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="documents/library/device-types.html#supported-device-types">Supported device types</a></li>
|
||||
|
||||
Binary file not shown.
+1
-1
@@ -107,7 +107,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/availability-reporting.html">Availability reporting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/connection-params.html">Connection parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/discovery.html">Discovery</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/device-types.html">Device types (entities)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-security.html">MQTT security</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/mqtt-advanced.html">MQTT advanced features</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="documents/library/compiler-macros.html">Compiler macros</a></li>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -15,6 +15,7 @@ The supported properties are:
|
||||
* software version
|
||||
* manufacturer
|
||||
* model
|
||||
* configuration url
|
||||
|
||||
Unique ID
|
||||
---------
|
||||
@@ -102,6 +103,7 @@ Please note that all of these methods accept a const char pointer whose **conten
|
||||
device.setSoftwareVersion("1.0.0");
|
||||
device.setManufacturer("Developer Corp.");
|
||||
device.setModel("ABC-123");
|
||||
device.setConfigurationUrl("http://192.168.1.55:1234");
|
||||
|
||||
// ...
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
Device types
|
||||
============
|
||||
Device types (entities)
|
||||
=======================
|
||||
|
||||
Device type represents a single entity within the Home Assistant panel, which could be a sensor, lock, camera, or any other item listed in the table below.
|
||||
|
||||
|
||||
+9
-1
@@ -6,7 +6,7 @@
|
||||
|
||||
#define HADEVICE_INIT \
|
||||
_ownsUniqueId(false), \
|
||||
_serializer(new HASerializer(nullptr, 5)), \
|
||||
_serializer(new HASerializer(nullptr, 6)), \
|
||||
_availabilityTopic(nullptr), \
|
||||
_sharedAvailability(false), \
|
||||
_available(true), \
|
||||
@@ -82,6 +82,14 @@ void HADevice::setSoftwareVersion(const char* softwareVersion)
|
||||
);
|
||||
}
|
||||
|
||||
void HADevice::setConfigurationUrl(const char* url)
|
||||
{
|
||||
_serializer->set(
|
||||
AHATOFSTR(HADeviceConfigurationUrlProperty),
|
||||
url
|
||||
);
|
||||
}
|
||||
|
||||
void HADevice::setAvailability(bool online)
|
||||
{
|
||||
_available = online;
|
||||
|
||||
@@ -124,6 +124,13 @@ public:
|
||||
*/
|
||||
void setSoftwareVersion(const char* softwareVersion);
|
||||
|
||||
/**
|
||||
* Sets the "configuration URL" property that's going to be used by the Home Assistant.
|
||||
*
|
||||
* @param url Configuration URL to publish.
|
||||
*/
|
||||
void setConfigurationUrl(const char* url);
|
||||
|
||||
/**
|
||||
* Sets device's availability and publishes MQTT message on the availability topic.
|
||||
* If the device is not connected to an MQTT broker or the shared availability is not enabled then nothing happens.
|
||||
|
||||
@@ -36,6 +36,7 @@ const char HADeviceIdentifiersProperty[] PROGMEM = {"ids"};
|
||||
const char HADeviceManufacturerProperty[] PROGMEM = {"mf"};
|
||||
const char HADeviceModelProperty[] PROGMEM = {"mdl"};
|
||||
const char HADeviceSoftwareVersionProperty[] PROGMEM = {"sw"};
|
||||
const char HADeviceConfigurationUrlProperty[] PROGMEM = {"cu"};
|
||||
const char HANameProperty[] PROGMEM = {"name"};
|
||||
const char HAUniqueIdProperty[] PROGMEM = {"uniq_id"};
|
||||
const char HADeviceProperty[] PROGMEM = {"dev"};
|
||||
|
||||
@@ -36,6 +36,7 @@ extern const char HADeviceIdentifiersProperty[];
|
||||
extern const char HADeviceManufacturerProperty[];
|
||||
extern const char HADeviceModelProperty[];
|
||||
extern const char HADeviceSoftwareVersionProperty[];
|
||||
extern const char HADeviceConfigurationUrlProperty[];
|
||||
extern const char HANameProperty[];
|
||||
extern const char HAUniqueIdProperty[];
|
||||
extern const char HADeviceProperty[];
|
||||
|
||||
@@ -301,6 +301,7 @@ AHA_TEST(DeviceTest, full_serialization) {
|
||||
device.setModel("myModel");
|
||||
device.setName("myName");
|
||||
device.setSoftwareVersion("myVersion");
|
||||
device.setConfigurationUrl("http://1.1.1.1:1234");
|
||||
|
||||
const HASerializer* serializer = device.getSerializer();
|
||||
flushSerializer(mock, serializer)
|
||||
@@ -311,7 +312,8 @@ AHA_TEST(DeviceTest, full_serialization) {
|
||||
"\"mf\":\"myManufacturer\","
|
||||
"\"mdl\":\"myModel\","
|
||||
"\"name\":\"myName\","
|
||||
"\"sw\":\"myVersion\""
|
||||
"\"sw\":\"myVersion\","
|
||||
"\"cu\":\"http://1.1.1.1:1234\""
|
||||
"}"
|
||||
)
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user