Data Structures for the Fridge Service.
Module Contents
API
-
orangeqs.juice.fridge.data_structures.DEFAULT_SERVICE_NAME
‘unknown’
-
class orangeqs.juice.fridge.data_structures.TemperaturePoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Temperature Point for pubsub and database update.
-
measurement: ClassVar[str]
‘temperature_measurement’
Measurement name for temperature measurement.
-
topic() → str
Return the topic for the temperature event.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
component_id: Annotated[str, tag]
None
Component ID.
-
sensor_id: Annotated[str, tag]
None
Sensor ID.
-
level: Annotated[str, tag]
‘N/A’
Level where the sensor is placed, used by only the cryostat thermometers.
-
temperature: float
None
The temperature reading from the sensor.
-
class orangeqs.juice.fridge.data_structures.PressurePoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Pressure measurement Point.
-
measurement: ClassVar[str]
‘pressure_measurement’
Measurement name for pressure measurement.
-
topic() → str
Return the topic for the pressure measurement.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
component_id: Annotated[str, tag]
None
Component ID that measured this pressure.
-
sensor_id: Annotated[str, tag]
None
Sensor ID that measured this pressure.
-
pressure: float
None
Measured pressure value.
-
unit: str
None
Unit of the pressure measurement.
-
class orangeqs.juice.fridge.data_structures.ValvesettingPoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Valve setting Point.
-
measurement: ClassVar[str]
‘valve_setting’
Measurement name for valve setting.
-
topic() → str
Return the topic for the pressure measurement.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
component_id: Annotated[str, tag]
None
Component ID containing the valve.
-
valve_id: Annotated[str, tag]
None
ID of the valve.
-
open: bool
None
Open flag of the valve.
-
class orangeqs.juice.fridge.data_structures.FlowratePoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Flowrate measurement Point.
-
measurement: ClassVar[str]
‘flowrate_measurement’
Measurement name for flowrate measurement.
-
topic() → str
Return the topic for the flowrate measurement.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
component_id: Annotated[str, tag]
None
Component ID that measured this flowrate.
-
sensor_id: Annotated[str, tag]
None
Sensor ID that measured this flowrate.
-
flowrate: float
None
Measured flowrate value.
-
unit: str
None
Unit of the flowrate measurement.
-
class orangeqs.juice.fridge.data_structures.StatusmessagePoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Status message Point.
-
measurement: ClassVar[str]
‘status_message’
Measurement name for status message.
-
topic() → str
Return the topic for the status message.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
component_id: Annotated[str, tag]
None
Component ID that generated this status message.
-
message_id: Annotated[str, tag]
None
Status message ID.
-
level: Annotated[str, tag]
None
Level of the status message (e.g., INFO, WARNING, ERROR).
-
message: str
None
The status message content.
-
class orangeqs.juice.fridge.data_structures.ComponentEnabledPoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Component enabled state Point.
-
measurement: ClassVar[str]
‘component_enabled_state’
Measurement name for component enabled state.
-
topic() → str
Return the topic for the component enabled state.
-
component_id: Annotated[str, tag]
None
Component ID.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
enabled: bool
None
Whether the component is enabled.
-
class orangeqs.juice.fridge.data_structures.PowerSettingPoint(/, **data: Any)
Bases: orangeqs.juice.messaging.Event
Power setting Point.
-
measurement: ClassVar[str]
‘power_setting’
Measurement name for power setting.
-
topic() → str
Return the topic for the power setting.
-
component_id: Annotated[str, tag]
None
Component ID.
-
service_name: Annotated[str, tag]
‘Field(…)’
Service name.
-
power_setting: float
None
The power setting of the component.
-
unit: str
None
The unit of the power setting.
-
output_power: float
None
The current power of the component.
