Skip to content

Commit f519396

Browse files
Deployed ad031dc to v0.18-dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 3220e24 commit f519396

File tree

4 files changed

+188
-19
lines changed

4 files changed

+188
-19
lines changed

v0.18-dev/reference/frequenz/client/reporting/index.html

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1670,7 +1670,7 @@ <h4 id="frequenz.client.reporting.ReportingApiClient" class="doc doc-heading">
16701670
</span><span id="__span-0-316"><a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_components_data_streams</span><span class="p">[</span><span class="n">stream_key</span><span class="p">]</span><span class="o">.</span><span class="n">new_receiver</span><span class="p">()</span>
16711671
</span><span id="__span-0-317"><a id="__codelineno-0-317" name="__codelineno-0-317"></a>
16721672
</span><span id="__span-0-318"><a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="c1"># pylint: disable=too-many-arguments</span>
1673-
</span><span id="__span-0-319"><a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">receive_single_sensor_data</span><span class="p">(</span>
1673+
</span><span id="__span-0-319"><a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="k">def</span><span class="w"> </span><span class="nf">receive_single_sensor_data</span><span class="p">(</span>
16741674
</span><span id="__span-0-320"><a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="bp">self</span><span class="p">,</span>
16751675
</span><span id="__span-0-321"><a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="o">*</span><span class="p">,</span>
16761676
</span><span id="__span-0-322"><a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">microgrid_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
@@ -1695,7 +1695,7 @@ <h4 id="frequenz.client.reporting.ReportingApiClient" class="doc doc-heading">
16951695
</span><span id="__span-0-341"><a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> Returns:</span>
16961696
</span><span id="__span-0-342"><a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> A receiver of `MetricSample`s.</span>
16971697
</span><span id="__span-0-343"><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> &quot;&quot;&quot;</span>
1698-
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
1698+
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
16991699
</span><span id="__span-0-345"><a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">microgrid_sensors</span><span class="o">=</span><span class="p">[(</span><span class="n">microgrid_id</span><span class="p">,</span> <span class="p">[</span><span class="n">sensor_id</span><span class="p">])],</span>
17001700
</span><span id="__span-0-346"><a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="n">metrics</span><span class="p">]</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">Metric</span><span class="p">)</span> <span class="k">else</span> <span class="n">metrics</span><span class="p">,</span>
17011701
</span><span id="__span-0-347"><a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="n">start_time</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>
@@ -1706,7 +1706,7 @@ <h4 id="frequenz.client.reporting.ReportingApiClient" class="doc doc-heading">
17061706
</span><span id="__span-0-352"><a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="k">return</span> <span class="n">BatchUnrollReceiver</span><span class="p">(</span><span class="n">receiver</span><span class="p">)</span>
17071707
</span><span id="__span-0-353"><a id="__codelineno-0-353" name="__codelineno-0-353"></a>
17081708
</span><span id="__span-0-354"><a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="c1"># pylint: disable=too-many-arguments</span>
1709-
</span><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">receive_microgrid_sensors_data</span><span class="p">(</span>
1709+
</span><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="k">def</span><span class="w"> </span><span class="nf">receive_microgrid_sensors_data</span><span class="p">(</span>
17101710
</span><span id="__span-0-356"><a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="bp">self</span><span class="p">,</span>
17111711
</span><span id="__span-0-357"><a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="o">*</span><span class="p">,</span>
17121712
</span><span id="__span-0-358"><a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="n">microgrid_sensors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]]],</span>
@@ -1730,7 +1730,7 @@ <h4 id="frequenz.client.reporting.ReportingApiClient" class="doc doc-heading">
17301730
</span><span id="__span-0-376"><a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="sd"> Returns:</span>
17311731
</span><span id="__span-0-377"><a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="sd"> A receiver of `MetricSample`s.</span>
17321732
</span><span id="__span-0-378"><a id="__codelineno-0-378" name="__codelineno-0-378"></a><span class="sd"> &quot;&quot;&quot;</span>
1733-
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
1733+
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
17341734
</span><span id="__span-0-380"><a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="n">microgrid_sensors</span><span class="o">=</span><span class="n">microgrid_sensors</span><span class="p">,</span>
17351735
</span><span id="__span-0-381"><a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="n">metrics</span><span class="p">]</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">Metric</span><span class="p">)</span> <span class="k">else</span> <span class="n">metrics</span><span class="p">,</span>
17361736
</span><span id="__span-0-382"><a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">start_time</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>
@@ -1742,7 +1742,7 @@ <h4 id="frequenz.client.reporting.ReportingApiClient" class="doc doc-heading">
17421742
</span><span id="__span-0-388"><a id="__codelineno-0-388" name="__codelineno-0-388"></a>
17431743
</span><span id="__span-0-389"><a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="c1"># pylint: disable=too-many-arguments</span>
17441744
</span><span id="__span-0-390"><a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="c1"># pylint: disable=too-many-locals</span>
1745-
</span><span id="__span-0-391"><a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
1745+
</span><span id="__span-0-391"><a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
17461746
</span><span id="__span-0-392"><a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="bp">self</span><span class="p">,</span>
17471747
</span><span id="__span-0-393"><a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="o">*</span><span class="p">,</span>
17481748
</span><span id="__span-0-394"><a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="n">microgrid_sensors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]]],</span>
@@ -3080,10 +3080,6 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_microgrid_sensors_d
30803080
<span class="doc doc-object-name doc-function-name">receive_microgrid_sensors_data</span>
30813081

30823082

3083-
<span class="doc doc-labels">
3084-
<small class="doc doc-label doc-label-async"><code>async</code></small>
3085-
</span>
3086-
30873083
<a href="#frequenz.client.reporting.ReportingApiClient.receive_microgrid_sensors_data" class="headerlink" title="Permanent link">¤</a></h6>
30883084
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">receive_microgrid_sensors_data</span><span class="p">(</span>
30893085
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
@@ -3272,7 +3268,7 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_microgrid_sensors_d
32723268
<span class="normal"><a href="#__codelineno-0-384">384</a></span>
32733269
<span class="normal"><a href="#__codelineno-0-385">385</a></span>
32743270
<span class="normal"><a href="#__codelineno-0-386">386</a></span>
3275-
<span class="normal"><a href="#__codelineno-0-387">387</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">receive_microgrid_sensors_data</span><span class="p">(</span>
3271+
<span class="normal"><a href="#__codelineno-0-387">387</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="k">def</span><span class="w"> </span><span class="nf">receive_microgrid_sensors_data</span><span class="p">(</span>
32763272
</span><span id="__span-0-356"><a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="bp">self</span><span class="p">,</span>
32773273
</span><span id="__span-0-357"><a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="o">*</span><span class="p">,</span>
32783274
</span><span id="__span-0-358"><a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="n">microgrid_sensors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]]],</span>
@@ -3296,7 +3292,7 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_microgrid_sensors_d
32963292
</span><span id="__span-0-376"><a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="sd"> Returns:</span>
32973293
</span><span id="__span-0-377"><a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="sd"> A receiver of `MetricSample`s.</span>
32983294
</span><span id="__span-0-378"><a id="__codelineno-0-378" name="__codelineno-0-378"></a><span class="sd"> &quot;&quot;&quot;</span>
3299-
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
3295+
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
33003296
</span><span id="__span-0-380"><a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="n">microgrid_sensors</span><span class="o">=</span><span class="n">microgrid_sensors</span><span class="p">,</span>
33013297
</span><span id="__span-0-381"><a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="n">metrics</span><span class="p">]</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">Metric</span><span class="p">)</span> <span class="k">else</span> <span class="n">metrics</span><span class="p">,</span>
33023298
</span><span id="__span-0-382"><a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">start_time</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>
@@ -3599,10 +3595,6 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_single_sensor_data"
35993595
<span class="doc doc-object-name doc-function-name">receive_single_sensor_data</span>
36003596

36013597

3602-
<span class="doc doc-labels">
3603-
<small class="doc doc-label doc-label-async"><code>async</code></small>
3604-
</span>
3605-
36063598
<a href="#frequenz.client.reporting.ReportingApiClient.receive_single_sensor_data" class="headerlink" title="Permanent link">¤</a></h6>
36073599
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">receive_single_sensor_data</span><span class="p">(</span>
36083600
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="o">*</span><span class="p">,</span>
@@ -3808,7 +3800,7 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_single_sensor_data"
38083800
<span class="normal"><a href="#__codelineno-0-349">349</a></span>
38093801
<span class="normal"><a href="#__codelineno-0-350">350</a></span>
38103802
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
3811-
<span class="normal"><a href="#__codelineno-0-352">352</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-319"><a id="__codelineno-0-319" name="__codelineno-0-319"></a><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">receive_single_sensor_data</span><span class="p">(</span>
3803+
<span class="normal"><a href="#__codelineno-0-352">352</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-319"><a id="__codelineno-0-319" name="__codelineno-0-319"></a><span class="k">def</span><span class="w"> </span><span class="nf">receive_single_sensor_data</span><span class="p">(</span>
38123804
</span><span id="__span-0-320"><a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="bp">self</span><span class="p">,</span>
38133805
</span><span id="__span-0-321"><a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="o">*</span><span class="p">,</span>
38143806
</span><span id="__span-0-322"><a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">microgrid_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
@@ -3833,7 +3825,7 @@ <h6 id="frequenz.client.reporting.ReportingApiClient.receive_single_sensor_data"
38333825
</span><span id="__span-0-341"><a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> Returns:</span>
38343826
</span><span id="__span-0-342"><a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> A receiver of `MetricSample`s.</span>
38353827
</span><span id="__span-0-343"><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> &quot;&quot;&quot;</span>
3836-
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
3828+
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="n">receiver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_receive_microgrid_sensors_data_batch</span><span class="p">(</span>
38373829
</span><span id="__span-0-345"><a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">microgrid_sensors</span><span class="o">=</span><span class="p">[(</span><span class="n">microgrid_id</span><span class="p">,</span> <span class="p">[</span><span class="n">sensor_id</span><span class="p">])],</span>
38383830
</span><span id="__span-0-346"><a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="n">metrics</span><span class="p">]</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">metrics</span><span class="p">,</span> <span class="n">Metric</span><span class="p">)</span> <span class="k">else</span> <span class="n">metrics</span><span class="p">,</span>
38393831
</span><span id="__span-0-347"><a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="n">start_time</span><span class="o">=</span><span class="n">start_time</span><span class="p">,</span>

v0.18-dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

v0.18-dev/sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)