pi30max doc add

docs/html/_sources/protocols.mppsolar.rst.txt

@@ -6,3 +6,4 @@ MPPsolar Protocols
     :maxdepth: 2
 
     protocols.docs.pi30
+    protocols.docs.pi30max

docs/html/genindex.html

@@ -212,12 +212,14 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="powermon.device.html#powermon.device.Device.add_command">add_command() (powermon.device.Device method)</a>
 </li>
-      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definitions">add_command_definitions() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
+      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definition">add_command_definition() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
 </li>
-      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.add_supported_ports">add_supported_ports() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
+      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definitions">add_command_definitions() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.add_supported_ports">add_supported_ports() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
+</li>
       <li><a href="powermon.libs.apicoordinator.html#powermon.libs.apicoordinator.ApiCoordinator.addcommand_callback">addcommand_callback() (powermon.libs.apicoordinator.ApiCoordinator method)</a>
 </li>
       <li><a href="powermon.device.html#powermon.device.Device.adhoc_command_cb">adhoc_command_cb() (powermon.device.Device method)</a>
@@ -523,10 +525,14 @@ <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="powermon.outputformats.hass.html#powermon.outputformats.hass.Hass">Hass (class in powermon.outputformats.hass)</a>
+</li>
+      <li><a href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassAutoDiscovery">HassAutoDiscovery (class in powermon.outputformats.hass)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="powermon.configmodel.format_config_model.html#powermon.configmodel.format_config_model.HassFormatConfig">HassFormatConfig (class in powermon.configmodel.format_config_model)</a>
+</li>
+      <li><a href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassState">HassState (class in powermon.outputformats.hass)</a>
 </li>
       <li><a href="powermon.outputformats.htmltable.html#powermon.outputformats.htmltable.HtmlTable">HtmlTable (class in powermon.outputformats.htmltable)</a>
 </li>
@@ -1351,6 +1357,8 @@ <h2 id="R">R</h2>
       <li><a href="powermon.outputformats.raw.html#powermon.outputformats.raw.Raw">Raw (class in powermon.outputformats.raw)</a>
 </li>
       <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.remove_command_definitions">remove_command_definitions() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
+</li>
+      <li><a href="powermon.protocols.abstractprotocol.html#powermon.protocols.abstractprotocol.AbstractProtocol.replace_command_definition">replace_command_definition() (powermon.protocols.abstractprotocol.AbstractProtocol method)</a>
 </li>
       <li><a href="powermon.ports.serialport.html#powermon.ports.serialport.SerialPort.resolve_path">resolve_path() (powermon.ports.serialport.SerialPort method)</a>
 

docs/html/index.html

@@ -271,6 +271,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
 <li class="toctree-l2"><a class="reference internal" href="protocols.html#inverter-protocols">Inverter Protocols</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="protocols.mppsolar.html">MPPsolar Protocols</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="protocols.docs.pi30.html">PI30</a></li>
+<li class="toctree-l4"><a class="reference internal" href="protocols.docs.pi30max.html">PI30</a></li>
 </ul>
 </li>
 </ul>

docs/html/modules.html

@@ -22,7 +22,7 @@
   <link rel="index" title="Index" href="genindex.html" />
   <link rel="search" title="Search" href="search.html" />
   <link rel="next" title="powermon package" href="powermon.html" />
-  <link rel="prev" title="PI30" href="protocols.docs.pi30.html" /> 
+  <link rel="prev" title="PI30" href="protocols.docs.pi30max.html" /> 
   </head>
 
   <body>
@@ -169,7 +169,7 @@
 
   <ul class="page-nav">
   <li class="prev">
-    <a href="protocols.docs.pi30.html"
+    <a href="protocols.docs.pi30max.html"
        title="previous chapter">← PI30</a>
   </li>
   <li class="next">
@@ -263,7 +263,7 @@ <h1>powermon<a class="headerlink" href="#powermon" title="Link to this heading">
           <div class="page-nav">
             <div class="inner"><ul class="page-nav">
   <li class="prev">
-    <a href="protocols.docs.pi30.html"
+    <a href="protocols.docs.pi30max.html"
        title="previous chapter">← PI30</a>
   </li>
   <li class="next">

docs/html/powermon.html

@@ -285,6 +285,8 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </li>
 <li class="toctree-l3"><a class="reference internal" href="powermon.outputformats.hass.html">powermon.outputformats.hass module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.Hass"><code class="docutils literal notranslate"><span class="pre">Hass</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassAutoDiscovery"><code class="docutils literal notranslate"><span class="pre">HassAutoDiscovery</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassState"><code class="docutils literal notranslate"><span class="pre">HassState</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="powermon.outputformats.htmltable.html">powermon.outputformats.htmltable module</a><ul>

docs/html/powermon.outputformats.hass.html

@@ -204,6 +204,20 @@
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="powermon.outputformats.hass.HassAutoDiscovery">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">powermon.outputformats.hass.</span></span><span class="sig-name descname"><span class="pre">HassAutoDiscovery</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.outputformats.hass.HassAutoDiscovery" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#powermon.outputformats.hass.Hass" title="powermon.outputformats.hass.Hass"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hass</span></code></a></p>
+<p>formatter to generate home assistant auto config mqtt messages</p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="powermon.outputformats.hass.HassState">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">powermon.outputformats.hass.</span></span><span class="sig-name descname"><span class="pre">HassState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.outputformats.hass.HassState" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#powermon.outputformats.hass.Hass" title="powermon.outputformats.hass.Hass"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hass</span></code></a></p>
+<p>formatter to generate home assistant state update mqtt messages</p>
+</dd></dl>
+
 </section>
 
 

docs/html/powermon.outputformats.html

@@ -234,6 +234,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <li class="toctree-l3"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.Hass.get_options"><code class="docutils literal notranslate"><span class="pre">Hass.get_options()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassAutoDiscovery"><code class="docutils literal notranslate"><span class="pre">HassAutoDiscovery</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="powermon.outputformats.hass.html#powermon.outputformats.hass.HassState"><code class="docutils literal notranslate"><span class="pre">HassState</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="powermon.outputformats.htmltable.html">powermon.outputformats.htmltable module</a><ul>

docs/html/powermon.ports.html

@@ -219,7 +219,7 @@
 
 <dl class="py function">
 <dt class="sig sig-object py" id="powermon.ports.from_config">
-<span class="sig-prename descclassname"><span class="pre">powermon.ports.</span></span><span class="sig-name descname"><span class="pre">from_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serial_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.ports.from_config" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">powermon.ports.</span></span><span class="sig-name descname"><span class="pre">from_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.ports.from_config" title="Link to this definition">¶</a></dt>
 <dd><p>get a port object from config data</p>
 </dd></dl>
 

docs/html/powermon.protocols.abstractprotocol.html

@@ -187,7 +187,7 @@
 <p>protocols / abstractprotocol.py</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="powermon.protocols.abstractprotocol.AbstractProtocol">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">powermon.protocols.abstractprotocol.</span></span><span class="sig-name descname"><span class="pre">AbstractProtocol</span></span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">powermon.protocols.abstractprotocol.</span></span><span class="sig-name descname"><span class="pre">AbstractProtocol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>base definition for all protocols
 protocol has:
@@ -196,9 +196,15 @@
 and functions to:
 - add / remove / count / get command definitions
 - check validity / crc / trim / split response</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definition">
+<span class="sig-name descname"><span class="pre">add_command_definition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definition" title="Link to this definition">¶</a></dt>
+<dd><p>Add a command definition</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definitions">
-<span class="sig-name descname"><span class="pre">add_command_definitions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command_definitions_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ResultType</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definitions" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">add_command_definitions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command_definitions_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command_definitions_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ResultType</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol.add_command_definitions" title="Link to this definition">¶</a></dt>
 <dd><p>Add command definitions from the configuration</p>
 </dd></dl>
 
@@ -275,6 +281,12 @@
 <dd><p>Remove specified command definitions</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="powermon.protocols.abstractprotocol.AbstractProtocol.replace_command_definition">
+<span class="sig-name descname"><span class="pre">replace_command_definition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command_definition_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol.replace_command_definition" title="Link to this definition">¶</a></dt>
+<dd><p>Replace a command definition with a new one</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="powermon.protocols.abstractprotocol.AbstractProtocol.split_response">
 <span class="sig-name descname"><span class="pre">split_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command_definition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">CommandDefinition</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#powermon.protocols.abstractprotocol.AbstractProtocol.split_response" title="Link to this definition">¶</a></dt>