Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/smarthome@cb26d35 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@Morg42
Morg42 committed Jul 3, 2024
1 parent e59c55f commit f0e4f03
Show file tree
Hide file tree
Showing 731 changed files with 771 additions and 734 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 20027ca1e63461d7291f422cd7dcbb26
config: 7b535a556d6c6511dc4f15060bba7aee
tags: 53fce1f610f91183c07e2025655d47fe
2 changes: 1 addition & 1 deletion _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Überblick: Modul-Quellcode &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>Überblick: Modul-Quellcode &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.config &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.config &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/connection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.connection &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.connection &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/daemon.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.daemon &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.daemon &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/db.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.db &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.db &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/env.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.env &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.env &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/item/item.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.item.item &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.item.item &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/item/items.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.item.items &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.item.items &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/item_conversion.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.item_conversion &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.item_conversion &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/log.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.log &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.log &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/logic.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.logic &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.logic &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/logutils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.logutils &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.logutils &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/metadata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.metadata &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.metadata &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/model/mqttplugin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.model.mqttplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.model.mqttplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
Expand Down
29 changes: 27 additions & 2 deletions _modules/lib/model/smartdeviceplugin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.model.smartdeviceplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.model.smartdeviceplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
Expand Down Expand Up @@ -5827,6 +5827,8 @@ <h1>Quellcode für lib.model.smartdeviceplugin</h1><div class="highlight"><pre>

<span class="c1"># suspend mode properties</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_parameter_value</span><span class="p">(</span><span class="n">PLUGIN_ATTR_SUSPEND_ITEM</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">suspended</span> <span class="o">=</span> <span class="kc">False</span>

<span class="c1"># connection instance</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_connection</span> <span class="o">=</span> <span class="kc">None</span>
Expand Down Expand Up @@ -5982,11 +5984,34 @@ <h1>Quellcode für lib.model.smartdeviceplugin</h1><div class="highlight"><pre>

<span class="k">return</span> <span class="kc">True</span></div>

<div class="viewcode-block" id="SmartDevicePlugin.suspend"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartdeviceplugin_class.html#lib.model.smartdeviceplugin.SmartDevicePlugin.suspend">[Doku]</a> <span class="k">def</span> <span class="nf">suspend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">by</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> sets plugin into suspended mode, no network/serial activity and no item changed</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">alive</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;plugin suspended by </span><span class="si">{</span><span class="n">by</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;unknown&quot;</span><span class="si">}</span><span class="s1">, connections will be closed&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">suspended</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fullname</span><span class="p">())</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;disconnect&#39;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">disconnect</span><span class="p">()</span></div>

<div class="viewcode-block" id="SmartDevicePlugin.resume"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartdeviceplugin_class.html#lib.model.smartdeviceplugin.SmartDevicePlugin.resume">[Doku]</a> <span class="k">def</span> <span class="nf">resume</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">by</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> disabled suspended mode, network/serial connections are resumed</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">alive</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;plugin resumed by </span><span class="si">{</span><span class="n">by</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">by</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">&quot;unknown&quot;</span><span class="si">}</span><span class="s1">, connections will be resumed&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">suspended</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fullname</span><span class="p">())</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;connect&#39;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span></div>

<div class="viewcode-block" id="SmartDevicePlugin.set_suspend"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartdeviceplugin_class.html#lib.model.smartdeviceplugin.SmartDevicePlugin.set_suspend">[Doku]</a> <span class="k">def</span> <span class="nf">set_suspend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">suspend_active</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">by</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> enable / disable suspend mode: open/close connections, schedulers</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">if</span> <span class="n">suspend_active</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_suspend_item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># if no parameter set, try to use item setting</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/model/smartplugin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.model.smartplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.model.smartplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/module.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.module &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.module &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/network.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.network &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.network &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
2 changes: 1 addition & 1 deletion _modules/lib/orb.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>lib.orb &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit 65903b9) Dokumentation</title>
<title>lib.orb &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 3. Juli 2024, commit cb26d35) Dokumentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
Expand Down
Loading

0 comments on commit f0e4f03

Please sign in to comment.