Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/smarthome@f2e55ff 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@msinn
msinn committed May 20, 2024
1 parent 18243bf commit 8421c54
Show file tree
Hide file tree
Showing 729 changed files with 760 additions and 733 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: 3497e5ce8b90982bcec7b8f083afc864
config: be5fe8a6333529de2c7dfb1dfd4abde8
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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>Überblick: Modul-Quellcode &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.config &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.connection &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.daemon &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.db &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.env &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.item.item &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.item.items &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.item_conversion &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.log &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.logic &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.logutils &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.metadata &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.model.mqttplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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/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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.model.smartdeviceplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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
25 changes: 21 additions & 4 deletions _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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.model.smartplugin &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 @@ -6675,6 +6675,7 @@ <h1>Quellcode für lib.model.smartplugin</h1><div class="highlight"><pre>

<span class="n">_asyncio_loop</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># eventloop of the plugin</span>
<span class="n">_asyncio_state</span> <span class="o">=</span> <span class="s1">&#39;unused&#39;</span>
<span class="n">_used_plugin_coro</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># plugin coro used when calling start_asyncio (to be able to used by a generic &#39;restart asyncio&#39; method</span>
<span class="n">run_queue</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># queue to send commends to the main-coro/plugin-coro</span>

<div class="viewcode-block" id="SmartPlugin.asyncio_state"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartplugin_class.html#lib.model.smartplugin.SmartPlugin.asyncio_state">[Doku]</a> <span class="k">def</span> <span class="nf">asyncio_state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
Expand All @@ -6697,16 +6698,32 @@ <h1>Quellcode für lib.model.smartplugin</h1><div class="highlight"><pre>

<span class="sd"> :param plugin_coro: The asyncio coroutine which implements the async part of the plugin</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_used_plugin_coro</span> <span class="o">=</span> <span class="n">plugin_coro</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_start_known_asyncio_coro</span><span class="p">()</span></div>

<span class="k">def</span> <span class="nf">_start_known_asyncio_coro</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Start the thread for the asyncio loop, when plugin_coro is already known</span>

<span class="sd"> The started asyncio thread sets up the asyncio environment and starts the evemtloop.</span>
<span class="sd"> This routine is to be called from the plugin&#39;s run() method</span>

<span class="sd"> :param plugin_coro: The asyncio coroutine which implements the async part of the plugin</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">_used_plugin_coro</span> <span class="ow">is</span> <span class="kc">None</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">error</span><span class="p">(</span><span class="s2">&quot;Called &#39;_start_known_asyncio_coro()&#39; without known plugin_coro&quot;</span><span class="p">)</span>
<span class="k">return</span>

<span class="n">threadname</span> <span class="o">=</span> <span class="s1">&#39;plugins.&#39;</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">get_fullname</span><span class="p">()</span><span class="o">+</span><span class="s1">&#39;.asyncio&#39;</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pluginThread</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_asyncio_loop_thread</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">threadname</span><span class="p">,</span> <span class="n">daemon</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;plugin_coro&#39;</span><span class="p">:</span> <span class="n">plugin_coro</span><span class="p">})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pluginThread</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_asyncio_loop_thread</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">threadname</span><span class="p">,</span> <span class="n">daemon</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;plugin_coro&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_used_plugin_coro</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="s2">&quot;Starting thread </span><span class="si">{</span><span class="n">threadname</span><span class="si">}</span><span class="s2"> for asyncio loop...&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pluginThread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Cannot start thread &#39;</span><span class="si">{</span><span class="n">threadname</span><span class="si">}</span><span class="s2">&#39; - Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">return</span></div>
<span class="k">return</span>

<div class="viewcode-block" id="SmartPlugin.stop_asyncio"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartplugin_class.html#lib.model.smartplugin.SmartPlugin.stop_asyncio">[Doku]</a> <span class="k">def</span> <span class="nf">stop_asyncio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="SmartPlugin.stop_asyncio"><a class="viewcode-back" href="../../../referenz/plugins/plugin_typen/smartplugin_class.html#lib.model.smartplugin.SmartPlugin.stop_asyncio">[Doku]</a> <span class="k">def</span> <span class="nf">stop_asyncio</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> stop the eventloop and the thread it is running in</span>

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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.module &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.network &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 20. Mai 2024, commit 5917724) Dokumentation</title>
<title>lib.orb &mdash; Dokumentation v1.10.0.2 v1.10.0.2 develop (Stand 20. Mai 2024, commit f2e55ff) 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 8421c54

Please sign in to comment.