components_pb2
frequenz.api.common.components_pb2
¤
Generated protocol buffer code.
Attributes¤
frequenz.api.common.components_pb2.BATTERY_TYPE_LI_ION: BatteryType.ValueType
module-attribute
¤
Li-ion batteries.
frequenz.api.common.components_pb2.BATTERY_TYPE_NA_ION: BatteryType.ValueType
module-attribute
¤
Sodium-ion batteries
frequenz.api.common.components_pb2.BATTERY_TYPE_UNSPECIFIED: BatteryType.ValueType
module-attribute
¤
Unspecified.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_BATTERY: ComponentCategory.ValueType
module-attribute
¤
A storage system for electrical energy, used by inverters.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_CHP: ComponentCategory.ValueType
module-attribute
¤
A heat and power combustion plant (CHP stands for combined heat and power).
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_CONVERTER: ComponentCategory.ValueType
module-attribute
¤
A DC-DC converter.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_CRYPTO_MINER: ComponentCategory.ValueType
module-attribute
¤
A crypto miner.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_ELECTROLYZER: ComponentCategory.ValueType
module-attribute
¤
An electrolyzer for converting water into hydrogen and oxygen.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_EV_CHARGER: ComponentCategory.ValueType
module-attribute
¤
A station for charging electrical vehicles.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_GRID: ComponentCategory.ValueType
module-attribute
¤
The point where the local microgrid is connected to the grid.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_INVERTER: ComponentCategory.ValueType
module-attribute
¤
An electricity generator, with batteries or solar energy.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_METER: ComponentCategory.ValueType
module-attribute
¤
A meter, for measuring electrical metrics, e.g., current, voltage, etc.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_PRECHARGE_MODULE: ComponentCategory.ValueType
module-attribute
¤
A precharge module. Precharging involves gradually ramping up the DC voltage to prevent any potential damage to sensitive electrical components like capacitors. While many inverters and batteries come equipped with in-built precharging mechanisms, some may lack this feature. In such cases, we need to use external precharging modules.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_RELAY: ComponentCategory.ValueType
module-attribute
¤
A relay. Relays generally have two states: open (connected) and closed (disconnected). They are generally placed in front of a component, e.g., an inverter, to control whether the component is connected to the grid or not.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_SENSOR: ComponentCategory.ValueType
module-attribute
¤
A sensor for measuring ambient metrics, e.g., temperature, humidity, etc.
frequenz.api.common.components_pb2.COMPONENT_CATEGORY_UNSPECIFIED: ComponentCategory.ValueType
module-attribute
¤
An unknown component categories, useful for error handling, and marking unknown components in a list of components with otherwise known categories.
frequenz.api.common.components_pb2.EV_CHARGER_TYPE_AC: EvChargerType.ValueType
module-attribute
¤
The EV charging station supports AC charging only.
frequenz.api.common.components_pb2.EV_CHARGER_TYPE_DC: EvChargerType.ValueType
module-attribute
¤
The EV charging station supports DC charging only.
frequenz.api.common.components_pb2.EV_CHARGER_TYPE_HYBRID: EvChargerType.ValueType
module-attribute
¤
The EV charging station supports both AC and DC.
frequenz.api.common.components_pb2.EV_CHARGER_TYPE_UNSPECIFIED: EvChargerType.ValueType
module-attribute
¤
Default type.
frequenz.api.common.components_pb2.INVERTER_TYPE_BATTERY: InverterType.ValueType
module-attribute
¤
Battery inverter.
frequenz.api.common.components_pb2.INVERTER_TYPE_HYBRID: InverterType.ValueType
module-attribute
¤
Hybrid inverter.
frequenz.api.common.components_pb2.INVERTER_TYPE_SOLAR: InverterType.ValueType
module-attribute
¤
Solar inverter.
frequenz.api.common.components_pb2.INVERTER_TYPE_UNSPECIFIED: InverterType.ValueType
module-attribute
¤
Unspecified.
frequenz.api.common.components_pb2.SENSOR_TYPE_ACCELEROMETER: SensorType.ValueType
module-attribute
¤
Accelerometers (acceleration sensor).
frequenz.api.common.components_pb2.SENSOR_TYPE_ANEMOMETER: SensorType.ValueType
module-attribute
¤
Anemometer (wind velocity and direction sensor).
frequenz.api.common.components_pb2.SENSOR_TYPE_BAROMETER: SensorType.ValueType
module-attribute
¤
Barometer (pressure sensor).
frequenz.api.common.components_pb2.SENSOR_TYPE_GENERAL: SensorType.ValueType
module-attribute
¤
General sensors, which do not fall in any of the above categories
frequenz.api.common.components_pb2.SENSOR_TYPE_HYGROMETER: SensorType.ValueType
module-attribute
¤
Hygrometer (humidity sensor)
frequenz.api.common.components_pb2.SENSOR_TYPE_PYRANOMETER: SensorType.ValueType
module-attribute
¤
Pyranometer (solar irradiance sensor).
frequenz.api.common.components_pb2.SENSOR_TYPE_THERMOMETER: SensorType.ValueType
module-attribute
¤
Thermometer (temperature sensor)
frequenz.api.common.components_pb2.SENSOR_TYPE_UNSPECIFIED: SensorType.ValueType
module-attribute
¤
Unspecified
Classes¤
frequenz.api.common.components_pb2.BatteryType
¤
Bases: _BatteryType
Enumerated battery types.
frequenz.api.common.components_pb2.ComponentCategory
¤
Bases: _ComponentCategory
Enumrated component categories.
frequenz.api.common.components_pb2.EvChargerType
¤
Bases: _EvChargerType
Enumerated EV charger types.
frequenz.api.common.components_pb2.InverterType
¤
Bases: _InverterType
Enumerated inverter types.
frequenz.api.common.components_pb2.SensorType
¤
Bases: _SensorType
Enumerated sensor types.