Protocol Documentation

Table of Contents

• frequenz/api/microgrid/sensor.proto

  • Data
  • Error
  • Metadata
  • Properties
  • Sensor
  • SensorData

  • State

  • ComponentState

  • ErrorCode
  • SensorMetric

• Scalar Value Types

Top

frequenz/api/microgrid/sensor.proto

Data

Sensor data.

Field	Type	Label	Description
sensor_data	SensorData	repeated	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 sensor metadata.

Field	Type	Label	Description
type	frequenz.api.common.components.SensorType		The sensor type.

Properties

Sensor properties.

Field	Type	Label	Description
firmware_ver	string		The firmware version of the component.

Sensor

Sensor details

Field	Type	Label	Description
properties	Properties		The component properties
state	State		The sensor's state.
errors	Error	repeated	A list of errors encountered the component. An empty list implies no error.
data	Data		Sensor data object.

SensorData

A value of a single metric.

Field	Type	Label	Description
value	float		The metric value.
sensor_metric	SensorMetric		The metric name.

State

State message.

Field	Type	Label	Description
component_state	ComponentState		The state of the overall component.

ComponentState

Enumerated sensor states.

Name	Number	Description
COMPONENT_STATE_UNSPECIFIED	0	Unspecified state.
COMPONENT_STATE_OK	1	The sensor is behaving as expected.
COMPONENT_STATE_ERROR	2	The sensor is in an error state.

ErrorCode

Enumerated sensor error codes.

Name	Number	Description
ERROR_CODE_UNSPECIFIED	0	Unspecified.

SensorMetric

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

Name	Number	Description
SENSOR_METRIC_UNSPECIFIED	0	Unspecified.
SENSOR_METRIC_TEMPERATURE	1	Temperature. In Celsius (°C).
SENSOR_METRIC_HUMIDITY	2	Humidity In percentage (%).
SENSOR_METRIC_PRESSURE	3	Pressure In Pascal (Pa).
SENSOR_METRIC_IRRADIANCE	4	Irradiance / Radiation flux In watts per square meter (W / m^2).
SENSOR_METRIC_VELOCITY	5	Velocity In meters per second (m / s).
SENSOR_METRIC_ACCELERATION	6	Acceleration. In meters per second per second (m / s^2)
SENSOR_METRIC_ANGLE	7	Metric to represent angles, for metrics like direction. In angles with respect to the (magnetic) North (°).
SENSOR_METRIC_DEW_POINT	8	Dew point. The temperature at which the air becomes saturated with water vapor.

In Celsius (°C). |

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)