File tree Expand file tree Collapse file tree 4 files changed +17
-7
lines changed
proto/frequenz/api/common/v1/microgrid Expand file tree Collapse file tree 4 files changed +17
-7
lines changed Original file line number Diff line number Diff line change @@ -88,7 +88,7 @@ dependencies and run `pytest` manually.
8888python -m pip install .[dev-pytest] # included in .[dev] too
8989
9090# And for example
91- pytest tests /test_* .py
91+ pytest pytests /test_* .py
9292```
9393
9494Or you can use ` nox ` :
Original file line number Diff line number Diff line change 11# Frequenz Common API Release Notes
22
33## Summary
4+ This release:
5+ * Corrects ` SensorData ` and ` ComponentData ` doc examples
6+ to correctly reflect differences in respective values.
47
5- <!-- Here goes a general summary of what this release is about -->
68
79## Upgrading
810
Original file line number Diff line number Diff line change @@ -208,11 +208,13 @@ message ComponentConnection {
208208// {
209209// sampled_at: "2023-10-01T00:00:00Z",
210210// states: [],
211+ // warnings: [],
211212// errors: [],
212213// },
213214// {
214215// sampled_at: "2023-10-01T00:00:00Z",
215216// states: [],
217+ // warnings: [],
216218// errors: [],
217219// },
218220// ]
Original file line number Diff line number Diff line change @@ -107,29 +107,35 @@ enum SensorMetric {
107107 SENSOR_METRIC_DEW_POINT = 8 ;
108108}
109109
110- // ComponentData message aggregates multiple metrics, operational states, and
111- // errors, related to a specific microgrid component .
110+ // SensorData message aggregates multiple metrics, operational states, and
111+ // errors, related to a specific microgrid sensor .
112112//
113113// !!! example
114114// Example output of a component data message:
115115// ```
116116// {
117- // component_id : 13,
117+ // sensor_id : 13,
118118// metric_samples: [
119119// /* list of metrics for multiple timestamps */
120120// {
121121// sampled_at: "2023-10-01T00:00:00Z",
122122// metric: "METRIC_SENSOR_TEMPERATURE",
123123// sample: metric_sample_type: {simple_metric: {value: 23.5},
124- // bounds: {},
125124// },
126125// {
127126// sampled_at: "2023-10-01T00:00:00Z",
128127// metric: "METRIC_SENSOR_RELATIVE_HUMIDITY",
129128// sample: metric_sample_type: {simple_metric: {value: 23.5},
130- // bounds: {},
131129// }
130+ // ],
131+ // states: [
132+ // {
133+ // sampled_at: "2023-10-01T00:00:00Z",
134+ // states: [],
135+ // errors: [],
136+ // },
132137// ]
138+ //
133139// }
134140// ```
135141message SensorData {
You can’t perform that action at this time.
0 commit comments