Skip to content

sensor_pb2

frequenz.api.microgrid.sensor_pb2 ¤

Generated protocol buffer code.

Attributes¤

frequenz.api.microgrid.sensor_pb2.COMPONENT_STATE_ERROR: ComponentState.ValueType module-attribute ¤

The sensor is in an error state.

frequenz.api.microgrid.sensor_pb2.COMPONENT_STATE_OK: ComponentState.ValueType module-attribute ¤

The sensor is behaving as expected.

frequenz.api.microgrid.sensor_pb2.COMPONENT_STATE_UNSPECIFIED: ComponentState.ValueType module-attribute ¤

Unspecified state.

frequenz.api.microgrid.sensor_pb2.ERROR_CODE_UNSPECIFIED: ErrorCode.ValueType module-attribute ¤

Unspecified.

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_ACCELERATION: SensorMetric.ValueType module-attribute ¤

Acceleration. In meters per second per second (m / s^2)

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_ANGLE: SensorMetric.ValueType module-attribute ¤

Metric to represent angles, for metrics like direction. In angles with respect to the (magnetic) North (°).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_DEW_POINT: SensorMetric.ValueType module-attribute ¤

Dew point. The temperature at which the air becomes saturated with water vapor.

In Celsius (°C).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_HUMIDITY: SensorMetric.ValueType module-attribute ¤

Humidity In percentage (%).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_IRRADIANCE: SensorMetric.ValueType module-attribute ¤

Irradiance / Radiation flux In watts per square meter (W / m^2).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_PRESSURE: SensorMetric.ValueType module-attribute ¤

Pressure In Pascal (Pa).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_TEMPERATURE: SensorMetric.ValueType module-attribute ¤

Temperature. In Celsius (°C).

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_UNSPECIFIED: SensorMetric.ValueType module-attribute ¤

Unspecified.

frequenz.api.microgrid.sensor_pb2.SENSOR_METRIC_VELOCITY: SensorMetric.ValueType module-attribute ¤

Velocity In meters per second (m / s).

Classes¤

frequenz.api.microgrid.sensor_pb2.ComponentState ¤

Bases: _ComponentState

Enumerated sensor states.

Source code in frequenz/api/microgrid/sensor_pb2.py 
44
45
  _SENSOR._serialized_end=868
# @@protoc_insertion_point(module_scope)

frequenz.api.microgrid.sensor_pb2.Data ¤

Bases: Message

Sensor data.

Attributes¤
sensor_data: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SensorData] property ¤

AC metrics of the inverter.

frequenz.api.microgrid.sensor_pb2.Error ¤

Bases: Message

Error message.

Attributes¤
code: global___ErrorCode.ValueType instance-attribute ¤

The error code.

level: frequenz.api.microgrid.common_pb2.ErrorLevel.ValueType instance-attribute ¤

The error severity level.

msg: builtins.str instance-attribute ¤

The error message.

frequenz.api.microgrid.sensor_pb2.ErrorCode ¤

Bases: _ErrorCode

Enumerated sensor error codes.

frequenz.api.microgrid.sensor_pb2.Metadata ¤

Bases: Message

The sensor metadata.

Attributes¤
type: frequenz.api.common.components_pb2.SensorType.ValueType instance-attribute ¤

The sensor type.

frequenz.api.microgrid.sensor_pb2.Properties ¤

Bases: Message

Sensor properties.

Attributes¤
firmware_ver: builtins.str instance-attribute ¤

The firmware version of the component.

frequenz.api.microgrid.sensor_pb2.Sensor ¤

Bases: Message

Sensor details

Attributes¤
data: global___Data property ¤

Sensor data object.

errors: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Error] property ¤

A list of errors encountered the component. An empty list implies no error.

properties: global___Properties property ¤

The component properties

state: global___State property ¤

The sensor's state.

frequenz.api.microgrid.sensor_pb2.SensorData ¤

Bases: Message

A value of a single metric.

Attributes¤
sensor_metric: global___SensorMetric.ValueType instance-attribute ¤

The metric name.

value: builtins.float instance-attribute ¤

The metric value.

frequenz.api.microgrid.sensor_pb2.SensorMetric ¤

Bases: _SensorMetric

The type of the metric reported in a sensor data sample.

frequenz.api.microgrid.sensor_pb2.State ¤

Bases: Message

State message.

Attributes¤
component_state: global___ComponentState.ValueType instance-attribute ¤

The state of the overall component.