mirror of
https://github.com/alexhopeoconnor/arduino-home-assistant.git
synced 2026-10-04 02:48:13 +10:00
Dawid Chyrzyński
fdc60b57c3
* added support for the configuration_url parameter in the HADevice * update docs
220 lines
12 KiB
HTML
220 lines
12 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>Connection parameters - 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="next" title="Discovery" href="discovery.html" />
|
|
<link rel="prev" title="Availability reporting" href="availability-reporting.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 current"><a class="reference internal" href="index.html">Library</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="device-configuration.html">Device configuration</a></li>
|
|
<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 (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>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API reference</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../api/core/index.html">Core API</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../api/device-types/index.html">Device types API</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../api/utils/index.html">Utils API</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="https://github.com/sponsors/dawidchyrzynski">Sponsor</a></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">Library</a> »</li>
|
|
|
|
<li>Connection parameters</li>
|
|
</ul>
|
|
|
|
|
|
<ul class="page-nav">
|
|
<li class="prev">
|
|
<a href="availability-reporting.html"
|
|
title="previous chapter">← Availability reporting</a>
|
|
</li>
|
|
<li class="next">
|
|
<a href="discovery.html"
|
|
title="next chapter">Discovery →</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<hr>
|
|
<div class="content" role="main" v-pre>
|
|
|
|
<section id="connection-parameters">
|
|
<h1>Connection parameters<a class="headerlink" href="#connection-parameters" title="Permalink to this headline">¶</a></h1>
|
|
<p><a class="reference internal" href="../api/core/ha-mqtt.html"><span class="doc">HAMqtt</span></a> class exposes a few variants of the <code class="docutils literal notranslate"><span class="pre">begin</span></code> method that allows specifying the MQTT connection parameters.
|
|
<strong>This method should be called only once and at the end of the setup logic.</strong>
|
|
The example below presents all possible variants. Pick one that meets your requirements.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Connection to the MQTT broker is established asynchronously.
|
|
The <a class="reference internal" href="../api/core/ha-mqtt.html"><span class="doc">HAMqtt::begin</span></a> method just sets the parameters of the connection.
|
|
The connection attempt is made during the loop cycle.</p>
|
|
</div>
|
|
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><Ethernet.h></span><span class="cp"></span>
|
|
<span class="cp">#include</span><span class="w"> </span><span class="cpf"><ArduinoHA.h></span><span class="cp"></span>
|
|
|
|
<span class="n">byte</span><span class="w"> </span><span class="n">mac</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mh">0x00</span><span class="p">,</span><span class="w"> </span><span class="mh">0x10</span><span class="p">,</span><span class="w"> </span><span class="mh">0xFA</span><span class="p">,</span><span class="w"> </span><span class="mh">0x6E</span><span class="p">,</span><span class="w"> </span><span class="mh">0x38</span><span class="p">,</span><span class="w"> </span><span class="mh">0x4A</span><span class="p">};</span><span class="w"></span>
|
|
<span class="n">EthernetClient</span><span class="w"> </span><span class="n">client</span><span class="p">;</span><span class="w"></span>
|
|
<span class="n">HADevice</span><span class="w"> </span><span class="nf">device</span><span class="p">(</span><span class="n">mac</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">mac</span><span class="p">));</span><span class="w"></span>
|
|
<span class="n">HAMqtt</span><span class="w"> </span><span class="nf">mqtt</span><span class="p">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="n">device</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="kt">void</span><span class="w"> </span><span class="nf">setup</span><span class="p">()</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
<span class="w"> </span><span class="n">Ethernet</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="n">mac</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="w"> </span><span class="c1">// anoymous connection on default port 1883</span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="s">"192.168.1.50"</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="w"> </span><span class="c1">// anoymous connection on port 8888</span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="s">"192.168.1.50"</span><span class="p">,</span><span class="w"> </span><span class="mi">8888</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="w"> </span><span class="c1">// connection with credentials on default port 1883</span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="s">"192.168.1.50"</span><span class="p">,</span><span class="w"> </span><span class="s">"username"</span><span class="p">,</span><span class="w"> </span><span class="s">"password"</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="w"> </span><span class="c1">// connection with credentials on port 8888</span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="s">"192.168.1.50"</span><span class="p">,</span><span class="w"> </span><span class="mi">8888</span><span class="p">,</span><span class="w"> </span><span class="s">"username"</span><span class="p">,</span><span class="w"> </span><span class="s">"password"</span><span class="p">);</span><span class="w"></span>
|
|
|
|
<span class="w"> </span><span class="c1">// you can also use hostname in all variants</span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">begin</span><span class="p">(</span><span class="s">"mybroker.local"</span><span class="p">);</span><span class="w"></span>
|
|
<span class="p">}</span><span class="w"></span>
|
|
|
|
<span class="kt">void</span><span class="w"> </span><span class="nf">loop</span><span class="p">()</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
<span class="w"> </span><span class="n">Ethernet</span><span class="p">.</span><span class="n">maintain</span><span class="p">();</span><span class="w"></span>
|
|
<span class="w"> </span><span class="n">mqtt</span><span class="p">.</span><span class="n">loop</span><span class="p">();</span><span class="w"></span>
|
|
<span class="p">}</span><span class="w"></span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
<div class="page-nav">
|
|
<div class="inner"><ul class="page-nav">
|
|
<li class="prev">
|
|
<a href="availability-reporting.html"
|
|
title="previous chapter">← Availability reporting</a>
|
|
</li>
|
|
<li class="next">
|
|
<a href="discovery.html"
|
|
title="next chapter">Discovery →</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> |