s2wsjson.generated.gen_s2

Classes

class s2wsjson.generated.gen_s2.Commodity(value)

An enumeration.

GAS = 'GAS'

HEAT = 'HEAT'

ELECTRICITY = 'ELECTRICITY'

OIL = 'OIL'

class s2wsjson.generated.gen_s2.CommodityQuantity(value)

An enumeration.

ELECTRIC_POWER_L1 = 'ELECTRIC.POWER.L1'

ELECTRIC_POWER_L2 = 'ELECTRIC.POWER.L2'

ELECTRIC_POWER_L3 = 'ELECTRIC.POWER.L3'

ELECTRIC_POWER_3_PHASE_SYMMETRIC = 'ELECTRIC.POWER.3_PHASE_SYMMETRIC'

NATURAL_GAS_FLOW_RATE = 'NATURAL_GAS.FLOW_RATE'

HYDROGEN_FLOW_RATE = 'HYDROGEN.FLOW_RATE'

HEAT_TEMPERATURE = 'HEAT.TEMPERATURE'

HEAT_FLOW_RATE = 'HEAT.FLOW_RATE'

HEAT_THERMAL_POWER = 'HEAT.THERMAL_POWER'

OIL_FLOW_RATE = 'OIL.FLOW_RATE'

class s2wsjson.generated.gen_s2.Duration(*, __root__: ConstrainedIntValue)

class s2wsjson.generated.gen_s2.FRBCActuatorDescription(*, id: ID, diagnostic_label: str | None = None, supported_commodities: ConstrainedListValue[Commodity], operation_modes: ConstrainedListValue[FRBCOperationMode], transitions: ConstrainedListValue[Transition], timers: ConstrainedListValue[Timer])

class Config

extra = 'forbid'

id: ID

diagnostic_label: str | None

supported_commodities: List[Commodity]

operation_modes: List[FRBCOperationMode]

transitions: List[Transition]

timers: List[Timer]

class s2wsjson.generated.gen_s2.FRBCOperationMode(*, id: ID, diagnostic_label: str | None = None, elements: ConstrainedListValue[FRBCOperationModeElement], abnormal_condition_only: bool)

class Config

extra = 'forbid'

id: ID

diagnostic_label: str | None

elements: List[FRBCOperationModeElement]

abnormal_condition_only: bool

class s2wsjson.generated.gen_s2.FRBCOperationModeElement(*, fill_level_range: NumberRange, fill_rate: NumberRange, power_ranges: ConstrainedListValue[PowerRange], running_costs: NumberRange | None = None)

class Config

extra = 'forbid'

fill_level_range: NumberRange

fill_rate: NumberRange

power_ranges: List[PowerRange]

running_costs: NumberRange | None

class s2wsjson.generated.gen_s2.ID(*, __root__: ConstrainedStrValue)

class s2wsjson.generated.gen_s2.NumberRange(*, start_of_range: float, end_of_range: float)

class Config

extra = 'forbid'

start_of_range: float

end_of_range: float

class s2wsjson.generated.gen_s2.PowerRange(*, start_of_range: float, end_of_range: float, commodity_quantity: CommodityQuantity)

class Config

extra = 'forbid'

start_of_range: float

end_of_range: float

commodity_quantity: CommodityQuantity

class s2wsjson.generated.gen_s2.Role(*, role: RoleType, commodity: Commodity)

class Config

extra = 'forbid'

role: RoleType

commodity: Commodity

class s2wsjson.generated.gen_s2.RoleType(value)

An enumeration.

ENERGY_PRODUCER = 'ENERGY_PRODUCER'

ENERGY_CONSUMER = 'ENERGY_CONSUMER'

ENERGY_STORAGE = 'ENERGY_STORAGE'

class s2wsjson.generated.gen_s2.Timer(*, id: ID, diagnostic_label: str | None = None, duration: Duration)

class Config

extra = 'forbid'

id: ID

diagnostic_label: str | None

duration: Duration

class s2wsjson.generated.gen_s2.Transition(*, id: ID, to: ID, start_timers: ConstrainedListValue[ID], blocking_timers: ConstrainedListValue[ID], transition_costs: float | None = None, transition_duration: Duration | None = None, abnormal_condition_only: bool, **extra_data: Any)

class Config

extra = 'forbid'

id: ID

from_: ID

to: ID

start_timers: List[ID]

blocking_timers: List[ID]

transition_costs: float | None

transition_duration: Duration | None

abnormal_condition_only: bool