GtShBooleanactuatorCmdStatus

Python pydantic class corresponding to json type gt.sh.booleanactuator.cmd.status, version 100.

class gwproto.types.GtShBooleanactuatorCmdStatus(*, ShNodeAlias, RelayStateCommandList, CommandTimeUnixMsList, TypeName='gt.sh.booleanactuator.cmd.status', Version='100')

Boolean Actuator Driver Command Status Package.

This is a subtype of the status message sent from a SCADA to its AtomicTNode. It contains a list of all the commands that a particular boolean actuator actor has reported as sending as actuation commands to its driver in the last transmission period (typically 5 minutes).

[More info](https://gridworks.readthedocs.io/en/latest/relay-state.html)

Parameters:

  • ShNodeAlias (str)

  • RelayStateCommandList (List[int])

  • CommandTimeUnixMsList (List[int])

  • TypeName (Literal['gt.sh.booleanactuator.cmd.status'])

  • Version (Literal['100'])

as_dict()

Translate the object into a dictionary representation that can be serialized into a gt.sh.booleanactuator.cmd.status.100 object.

This method prepares the object for serialization by the as_type method, creating a dictionary with key-value pairs that follow the requirements for an instance of the gt.sh.booleanactuator.cmd.status.100 type. Unlike the standard python dict method, it makes the following substantive changes: - Enum Values: Translates between the values used locally by the actor to the symbol sent in messages. - Removes any key-value pairs where the value is None for a clearer message, especially in cases with many optional attributes.

It also applies these changes recursively to sub-types.

Return type:

Dict[str, Any]

as_type()

Serialize to the gt.sh.booleanactuator.cmd.status.100 representation.

Instances in the class are python-native representations of gt.sh.booleanactuator.cmd.status.100 objects, while the actual gt.sh.booleanactuator.cmd.status.100 object is the serialized UTF-8 byte string designed for sending in a message.

This method calls the as_dict() method, which differs from the native python dict() in the following key ways: - Enum Values: Translates between the values used locally by the actor to the symbol sent in messages. - - Removes any key-value pairs where the value is None for a clearer message, especially in cases with many optional attributes.

It also applies these changes recursively to sub-types.

Its near-inverse is GtShBooleanactuatorCmdStatus.type_to_tuple(). If the type (or any sub-types) includes an enum, then the type_to_tuple will map an unrecognized symbol to the default enum value. This is why these two methods are only ‘near’ inverses.

Return type:

bytes

ShNodeAlias:

  • Description: SpaceheatNodeAlias. The alias of the spaceheat node that is getting actuated. For example, a.elt1.relay would likely indicate the relay for a resistive element.

  • Format: LeftRightDot

RelayStateCommandList:

  • Description: List of RelayStateCommands.

CommandTimeUnixMsList:

  • Description: List of Command Times.

  • Format: ReasonableUnixTimeMs

TypeName:

  • Description: All GridWorks Versioned Types have a fixed TypeName, which is a string of lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character, and final word NOT all Hindu-Arabic numerals.

Version:

  • Description: All GridWorks Versioned Types have a fixed version, which is a string of three Hindu-Arabic numerals.

class gwproto.types.gt_sh_booleanactuator_cmd_status.check_is_left_right_dot(v)

Checks LeftRightDot Format

LeftRightDot format: Lowercase alphanumeric words separated by periods, with the most significant word (on the left) starting with an alphabet character.

Parameters:

v (str) – the candidate

Raises:

ValueError – if v is not LeftRightDot format

class gwproto.types.gt_sh_booleanactuator_cmd_status.check_is_reasonable_unix_time_ms(v)

Checks ReasonableUnixTimeMs format

ReasonableUnixTimeMs format: unix milliseconds between Jan 1 2000 and Jan 1 3000

Parameters:

v (int) – the candidate

Raises:

ValueError – if v is not ReasonableUnixTimeMs format

class gwproto.types.GtShBooleanactuatorCmdStatus_Maker(sh_node_alias, relay_state_command_list, command_time_unix_ms_list)
Parameters:

  • sh_node_alias (str)

  • relay_state_command_list (List[int])

  • command_time_unix_ms_list (List[int])

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a gt.sh.booleanactuator.cmd.status.100 message object into a GtShBooleanactuatorCmdStatus python object for internal use.

This is the near-inverse of the GtShBooleanactuatorCmdStatus.as_dict() method:

  • Enums: translates between the symbols sent in messages between actors and

the values used by the actors internally once they’ve deserialized the messages.

  • Types: recursively validates and deserializes sub-types.

Note that if a required attribute with a default value is missing in a dict, this method will raise a SchemaError. This differs from the pydantic BaseModel practice of auto-completing missing attributes with default values when they exist.

Parameters:

d (dict) – the dictionary resulting from json.loads(t) for a serialized JSON type object t.

Raises:

SchemaError – if the dict cannot be turned into a GtShBooleanactuatorCmdStatus object.

Returns:

GtShBooleanactuatorCmdStatus

Return type:

GtShBooleanactuatorCmdStatus

classmethod tuple_to_type(tpl)

Given a Python class object, returns the serialized JSON type object.

Parameters:

tpl (GtShBooleanactuatorCmdStatus)

Return type:

bytes

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object.

Parameters:

t (bytes)

Return type:

GtShBooleanactuatorCmdStatus