Skip to content

Commit

Permalink
create docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ola Lidholm committed Mar 1, 2021
1 parent 08e2ae6 commit ad148a9
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 1 deletion.
35 changes: 34 additions & 1 deletion html/pyeasee/charger.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,12 @@ <h3>Methods</h3>
<dd>
<div class="desc"><p>Gets consumption between two dates</p></div>
</dd>
<dt id="pyeasee.charger.Charger.get_sessions_between_dates"><code class="name flex">
<span>async def <span class="ident">get_sessions_between_dates</span></span>(<span>self, from_date: datetime.datetime, to_date)</span>
</code></dt>
<dd>
<div class="desc"><p>Gets charging sessions between two dates</p></div>
</dd>
<dt id="pyeasee.charger.Charger.get_state"><code class="name flex">
<span>async def <span class="ident">get_state</span></span>(<span>self, raw=False) ‑> <a title="pyeasee.charger.ChargerState" href="#pyeasee.charger.ChargerState">ChargerState</a></span>
</code></dt>
Expand Down Expand Up @@ -121,6 +127,12 @@ <h3>Methods</h3>
<dd>
<div class="desc"><p>Pause charging session</p></div>
</dd>
<dt id="pyeasee.charger.Charger.phaseMode"><code class="name flex">
<span>async def <span class="ident">phaseMode</span></span>(<span>self, mode: int = 2)</span>
</code></dt>
<dd>
<div class="desc"><p>Set charging phase mode, 1 = always 1-phase, 2 = auto, 3 = always 3-phase</p></div>
</dd>
<dt id="pyeasee.charger.Charger.reboot"><code class="name flex">
<span>async def <span class="ident">reboot</span></span>(<span>self)</span>
</code></dt>
Expand Down Expand Up @@ -176,7 +188,7 @@ <h3>Methods</h3>
<div class="desc"><p>Enable and disable smart button in charger settings</p></div>
</dd>
<dt id="pyeasee.charger.Charger.smart_charging"><code class="name flex">
<span>async def <span class="ident">smart_charging</span></span>(<span>self)</span>
<span>async def <span class="ident">smart_charging</span></span>(<span>self, enable: bool)</span>
</code></dt>
<dd>
<div class="desc"><p>Set charger smart charging setting</p></div>
Expand Down Expand Up @@ -239,6 +251,22 @@ <h3>Ancestors</h3>
<li>collections.abc.Container</li>
</ul>
</dd>
<dt id="pyeasee.charger.ChargerSession"><code class="flex name class">
<span>class <span class="ident">ChargerSession</span></span>
<span>(</span><span>session: Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"><p>Charger charging session</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyeasee.utils.BaseDict" href="utils.html#pyeasee.utils.BaseDict">BaseDict</a></li>
<li>collections.abc.Mapping</li>
<li>collections.abc.Collection</li>
<li>collections.abc.Sized</li>
<li>collections.abc.Iterable</li>
<li>collections.abc.Container</li>
</ul>
</dd>
<dt id="pyeasee.charger.ChargerState"><code class="flex name class">
<span>class <span class="ident">ChargerState</span></span>
<span>(</span><span>state: Dict[str, Any], raw=False)</span>
Expand Down Expand Up @@ -281,11 +309,13 @@ <h4><code><a title="pyeasee.charger.Charger" href="#pyeasee.charger.Charger">Cha
<li><code><a title="pyeasee.charger.Charger.get_basic_charge_plan" href="#pyeasee.charger.Charger.get_basic_charge_plan">get_basic_charge_plan</a></code></li>
<li><code><a title="pyeasee.charger.Charger.get_config" href="#pyeasee.charger.Charger.get_config">get_config</a></code></li>
<li><code><a title="pyeasee.charger.Charger.get_consumption_between_dates" href="#pyeasee.charger.Charger.get_consumption_between_dates">get_consumption_between_dates</a></code></li>
<li><code><a title="pyeasee.charger.Charger.get_sessions_between_dates" href="#pyeasee.charger.Charger.get_sessions_between_dates">get_sessions_between_dates</a></code></li>
<li><code><a title="pyeasee.charger.Charger.get_state" href="#pyeasee.charger.Charger.get_state">get_state</a></code></li>
<li><code><a title="pyeasee.charger.Charger.limitToSinglePhaseCharging" href="#pyeasee.charger.Charger.limitToSinglePhaseCharging">limitToSinglePhaseCharging</a></code></li>
<li><code><a title="pyeasee.charger.Charger.lockCablePermanently" href="#pyeasee.charger.Charger.lockCablePermanently">lockCablePermanently</a></code></li>
<li><code><a title="pyeasee.charger.Charger.override_schedule" href="#pyeasee.charger.Charger.override_schedule">override_schedule</a></code></li>
<li><code><a title="pyeasee.charger.Charger.pause" href="#pyeasee.charger.Charger.pause">pause</a></code></li>
<li><code><a title="pyeasee.charger.Charger.phaseMode" href="#pyeasee.charger.Charger.phaseMode">phaseMode</a></code></li>
<li><code><a title="pyeasee.charger.Charger.reboot" href="#pyeasee.charger.Charger.reboot">reboot</a></code></li>
<li><code><a title="pyeasee.charger.Charger.resume" href="#pyeasee.charger.Charger.resume">resume</a></code></li>
<li><code><a title="pyeasee.charger.Charger.set_access" href="#pyeasee.charger.Charger.set_access">set_access</a></code></li>
Expand All @@ -309,6 +339,9 @@ <h4><code><a title="pyeasee.charger.ChargerConfig" href="#pyeasee.charger.Charge
<h4><code><a title="pyeasee.charger.ChargerSchedule" href="#pyeasee.charger.ChargerSchedule">ChargerSchedule</a></code></h4>
</li>
<li>
<h4><code><a title="pyeasee.charger.ChargerSession" href="#pyeasee.charger.ChargerSession">ChargerSession</a></code></h4>
</li>
<li>
<h4><code><a title="pyeasee.charger.ChargerState" href="#pyeasee.charger.ChargerState">ChargerState</a></code></h4>
</li>
</ul>
Expand Down
45 changes: 45 additions & 0 deletions html/pyeasee/site.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ <h3>Ancestors</h3>
</ul>
<h3>Methods</h3>
<dl>
<dt id="pyeasee.site.Equalizer.get_config"><code class="name flex">
<span>async def <span class="ident">get_config</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Get Equalizer config</p></div>
</dd>
<dt id="pyeasee.site.Equalizer.get_state"><code class="name flex">
<span>async def <span class="ident">get_state</span></span>(<span>self)</span>
</code></dt>
Expand All @@ -100,6 +106,38 @@ <h3>Methods</h3>
</dd>
</dl>
</dd>
<dt id="pyeasee.site.EqualizerConfig"><code class="flex name class">
<span>class <span class="ident">EqualizerConfig</span></span>
<span>(</span><span>config: Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyeasee.utils.BaseDict" href="utils.html#pyeasee.utils.BaseDict">BaseDict</a></li>
<li>collections.abc.Mapping</li>
<li>collections.abc.Collection</li>
<li>collections.abc.Sized</li>
<li>collections.abc.Iterable</li>
<li>collections.abc.Container</li>
</ul>
</dd>
<dt id="pyeasee.site.EqualizerState"><code class="flex name class">
<span>class <span class="ident">EqualizerState</span></span>
<span>(</span><span>state: Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyeasee.utils.BaseDict" href="utils.html#pyeasee.utils.BaseDict">BaseDict</a></li>
<li>collections.abc.Mapping</li>
<li>collections.abc.Collection</li>
<li>collections.abc.Sized</li>
<li>collections.abc.Iterable</li>
<li>collections.abc.Container</li>
</ul>
</dd>
<dt id="pyeasee.site.Site"><code class="flex name class">
<span>class <span class="ident">Site</span></span>
<span>(</span><span>data: Dict[str, Any], easee: Any)</span>
Expand Down Expand Up @@ -208,10 +246,17 @@ <h4><code><a title="pyeasee.site.Circuit" href="#pyeasee.site.Circuit">Circuit</
<li>
<h4><code><a title="pyeasee.site.Equalizer" href="#pyeasee.site.Equalizer">Equalizer</a></code></h4>
<ul class="">
<li><code><a title="pyeasee.site.Equalizer.get_config" href="#pyeasee.site.Equalizer.get_config">get_config</a></code></li>
<li><code><a title="pyeasee.site.Equalizer.get_state" href="#pyeasee.site.Equalizer.get_state">get_state</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="pyeasee.site.EqualizerConfig" href="#pyeasee.site.EqualizerConfig">EqualizerConfig</a></code></h4>
</li>
<li>
<h4><code><a title="pyeasee.site.EqualizerState" href="#pyeasee.site.EqualizerState">EqualizerState</a></code></h4>
</li>
<li>
<h4><code><a title="pyeasee.site.Site" href="#pyeasee.site.Site">Site</a></code></h4>
<ul class="">
<li><code><a title="pyeasee.site.Site.get_circuits" href="#pyeasee.site.Site.get_circuits">get_circuits</a></code></li>
Expand Down
3 changes: 3 additions & 0 deletions html/pyeasee/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,12 @@ <h3>Subclasses</h3>
<li><a title="pyeasee.charger.Charger" href="charger.html#pyeasee.charger.Charger">Charger</a></li>
<li><a title="pyeasee.charger.ChargerConfig" href="charger.html#pyeasee.charger.ChargerConfig">ChargerConfig</a></li>
<li><a title="pyeasee.charger.ChargerSchedule" href="charger.html#pyeasee.charger.ChargerSchedule">ChargerSchedule</a></li>
<li><a title="pyeasee.charger.ChargerSession" href="charger.html#pyeasee.charger.ChargerSession">ChargerSession</a></li>
<li><a title="pyeasee.charger.ChargerState" href="charger.html#pyeasee.charger.ChargerState">ChargerState</a></li>
<li><a title="pyeasee.site.Circuit" href="site.html#pyeasee.site.Circuit">Circuit</a></li>
<li><a title="pyeasee.site.Equalizer" href="site.html#pyeasee.site.Equalizer">Equalizer</a></li>
<li><a title="pyeasee.site.EqualizerConfig" href="site.html#pyeasee.site.EqualizerConfig">EqualizerConfig</a></li>
<li><a title="pyeasee.site.EqualizerState" href="site.html#pyeasee.site.EqualizerState">EqualizerState</a></li>
<li><a title="pyeasee.site.Site" href="site.html#pyeasee.site.Site">Site</a></li>
<li><a title="pyeasee.site.SiteState" href="site.html#pyeasee.site.SiteState">SiteState</a></li>
</ul>
Expand Down

0 comments on commit ad148a9

Please sign in to comment.