Protocol Documentation¤
Table of Contents¤
frequenz/api/microgrid/meter.proto¤
Data¤
Meter data.
Field | Type | Label | Description |
---|---|---|---|
ac | frequenz.api.common.metrics.electrical.AC | AC metrics of the inverter. |
Error¤
Error message.
Field | Type | Label | Description |
---|---|---|---|
code | ErrorCode | The error code. | |
level | frequenz.api.microgrid.common.ErrorLevel | The error severity level. | |
msg | string | The error message. |
Metadata¤
The meter metadata.
Field | Type | Label | Description |
---|---|---|---|
type | Type | The meter type. |
Meter¤
Meter details
Field | Type | Label | Description |
---|---|---|---|
properties | Properties | The component properties | |
state | State | The meter's state. | |
errors | Error | repeated | A list of errors encountered the component. An empty list implies no error. |
data | Data | A meter data object. |
Properties¤
Meter properties.
Field | Type | Label | Description |
---|---|---|---|
firmware_ver | string | The firmware version of the component. |
State¤
State message.
Field | Type | Label | Description |
---|---|---|---|
component_state | ComponentState | The state of the overall component. |
ComponentState¤
Enumerated meter states.
Name | Number | Description |
---|---|---|
COMPONENT_STATE_UNSPECIFIED | 0 | Unspecified state. |
COMPONENT_STATE_OK | 1 | The meter is behaving as expected. |
COMPONENT_STATE_ERROR | 2 | The meter is in an error state. |
ErrorCode¤
Enumerated meter error codes.
Name | Number | Description |
---|---|---|
ERROR_CODE_UNSPECIFIED | 0 | Unspecified. |
Type¤
Enumerated meter types.
Name | Number | Description |
---|---|---|
TYPE_UNSPECIFIED | 0 | |
TYPE_PRODUCTION | 1 | AC production power meter / inverter production AC power (fallback) |
TYPE_CONSUMPTION | 2 | Consumption meter |
TYPE_FEED_IN | 3 | Exported to grid meter |
TYPE_PURCHASED | 4 | Imported power from grid meter |