Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
splitting BoilerInfo and BoilerStatus.
Browse files Browse the repository at this point in the history
flag attrs as needed when installing pymultimatic module
  • Loading branch information
thomasgermain committed Nov 22, 2019
1 parent 0263d70 commit a8ca0fd
Show file tree
Hide file tree
Showing 19 changed files with 163 additions and 94 deletions.
4 changes: 3 additions & 1 deletion docs/build/html/components.html
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ <h2>Device<a class="headerlink" href="#device" title="Permalink to this headline
<h2>System<a class="headerlink" href="#system" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pymultimatic.model.system.System">
<em class="property">class </em><code class="sig-prename descclassname">pymultimatic.model.system.</code><code class="sig-name descname">System</code><span class="sig-paren">(</span><em class="sig-param">holiday_mode: pymultimatic.model.mode.HolidayMode, system_status: pymultimatic.model.status.SystemStatus, boiler_status: Optional[pymultimatic.model.status.BoilerStatus], zones: List[pymultimatic.model.component.Zone], rooms: List[pymultimatic.model.component.Room], hot_water: Optional[pymultimatic.model.component.HotWater], circulation: Optional[pymultimatic.model.component.Circulation], outdoor_temperature: Optional[float], quick_mode: Optional[pymultimatic.model.mode.QuickMode], errors: List[pymultimatic.model.status.Error]</em><span class="sig-paren">)</span><a class="headerlink" href="#pymultimatic.model.system.System" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">pymultimatic.model.system.</code><code class="sig-name descname">System</code><span class="sig-paren">(</span><em class="sig-param">holiday_mode: pymultimatic.model.mode.HolidayMode, system_status: pymultimatic.model.status.SystemStatus, boiler_status: Optional[pymultimatic.model.status.BoilerStatus], zones: List[pymultimatic.model.component.Zone], rooms: List[pymultimatic.model.component.Room], hot_water: Optional[pymultimatic.model.component.HotWater], circulation: Optional[pymultimatic.model.component.Circulation], outdoor_temperature: Optional[float], quick_mode: Optional[pymultimatic.model.mode.QuickMode], errors: List[pymultimatic.model.status.Error], boiler_info: Optional[pymultimatic.model.boilerinfo.BoilerInfo]</em><span class="sig-paren">)</span><a class="headerlink" href="#pymultimatic.model.system.System" title="Permalink to this definition"></a></dt>
<dd><p>This class represents the main class to manipulate vaillant system. It
groups all the information about the system.</p>
<dl class="field-list simple">
Expand All @@ -355,6 +355,8 @@ <h2>System<a class="headerlink" href="#system" title="Permalink to this headline
<li><p><strong>quick_mode</strong> (<a class="reference internal" href="modes.html#pymultimatic.model.mode.QuickMode" title="pymultimatic.model.mode.QuickMode"><em>QuickMode</em></a>) – If any quick mode is running, it’s available
here.</p></li>
<li><p><strong>errors</strong> (<em>List</em><em>[</em><a class="reference internal" href="model.html#pymultimatic.model.status.Error" title="pymultimatic.model.status.Error"><em>Error</em></a><em>]</em>) – If there are errors, you can find them here.</p></li>
<li><p><strong>boiler_info</strong> (<a class="reference internal" href="model.html#pymultimatic.model.boilerinfo.BoilerInfo" title="pymultimatic.model.boilerinfo.BoilerInfo"><em>BoilerInfo</em></a>) – Information (pressure, temperature) about
the boiler</p></li>
</ul>
</dd>
</dl>
Expand Down
4 changes: 4 additions & 0 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ <h2 id="A">A</h2>

<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="model.html#pymultimatic.model.boilerinfo.BoilerInfo">BoilerInfo (class in pymultimatic.model.boilerinfo)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="model.html#pymultimatic.model.status.BoilerStatus">BoilerStatus (class in pymultimatic.model.status)</a>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ <h1>Index<a class="headerlink" href="#index" title="Permalink to this headline">
<li class="toctree-l1"><a class="reference internal" href="model.html">Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="model.html#error">Error</a></li>
<li class="toctree-l2"><a class="reference internal" href="model.html#boilerstatus">BoilerStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="model.html#boilerinfo">BoilerInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="model.html#systemstatus">SystemStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="model.html#syncstate">SyncState</a></li>
<li class="toctree-l2"><a class="reference internal" href="model.html#timeperiodsetting">TimePeriodSetting</a></li>
Expand Down
28 changes: 21 additions & 7 deletions docs/build/html/model.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ <h2>Table Of Contents</h2>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#error">Error</a></li>
<li class="toctree-l2"><a class="reference internal" href="#boilerstatus">BoilerStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#boilerinfo">BoilerInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="#systemstatus">SystemStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#syncstate">SyncState</a></li>
<li class="toctree-l2"><a class="reference internal" href="#timeperiodsetting">TimePeriodSetting</a></li>
Expand Down Expand Up @@ -142,17 +143,13 @@ <h2>Error<a class="headerlink" href="#error" title="Permalink to this headline">
<h2>BoilerStatus<a class="headerlink" href="#boilerstatus" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pymultimatic.model.status.BoilerStatus">
<em class="property">class </em><code class="sig-prename descclassname">pymultimatic.model.status.</code><code class="sig-name descname">BoilerStatus</code><span class="sig-paren">(</span><em class="sig-param">device_name: str, title: str, status_code: str, description: str, timestamp: datetime.datetime, hint: str, water_pressure: Optional[float], current_temperature: Optional[float]</em><span class="sig-paren">)</span><a class="headerlink" href="#pymultimatic.model.status.BoilerStatus" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">pymultimatic.model.status.</code><code class="sig-name descname">BoilerStatus</code><span class="sig-paren">(</span><em class="sig-param">device_name: str</em>, <em class="sig-param">title: str</em>, <em class="sig-param">status_code: str</em>, <em class="sig-param">description: str</em>, <em class="sig-param">timestamp: datetime.datetime</em>, <em class="sig-param">hint: str</em><span class="sig-paren">)</span><a class="headerlink" href="#pymultimatic.model.status.BoilerStatus" title="Permalink to this definition"></a></dt>
<dd><p>Status of the boiler. This is sent with an error format, but in this
case, it’s more like a status.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hint</strong> (<em>str</em>) – Directly coming from the API, most of the time the value is
<code class="docutils literal notranslate"><span class="pre">...</span></code></p></li>
<li><p><strong>water_pressure</strong> (<em>float</em>) – Water pressure in bar</p></li>
<li><p><strong>current_temperature</strong> (<em>float</em>) – Current temperature of the boiler.</p></li>
</ul>
<dd class="field-odd"><p><strong>hint</strong> (<em>str</em>) – Directly coming from the API, most of the time the value is
<code class="docutils literal notranslate"><span class="pre">...</span></code></p>
</dd>
</dl>
<dl class="method">
Expand All @@ -168,6 +165,23 @@ <h2>BoilerStatus<a class="headerlink" href="#boilerstatus" title="Permalink to t

</dd></dl>

</div>
<div class="section" id="boilerinfo">
<h2>BoilerInfo<a class="headerlink" href="#boilerinfo" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pymultimatic.model.boilerinfo.BoilerInfo">
<em class="property">class </em><code class="sig-prename descclassname">pymultimatic.model.boilerinfo.</code><code class="sig-name descname">BoilerInfo</code><span class="sig-paren">(</span><em class="sig-param">water_pressure: Optional[float], current_temperature: Optional[float]</em><span class="sig-paren">)</span><a class="headerlink" href="#pymultimatic.model.boilerinfo.BoilerInfo" title="Permalink to this definition"></a></dt>
<dd><p>Information about the boiler.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>water_pressure</strong> (<em>float</em>) – Water pressure in bar</p></li>
<li><p><strong>current_temperature</strong> (<em>float</em>) – Current temperature of the boiler.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="systemstatus">
<h2>SystemStatus<a class="headerlink" href="#systemstatus" title="Permalink to this headline"></a></h2>
Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
Loading

0 comments on commit a8ca0fd

Please sign in to comment.