Data model Every type of the S2 data model — all 36 messages and their components — with the field-by-field descriptions from the standard's own documentation.
Generated from the S2 documentation project’s structured-documentation, which that project calls “the single source of truth for other places where the data model is documented”.
Where this crate's own API documentation differs from the text below, the
difference is deliberate and carries an `E` number in the
[errata](@/docs/errata.md).
| Type | Fields | |—|—| | Commodity | 4 | | CommodityQuantity | 10 | | ControlType | 7 | | Currency | 100 | | DDBC.ActuatorDescription | 6 | | DDBC.ActuatorStatus | 7 | | DDBC.AverageDemandRateForecast | 4 | | DDBC.AverageDemandRateForecastElement | 8 | | DDBC.Instruction | 8 | | DDBC.OperationMode | 6 | | DDBC.SystemDescription | 6 | | DDBC.TimerStatus | 5 | | Duration | 0 | | EnergyManagementRole | 2 | | FRBC.ActuatorDescription | 6 | | FRBC.ActuatorStatus | 7 | | FRBC.FillLevelTargetProfile | 4 | | FRBC.FillLevelTargetProfileElement | 2 | | FRBC.Instruction | 8 | | FRBC.LeakageBehaviour | 4 | | FRBC.LeakageBehaviourElement | 2 | | FRBC.OperationMode | 4 | | FRBC.OperationModeElement | 4 | | FRBC.StorageDescription | 6 | | FRBC.StorageStatus | 3 | | FRBC.SystemDescription | 5 | | FRBC.TimerStatus | 5 | | FRBC.UsageForecast | 4 | | FRBC.UsageForecastElement | 8 | | Handshake | 4 | | HandshakeResponse | 3 | | ID | 0 | | InstructionStatus | 7 | | InstructionStatusUpdate | 5 | | NumberRange | 2 | | OMBC.Instruction | 7 | | OMBC.OperationMode | 5 | | OMBC.Status | 6 | | OMBC.SystemDescription | 6 | | OMBC.TimerStatus | 4 | | PEBC.AllowedLimitRange | 4 | | PEBC.EnergyConstraint | 8 | | PEBC.Instruction | 7 | | PEBC.PowerConstraints | 7 | | PEBC.PowerEnvelope | 3 | | PEBC.PowerEnvelopeConsequenceType | 2 | | PEBC.PowerEnvelopeElement | 3 | | PEBC.PowerEnvelopeLimitType | 2 | | PPBC.EndInterruptionInstruction | 8 | | PPBC.PowerProfileDefinition | 6 | | PPBC.PowerProfileStatus | 3 | | PPBC.PowerSequence | 5 | | PPBC.PowerSequenceContainer | 2 | | PPBC.PowerSequenceContainerStatus | 5 | | PPBC.PowerSequenceElement | 2 | | PPBC.PowerSequenceStatus | 6 | | PPBC.ScheduleInstruction | 8 | | PPBC.StartInterruptionInstruction | 8 | | PowerForecast | 4 | | PowerForecastElement | 2 | | PowerForecastValue | 8 | | PowerMeasurement | 4 | | PowerRange | 3 | | PowerValue | 2 | | ReceptionStatus | 4 | | ReceptionStatusValues | 6 | | ResourceManagerDetails | 14 | | RevokableObjects | 17 | | RevokeObject | 4 | | Role | 2 | | RoleType | 3 | | SelectControlType | 3 | | SessionRequest | 4 | | SessionRequestType | 2 | | Timer | 3 | | Transition | 8 | Commodity The Commodity type of the S2 energy flexibility standard: its fields, their types, and which are required.
CommodityQuantity Specifies the commodity and quantity a value is describing.
ControlType Describes a resource's control type(s).
Currency The currency used when this resource gives cost information.
DDBC.ActuatorDescription The DDBC.ActuatorDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.ActuatorStatus The DDBC.ActuatorStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.AverageDemandRateForecast The DDBC.AverageDemandRateForecast type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.AverageDemandRateForecastElement The DDBC.AverageDemandRateForecastElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.Instruction The DDBC.Instruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.OperationMode The DDBC.OperationMode type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.SystemDescription The DDBC.SystemDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
DDBC.TimerStatus The DDBC.TimerStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
Duration Duration in milliseconds.
EnergyManagementRole Describes whether a resource is an RM or CEM.
FRBC.ActuatorDescription The FRBC.ActuatorDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.ActuatorStatus The FRBC.ActuatorStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.FillLevelTargetProfile The FRBC.FillLevelTargetProfile type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.FillLevelTargetProfileElement The FRBC.FillLevelTargetProfileElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.Instruction The FRBC.Instruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.LeakageBehaviour The FRBC.LeakageBehaviour type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.LeakageBehaviourElement The FRBC.LeakageBehaviourElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.OperationMode The FRBC.OperationMode type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.OperationModeElement The FRBC.OperationModeElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.StorageDescription The FRBC.StorageDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.StorageStatus The FRBC.StorageStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.SystemDescription The FRBC.SystemDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.TimerStatus The FRBC.TimerStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.UsageForecast The FRBC.UsageForecast type of the S2 energy flexibility standard: its fields, their types, and which are required.
FRBC.UsageForecastElement The FRBC.UsageForecastElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
Handshake Message sent to initialize an S2 session.
HandshakeResponse Establishes the S2 protocol version to use during this S2 session.
ID Unique identifier for many S2 objects.
InstructionStatus Indicates the current status of an instruction.
InstructionStatusUpdate Message sent to indicate the status of an instruction.
NumberRange Specifies a numerical range.
OMBC.Instruction The OMBC.Instruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
OMBC.OperationMode The OMBC.OperationMode type of the S2 energy flexibility standard: its fields, their types, and which are required.
OMBC.Status The OMBC.Status type of the S2 energy flexibility standard: its fields, their types, and which are required.
OMBC.SystemDescription The OMBC.SystemDescription type of the S2 energy flexibility standard: its fields, their types, and which are required.
OMBC.TimerStatus The OMBC.TimerStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.AllowedLimitRange The PEBC.AllowedLimitRange type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.EnergyConstraint The PEBC.EnergyConstraint type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.Instruction The PEBC.Instruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.PowerConstraints The PEBC.PowerConstraints type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.PowerEnvelope The PEBC.PowerEnvelope type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.PowerEnvelopeConsequenceType The PEBC.PowerEnvelopeConsequenceType type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.PowerEnvelopeElement The PEBC.PowerEnvelopeElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
PEBC.PowerEnvelopeLimitType The PEBC.PowerEnvelopeLimitType type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.EndInterruptionInstruction The PPBC.EndInterruptionInstruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerProfileDefinition The PPBC.PowerProfileDefinition type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerProfileStatus The PPBC.PowerProfileStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerSequence The PPBC.PowerSequence type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerSequenceContainer The PPBC.PowerSequenceContainer type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerSequenceContainerStatus The PPBC.PowerSequenceContainerStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerSequenceElement The PPBC.PowerSequenceElement type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.PowerSequenceStatus The PPBC.PowerSequenceStatus type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.ScheduleInstruction The PPBC.ScheduleInstruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
PPBC.StartInterruptionInstruction The PPBC.StartInterruptionInstruction type of the S2 energy flexibility standard: its fields, their types, and which are required.
PowerForecast Forecast of the power values for a future period of time.
PowerForecastElement Specifies power forecast values valid for a duration.
PowerForecastValue Specifies the expected power value for a specific commodity/quantitiy.
PowerMeasurement Message containing one or more power measurements.
PowerRange The PowerRange type of the S2 energy flexibility standard: its fields, their types, and which are required.
PowerValue The PowerValue type of the S2 energy flexibility standard: its fields, their types, and which are required.
ReceptionStatus Indicates whether a message was received successfully.
ReceptionStatusValues Describes the reception status of a message.
ResourceManagerDetails Describes various properties of an RM.
RevokableObjects The RevokableObjects type of the S2 energy flexibility standard: its fields, their types, and which are required.
RevokeObject The RevokeObject type of the S2 energy flexibility standard: its fields, their types, and which are required.
Role Describes that a resource can consume, produce or store a commodity.
RoleType The RoleType type of the S2 energy flexibility standard: its fields, their types, and which are required.
SelectControlType Activates a Control Type for this session.
SessionRequest The SessionRequest type of the S2 energy flexibility standard: its fields, their types, and which are required.
SessionRequestType The SessionRequestType type of the S2 energy flexibility standard: its fields, their types, and which are required.
Timer The Timer type of the S2 energy flexibility standard: its fields, their types, and which are required.
Transition The Transition type of the S2 energy flexibility standard: its fields, their types, and which are required.