Skip to content

Commit 879216a

Browse files
github-actions[bot]github-actions[bot]
committed
Deployed 33e2353 to v0.18-dev with MkDocs 1.6.1 and mike 2.1.3
1 parent cf6ce93 commit 879216a

File tree

4 files changed

+201
-19
lines changed

4 files changed

+201
-19
lines changed

‎v0.18-dev/index.html‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -908,14 +908,18 @@ <h3 id="installation">Installation<a class="headerlink" href="#installation" tit
908908
</span></code></pre></div>
909909
<h3 id="initialize-the-client">Initialize the client<a class="headerlink" href="#initialize-the-client" title="Permanent link">¤</a></h3>
910910
<div class="language-python highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
911-
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
912-
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="kn">from</span><span class="w"> </span><span class="nn">frequenz.client.common.metric</span><span class="w"> </span><span class="kn">import</span> <span class="n">Metric</span>
913-
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="kn">from</span><span class="w"> </span><span class="nn">frequenz.client.reporting</span><span class="w"> </span><span class="kn">import</span> <span class="n">ReportingApiClient</span>
914-
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>
915-
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="c1"># Change server address</span>
916-
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="n">SERVER_URL</span> <span class="o">=</span> <span class="s2">&quot;grpc://replace-this-with-your-server-url:port&quot;</span>
917-
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="n">API_KEY</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;api_key.txt&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
918-
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="n">client</span> <span class="o">=</span> <span class="n">ReportingApiClient</span><span class="p">(</span><span class="n">server_url</span><span class="o">=</span><span class="n">SERVER_URL</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">API_KEY</span><span class="p">)</span>
911+
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
912+
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
913+
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="kn">from</span><span class="w"> </span><span class="nn">frequenz.client.common.metric</span><span class="w"> </span><span class="kn">import</span> <span class="n">Metric</span>
914+
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="kn">from</span><span class="w"> </span><span class="nn">frequenz.client.reporting</span><span class="w"> </span><span class="kn">import</span> <span class="n">ReportingApiClient</span>
915+
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>
916+
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="c1"># Change server address</span>
917+
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="n">SERVER_URL</span> <span class="o">=</span> <span class="s2">&quot;grpc://replace-this-with-your-server-url:port&quot;</span>
918+
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="n">AUTH_KEY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;REPORTING_API_AUTH_KEY&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
919+
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="c1"># It is recommended to use a proper secret store to get the secret</span>
920+
</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="c1"># For local development, make sure not to leave it in the shell history</span>
921+
</span><span id="__span-1-12"><a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="n">SIGN_SECRET</span><span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;REPORTING_API_SIGN_SECRET&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
922+
</span><span id="__span-1-13"><a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="n">client</span> <span class="o">=</span> <span class="n">ReportingApiClient</span><span class="p">(</span><span class="n">server_url</span><span class="o">=</span><span class="n">SERVER_URL</span><span class="p">,</span> <span class="n">auth_key</span><span class="o">=</span><span class="n">AUTH_KEY</span><span class="p">,</span> <span class="n">sign_secret</span><span class="o">=</span><span class="n">SIGN_SECRET</span><span class="p">)</span>
919923
</span></code></pre></div>
920924
<p>Besides the <code>microgrid_id</code>, <code>component_id</code>s, <code>metrics</code>, start, and end time,
921925
you can also set the sampling period for resampling using the <code>resampling_period</code>
@@ -1006,15 +1010,16 @@ <h2 id="command-line-client-tool">Command line client tool<a class="headerlink"
10061010
microgrid component data from the reporting API.
10071011
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>reporting-cli<span class="w"> </span><span class="se">\</span>
10081012
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span>--url<span class="w"> </span>localhost:4711<span class="w"> </span><span class="se">\</span>
1009-
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span>--key<span class="o">=</span><span class="k">$(</span>&lt;api_key.txt<span class="k">)</span>
1010-
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span>--mid<span class="w"> </span><span class="m">42</span><span class="w"> </span><span class="se">\</span>
1011-
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span>--cid<span class="w"> </span><span class="m">23</span><span class="w"> </span><span class="se">\</span>
1012-
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span>--metrics<span class="w"> </span>AC_ACTIVE_POWER<span class="w"> </span>AC_REACTIVE_POWER<span class="w"> </span><span class="se">\</span>
1013-
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span>--start<span class="w"> </span><span class="m">2024</span>-05-01T00:00:00<span class="w"> </span><span class="se">\</span>
1014-
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span>--end<span class="w"> </span><span class="m">2024</span>-05-02T00:00:00<span class="w"> </span><span class="se">\</span>
1015-
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span>--format<span class="w"> </span>csv<span class="w"> </span><span class="se">\</span>
1016-
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span>--states<span class="w"> </span><span class="se">\</span>
1017-
</span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="w"> </span>--bounds
1013+
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span>--auth_key<span class="o">=</span><span class="nv">$AUTH_KEY</span>
1014+
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span>--sign_secret<span class="o">=</span><span class="nv">$SIGN_SECRET</span>
1015+
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span>--mid<span class="w"> </span><span class="m">42</span><span class="w"> </span><span class="se">\</span>
1016+
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span>--cid<span class="w"> </span><span class="m">23</span><span class="w"> </span><span class="se">\</span>
1017+
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span>--metrics<span class="w"> </span>AC_ACTIVE_POWER<span class="w"> </span>AC_REACTIVE_POWER<span class="w"> </span><span class="se">\</span>
1018+
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span>--start<span class="w"> </span><span class="m">2024</span>-05-01T00:00:00<span class="w"> </span><span class="se">\</span>
1019+
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span>--end<span class="w"> </span><span class="m">2024</span>-05-02T00:00:00<span class="w"> </span><span class="se">\</span>
1020+
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span>--format<span class="w"> </span>csv<span class="w"> </span><span class="se">\</span>
1021+
</span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="w"> </span>--states<span class="w"> </span><span class="se">\</span>
1022+
</span><span id="__span-7-12"><a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a><span class="w"> </span>--bounds
10181023
</span></code></pre></div>
10191024
In addition to the default CSV format the data can be output as individual samples or in <code>dict</code> format.</p>
10201025

‎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.

‎versions.json‎

Lines changed: 178 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,178 @@
1-
[{"version":"v0.18-dev","title":"v0.18-dev (8de3818)","aliases":["latest-dev","v0-dev"]},{"version":"v0.17-dev","title":"v0.17-dev (9e0cf82)","aliases":[]},{"version":"v0.17","title":"v0.17.1","aliases":["latest","v0"]},{"version":"v0.16-dev","title":"v0.16-dev (f0e0275)","aliases":[]},{"version":"v0.16","title":"v0.16.0","aliases":[]},{"version":"v0.15-dev","title":"v0.15-dev (f529ed8)","aliases":[]},{"version":"v0.15","title":"v0.15.0","aliases":[]},{"version":"v0.14-dev","title":"v0.14-dev (1bd0550)","aliases":[]},{"version":"v0.14","title":"v0.14.0","aliases":[]},{"version":"v0.13-dev","title":"v0.13-dev (96813f7)","aliases":[]},{"version":"v0.13","title":"v0.13.1","aliases":[]},{"version":"v0.12-dev","title":"v0.12-dev (e011e8b)","aliases":[]},{"version":"v0.12","title":"v0.12.0","aliases":[]},{"version":"v0.11-dev","title":"v0.11-dev (a860ac2)","aliases":[]},{"version":"v0.11","title":"v0.11.0","aliases":[]},{"version":"v0.10-dev","title":"v0.10-dev (f67f0f2)","aliases":[]},{"version":"v0.10","title":"v0.10.0","aliases":[]},{"version":"v0.9-dev","title":"v0.9-dev (e1617f3)","aliases":[]},{"version":"v0.9","title":"v0.9.0","aliases":[]},{"version":"v0.8-dev","title":"v0.8-dev (d1f306b)","aliases":[]},{"version":"v0.8","title":"v0.8.0","aliases":[]},{"version":"v0.7-dev","title":"v0.7-dev (df82745)","aliases":[]},{"version":"v0.7","title":"v0.7.0","aliases":[]},{"version":"v0.6-dev","title":"v0.6-dev (d22243a)","aliases":[]},{"version":"v0.6","title":"v0.6.0","aliases":[]},{"version":"v0.5-dev","title":"v0.5-dev (df5fec8)","aliases":[]},{"version":"v0.5","title":"v0.5.0","aliases":[]},{"version":"v0.4-dev","title":"v0.4-dev (9a33bf6)","aliases":[]},{"version":"v0.4","title":"v0.4.0","aliases":[]},{"version":"v0.3-dev","title":"v0.3-dev (e11ce65)","aliases":[]},{"version":"v0.3","title":"v0.3.0","aliases":[]},{"version":"v0.2-dev","title":"v0.2-dev (fff8cf4)","aliases":[]},{"version":"v0.2","title":"v0.2.0","aliases":[]},{"version":"v0.1","title":"v0.1.0","aliases":[]}]
1+
[
2+
{
3+
"version": "v0.18-dev",
4+
"title": "v0.18-dev (33e2353)",
5+
"aliases": [
6+
"v0-dev",
7+
"latest-dev"
8+
]
9+
},
10+
{
11+
"version": "v0.17",
12+
"title": "v0.17.1",
13+
"aliases": [
14+
"v0",
15+
"latest"
16+
]
17+
},
18+
{
19+
"version": "v0.17-dev",
20+
"title": "v0.17-dev (9e0cf82)",
21+
"aliases": []
22+
},
23+
{
24+
"version": "v0.16",
25+
"title": "v0.16.0",
26+
"aliases": []
27+
},
28+
{
29+
"version": "v0.16-dev",
30+
"title": "v0.16-dev (f0e0275)",
31+
"aliases": []
32+
},
33+
{
34+
"version": "v0.15",
35+
"title": "v0.15.0",
36+
"aliases": []
37+
},
38+
{
39+
"version": "v0.15-dev",
40+
"title": "v0.15-dev (f529ed8)",
41+
"aliases": []
42+
},
43+
{
44+
"version": "v0.14",
45+
"title": "v0.14.0",
46+
"aliases": []
47+
},
48+
{
49+
"version": "v0.14-dev",
50+
"title": "v0.14-dev (1bd0550)",
51+
"aliases": []
52+
},
53+
{
54+
"version": "v0.13",
55+
"title": "v0.13.1",
56+
"aliases": []
57+
},
58+
{
59+
"version": "v0.13-dev",
60+
"title": "v0.13-dev (96813f7)",
61+
"aliases": []
62+
},
63+
{
64+
"version": "v0.12",
65+
"title": "v0.12.0",
66+
"aliases": []
67+
},
68+
{
69+
"version": "v0.12-dev",
70+
"title": "v0.12-dev (e011e8b)",
71+
"aliases": []
72+
},
73+
{
74+
"version": "v0.11",
75+
"title": "v0.11.0",
76+
"aliases": []
77+
},
78+
{
79+
"version": "v0.11-dev",
80+
"title": "v0.11-dev (a860ac2)",
81+
"aliases": []
82+
},
83+
{
84+
"version": "v0.10",
85+
"title": "v0.10.0",
86+
"aliases": []
87+
},
88+
{
89+
"version": "v0.10-dev",
90+
"title": "v0.10-dev (f67f0f2)",
91+
"aliases": []
92+
},
93+
{
94+
"version": "v0.9",
95+
"title": "v0.9.0",
96+
"aliases": []
97+
},
98+
{
99+
"version": "v0.9-dev",
100+
"title": "v0.9-dev (e1617f3)",
101+
"aliases": []
102+
},
103+
{
104+
"version": "v0.8",
105+
"title": "v0.8.0",
106+
"aliases": []
107+
},
108+
{
109+
"version": "v0.8-dev",
110+
"title": "v0.8-dev (d1f306b)",
111+
"aliases": []
112+
},
113+
{
114+
"version": "v0.7",
115+
"title": "v0.7.0",
116+
"aliases": []
117+
},
118+
{
119+
"version": "v0.7-dev",
120+
"title": "v0.7-dev (df82745)",
121+
"aliases": []
122+
},
123+
{
124+
"version": "v0.6",
125+
"title": "v0.6.0",
126+
"aliases": []
127+
},
128+
{
129+
"version": "v0.6-dev",
130+
"title": "v0.6-dev (d22243a)",
131+
"aliases": []
132+
},
133+
{
134+
"version": "v0.5",
135+
"title": "v0.5.0",
136+
"aliases": []
137+
},
138+
{
139+
"version": "v0.5-dev",
140+
"title": "v0.5-dev (df5fec8)",
141+
"aliases": []
142+
},
143+
{
144+
"version": "v0.4",
145+
"title": "v0.4.0",
146+
"aliases": []
147+
},
148+
{
149+
"version": "v0.4-dev",
150+
"title": "v0.4-dev (9a33bf6)",
151+
"aliases": []
152+
},
153+
{
154+
"version": "v0.3",
155+
"title": "v0.3.0",
156+
"aliases": []
157+
},
158+
{
159+
"version": "v0.3-dev",
160+
"title": "v0.3-dev (e11ce65)",
161+
"aliases": []
162+
},
163+
{
164+
"version": "v0.2",
165+
"title": "v0.2.0",
166+
"aliases": []
167+
},
168+
{
169+
"version": "v0.2-dev",
170+
"title": "v0.2-dev (fff8cf4)",
171+
"aliases": []
172+
},
173+
{
174+
"version": "v0.1",
175+
"title": "v0.1.0",
176+
"aliases": []
177+
}
178+
]

0 commit comments

Comments
 (0)