mirror of
https://github.com/alexhopeoconnor/arduino-home-assistant.git
synced 2026-10-04 02:48:13 +10:00
Dawid ChyrzyńskiandDawid Chyrzynski
0fc32a5bad
* added tests for HADeviceTracker * added support for progmem property value in the HASerializer * codebase update * add support for source type in HADeviceTracker * added support for HACamera * added support for HALock * rename HABinarySensor::getState to getCurrentState * standardize sender name in all callback headers * remove duplicate serializer field protection (reduce flash usage) * optimize HAUtils * minor improvements * optimize writing progmem payload * optimize HAUtils:numberToStr * remove relloc from HASerializer * optimize HASerializerArray * remove includeNullTerminator arg from the topics size generators * optimize HASerializer * replace dtostrf with custom implementation * optimize BaseDeviceType * removed relloc from the HAMqtt * removed support for floats * removed vtable for HADevice, HAMqtt, HASerializer and HASerializerArray * implemented HASwitch with tests * implemented basic HADeviceTrigger * added support for built-in triggers * finished HADeviceTrigger * update changelog * implemented base HASensor * implemented HASensorInteger * finished HASensorFloat * override onMqttConnected in HASensorInteger and HASensorFloat * add more tests for HASensorInteger and HASensorFloat * optimize HASensorFloat * update changelog * standardize constructor of the HABinarySensor * update readme * readme * readme * standardize HADeviceTracker API * standardize HASwitch API * update docs README * move Sphinx files to docsrc directory * type in HASwitch * test docs * add .nojekyll to the docs directory * update makefile of the docs * wip: docs * docs: fix html title * docs: update styling and sidebar * docs: add "Basics" section * docs: device configuration * docs: availability * docs: MQTT discovery * docs: MQTT security * docs: MQTT advanced features * rename BaseDeviceType to HABaseDeviceType * update gitignore * add API reference * update gitignore * HADevice doxygen * doxygen css * HADevice doxygen typos * docs: update links * docs: HAUtils doxygen * HAMqtt and HADevice doxygen * docs: device types * docs: HABaseDeviceType * reduced flash usage by 190 bytes * fix tests * move HAUtils class to the utils directory * make HADevice const in HAMqtt * HABinarySensor docs * doxygen * HADeviceTrigger doxygen * HALock doxygen * HASensor doxygen * HASensor doxygen * HASwitch doxygen * HATagScanner doxygen * HASerializer doxygen * fix SAMD compile error * add HAMqtt::publish method * update examples * add HAButton example * update changelog * added support for the optimistic property in the HACover * do not set optimistic property in the HASwitch if it's set to default value * update examples list * update HASensor example * update MQTT docs * fix device trigger example link * fix search form style on the search result page * added support for the optimistic property in the HALock * update readme * change readme icon * added HALock example * MDNS example * added HASensorFloat and HASensorInteger examples * update readme * update examples * fix crash in the HABaseDeviceType * add support for storing RAM elements in the HASerializerArray * update tests cases in the CoverTest * finished tests for HASelect * added support for HASelect * update README, CHANGELOG and examples list * DeviceTest typos * add more tests to SelectTest * optimize HASelect command's handler * improve CoverTest * optimize HACover command's handler * optimize HALock command's handler * update SerializerTest * remove HAMqtt::writePayload_P method * remove FlagInternalType from the HASerializer * added support for __FlashStringHelper in the topics related functions * migrated serializer to use __FlashStringHelper * add __FlashStringHelper to the HABaseDeviceType::publishOnDataTopic method * move component name to flash memory * update docs * fix debug logs * fix memory leaks * monitor memory leaks in all test cases * optimize tests (RAM) * fix HALock states * fix bug in the HASensor (invalid serialization of the value template property) * fix memory leak in the HASelect * fix crash in HASelect * fix memory leak in the HADeviceTrigger * fix memory leak in the HADevice * tests: add support for ESP8266 and ESP32 envs * update docs * add multi-switch example * update docs structure * update MQTT advanced example in the docs * HADevice: fix _uniqueId memory release * wip: HANumber * add HANumber to defines * refactor HASensor implementation for numbers (again) * update docs * wip: HANumber * wip: add support for number's precision in the HASerializer * add support for float numbers in the HASerializer * optimize vtables in the HASensor * wip: HANumber * fix crash in the float serialization * handle another edge case in the float serialization * replace int32_t with HAUtils::Number type * HANumber fixes * tests for HANumber * change HAUtils::Number type to int64_t * implemented HAUtils::strToNumber * finished HANumber command handler * finished HANumber * update docs * add number example * added support for HAScene * add scene example, update docs * update doxygen * remove memset from the codebase * micro optimizations * fix commands handlers * update HACover code * codebase cleanup * finished HAFan implementation * update docs, added fan example * make json readable in all tests * make position configurable in the HACover * docs * added support for HALight * implement default values as static HAFan members * update docs, added light example * added support for color temperature in the HALight * update light example * update docs * wip: HVAC * improve all tests with callbacks * update logs * add HVAC to the docs * optimize HANumber * add current temperature to the HVAC * started work on HVAC tests * added action feature to the HVAC * add temperature unit to the HVAC * add more tests to UtilsTest * fix fake MQTT messages mock - message shouldn't include null terminator * fix HAUtils::strToNumber * optimize HAFan, HACover and HALight * add min/max temp to the HVAC * added temp step property to the HVAC * rename HASensorNumber::getCurrentValueAsFloat to getCurrentValueFloat * update docs * added support for aux heating in the HVAC * added power command to the HVAC * add subscriptions to the HVAC * added fan mode to the HVAC * update examples * update command handlers in all device types * added swing mode to the HVAC * finished HVAC * update docs * fix memory leak in the HVAC * added support for the target temperature in the HVAC * add HVAC example * update docs * remove unnecessary checks from some device types * added support for RGB in the HALight * update docs * standardize HAHVAC code * rename HAButton::onPress method to onCommand * rename HAScene::onActivate method to onCommand * fix seg fault in the HAUtils * HASensorNumber: do not publish default value on connect * add return uint16_t to the HAUtils::numberToStr method * simplify logic in the HALight::publishRGBColor * optimize numbers serialization in the HASerializer * update README, added LICENSE.md * rename license file * added tag-scanner example * update publishOnDataTopic methods * added esp32-cam example * update docs * add examples to the README.md * update examples * update HAMqtt.h for latest SAMD core, update aunier * update README, fix auniter settings for esp32 * update README * added documentation link to the README * final tweaks in the HACover * fix logic of the speed feature in the HAFan * fix mdns example * fix bug in the DeviceTrigger (invalid serialization of the progmem type/subtype) * implemented HANumeric * update HASensorNumber * update HANumber * update HALight * update HAHVAC * update HAFan * update HACover * update examples * update tests * update docs * fix HANumeric constructor bug * update HANumeric for SAMD * update readme and docs * add payload_on to the scene config (HA throws an exception if this property is missing) * update sensor-analog example * update sensor-integer example * HVAC fixes * update docs Co-authored-by: Dawid Chyrzynski <dawid.chyrzynski@gmail.com>
228 lines
13 KiB
HTML
228 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html >
|
||
<head>
|
||
<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>HAUtils class - ArduinoHA</title>
|
||
|
||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../../_static/theme.css " type="text/css" />
|
||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||
|
||
<!-- sphinx script_files -->
|
||
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
|
||
<script src="../../../_static/jquery.js"></script>
|
||
<script src="../../../_static/underscore.js"></script>
|
||
<script src="../../../_static/doctools.js"></script>
|
||
<script src="../../../_static/custom.js"></script>
|
||
|
||
|
||
<!-- bundled in js (rollup iife) -->
|
||
<!-- <script src="../../../_static/theme-vendors.js"></script> -->
|
||
<script src="../../../_static/theme.js" defer></script>
|
||
|
||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../../search.html" />
|
||
<link rel="prev" title="HASerializerArray class" href="ha-serializer-array.html" />
|
||
</head>
|
||
|
||
<body>
|
||
<div id="app">
|
||
<div class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||
<router-link to="../../../index.html" class="home-link">
|
||
|
||
<span class="site-name">ArduinoHA</span>
|
||
|
||
</router-link>
|
||
|
||
<div class="links">
|
||
<navlinks class="can-hide">
|
||
|
||
|
||
|
||
|
||
<div class="nav-item">
|
||
<a href="https://github.com/dawidchyrzynski/arduino-home-assistant"
|
||
class="nav-link external">
|
||
Github <outboundlink></outboundlink>
|
||
</a>
|
||
</div>
|
||
|
||
|
||
</navlinks>
|
||
</div>
|
||
</navbar>
|
||
|
||
|
||
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||
</div>
|
||
<sidebar @toggle-sidebar="toggleSidebar">
|
||
|
||
<navlinks>
|
||
|
||
|
||
|
||
|
||
|
||
<div class="nav-item">
|
||
<a href="https://github.com/dawidchyrzynski/arduino-home-assistant"
|
||
class="nav-link external">
|
||
Github <outboundlink></outboundlink>
|
||
</a>
|
||
</div>
|
||
|
||
|
||
|
||
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||
<div class="caption"><span class="caption-text">Quick search</span>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../../../search.html" method="get">
|
||
<input type="text" name="q" />
|
||
<input type="submit" value="Search" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||
<p class="caption" role="heading"><span class="caption-text">Docs</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../getting-started/index.html">Getting started</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../getting-started/prerequisites.html">Prerequisites</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../getting-started/installation.html">Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../getting-started/compatible-hardware.html">Compatible Hardware</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../getting-started/examples.html">Examples</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../library/index.html">Library</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../library/introduction.html">Introduction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../library/device-configuration.html">Device configuration</a></li>
|
||
<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/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>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">API reference</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../core/index.html">Core API</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../device-types/index.html">Device types API</a></li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Utils API</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</sidebar>
|
||
|
||
<page>
|
||
<div class="body-header" role="navigation" aria-label="navigation">
|
||
|
||
<ul class="breadcrumbs">
|
||
<li><a href="../../../index.html">Docs</a> »</li>
|
||
|
||
<li><a href="../index.html">API reference</a> »</li>
|
||
|
||
<li><a href="index.html">Utils API</a> »</li>
|
||
|
||
<li>HAUtils class</li>
|
||
</ul>
|
||
|
||
|
||
<ul class="page-nav">
|
||
<li class="prev">
|
||
<a href="ha-serializer-array.html"
|
||
title="previous chapter">← HASerializerArray class</a>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<hr>
|
||
<div class="content" role="main" v-pre>
|
||
|
||
<section id="hautils-class">
|
||
<h1>HAUtils class<a class="headerlink" href="#hautils-class" title="Permalink to this headline">¶</a></h1>
|
||
<dl class="cpp class">
|
||
<dt class="sig sig-object cpp" id="_CPPv47HAUtils">
|
||
<span id="_CPPv37HAUtils"></span><span id="_CPPv27HAUtils"></span><span id="HAUtils"></span><span class="target" id="class_h_a_utils"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HAUtils</span></span></span><a class="headerlink" href="#_CPPv47HAUtils" title="Permalink to this definition">¶</a><br /></dt>
|
||
<dd><p>This class provides some useful methods to make life easier. </p>
|
||
<div class="breathe-sectiondef docutils container">
|
||
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p>
|
||
<dl class="cpp function">
|
||
<dt class="sig sig-object cpp" id="_CPPv4N7HAUtils8endsWithEPKcPKc">
|
||
<span id="_CPPv3N7HAUtils8endsWithEPKcPKc"></span><span id="_CPPv2N7HAUtils8endsWithEPKcPKc"></span><span id="HAUtils::endsWith__cCP.cCP"></span><span class="target" id="class_h_a_utils_1a8bef8d49129e7728c17b9a968580a3e1"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">endsWith</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">str</span></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">suffix</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7HAUtils8endsWithEPKcPKc" title="Permalink to this definition">¶</a><br /></dt>
|
||
<dd><p>Checks whether the given <code class="docutils literal notranslate"><span class="pre">str</span></code> ends with the given <code class="docutils literal notranslate"><span class="pre">suffix</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>str</strong> – Input string to check. </p></li>
|
||
<li><p><strong>suffix</strong> – Suffix to find </p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>True if the given suffix is present at the end of the given string. </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="cpp function">
|
||
<dt class="sig sig-object cpp" id="_CPPv4N7HAUtils14byteArrayToStrEPcPK4byteK8uint16_t">
|
||
<span id="_CPPv3N7HAUtils14byteArrayToStrEPcPK4byteK8uint16_t"></span><span id="_CPPv2N7HAUtils14byteArrayToStrEPcPK4byteK8uint16_t"></span><span id="HAUtils::byteArrayToStr__cP.byteCP.uint16_tC"></span><span class="target" id="class_h_a_utils_1aa27d3fa30125a57b825a85374c9c2fc9"></span><span class="k"><span class="pre">static</span></span><span class="w"> </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">byteArrayToStr</span></span></span><span class="sig-paren">(</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">dst</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">byte</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">src</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7HAUtils14byteArrayToStrEPcPK4byteK8uint16_t" title="Permalink to this definition">¶</a><br /></dt>
|
||
<dd><p>Converts the given byte array into hex string. Each byte will be represented by two bytes, so the output size will be <code class="docutils literal notranslate"><span class="pre">length</span> <span class="pre">*</span> <span class="pre">2</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dst</strong> – Destination where the string will be saved. </p></li>
|
||
<li><p><strong>src</strong> – Bytes array to convert. </p></li>
|
||
<li><p><strong>length</strong> – Length of the bytes array. </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="cpp function">
|
||
<dt class="sig sig-object cpp" id="_CPPv4N7HAUtils14byteArrayToStrEPK4byteK8uint16_t">
|
||
<span id="_CPPv3N7HAUtils14byteArrayToStrEPK4byteK8uint16_t"></span><span id="_CPPv2N7HAUtils14byteArrayToStrEPK4byteK8uint16_t"></span><span id="HAUtils::byteArrayToStr__byteCP.uint16_tC"></span><span class="target" id="class_h_a_utils_1a5a7b29361c98b6bc437172b17a8eac75"></span><span class="k"><span class="pre">static</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="sig-name descname"><span class="n"><span class="pre">byteArrayToStr</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">byte</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">src</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7HAUtils14byteArrayToStrEPK4byteK8uint16_t" title="Permalink to this definition">¶</a><br /></dt>
|
||
<dd><p>Converts the given byte array into hex string. This method allocates a new memory.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>src</strong> – Bytes array to convert. </p></li>
|
||
<li><p><strong>length</strong> – Length of the bytes array. </p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Newly allocated string containing the hex representation. </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
<div class="page-nav">
|
||
<div class="inner"><ul class="page-nav">
|
||
<li class="prev">
|
||
<a href="ha-serializer-array.html"
|
||
title="previous chapter">← HASerializerArray class</a>
|
||
</li>
|
||
</ul><div class="footer" role="contentinfo">
|
||
© Copyright 2022, Dawid Chyrzynski.
|
||
<br>
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.5.0 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</page>
|
||
</div></div>
|
||
|
||
|
||
</body>
|
||
</html> |