GtDispatchBooleanLocal¶
Python pydantic class corresponding to json type gt.dispatch.boolean.local, version 110.
- class gwproto.types.GtDispatchBooleanLocal(*, RelayState, AboutNodeName, FromNodeName, SendTimeUnixMs, TypeName='gt.dispatch.boolean.local', Version='110')¶
Dispatch message sent locally by SCADA HomeAlone actor.
By Locally, this means sent without access to Internet. The HomeAlone actor must reside within the Local Area Network of the SCADA - typically it should reside on the same hardware.
- Parameters:
RelayState (int)
AboutNodeName (str)
FromNodeName (str)
SendTimeUnixMs (int)
TypeName (Literal['gt.dispatch.boolean.local'])
Version (Literal['110'])
- as_dict()¶
Translate the object into a dictionary representation that can be serialized into a gt.dispatch.boolean.local.110 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.dispatch.boolean.local.110 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.dispatch.boolean.local.110 representation.
Instances in the class are python-native representations of gt.dispatch.boolean.local.110 objects, while the actual gt.dispatch.boolean.local.110 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 GtDispatchBooleanLocal.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
- RelayState:
Description: Relay State (0 or 1). A Relay State of 0 indicates the relay is OPEN (off). A Relay State of 1 indicates the relay is CLOSED (on). Note that 0 means the relay is open whether or not the relay is normally open or normally closed (For a normally open relay, the relay is ENERGIZED when it is in state 0 and DE-ENERGIZED when it is in state 1.)
Format: Bit
- AboutNodeName:
Description: About Node Name. The boolean actuator Spaceheat Node getting turned on or off.
Format: LeftRightDot
- FromNodeName:
Description: From Node Name. The Spaceheat Node sending the command.
Format: LeftRightDot
- SendTimeUnixMs:
Description: Send Time in Unix Milliseconds.
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_dispatch_boolean_local.check_is_bit(v)¶
Checks Bit format
Bit format: The value must be the integer 0 or the integer 1.
Will not attempt to first interpret as an integer. For example, 1.3 will not be interpreted as 1 but will raise an error.
- Parameters:
v (int) – the candidate
- Raises:
ValueError – if v is not 0 or 1
- class gwproto.types.gt_dispatch_boolean_local.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_dispatch_boolean_local.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.GtDispatchBooleanLocal_Maker(relay_state, about_node_name, from_node_name, send_time_unix_ms)¶
- Parameters:
relay_state (int)
about_node_name (str)
from_node_name (str)
send_time_unix_ms (int)
- classmethod dict_to_tuple(d)¶
Deserialize a dictionary representation of a gt.dispatch.boolean.local.110 message object into a GtDispatchBooleanLocal python object for internal use.
- This is the near-inverse of the GtDispatchBooleanLocal.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 GtDispatchBooleanLocal object.
- Returns:
GtDispatchBooleanLocal
- Return type:
- classmethod tuple_to_type(tpl)¶
Given a Python class object, returns the serialized JSON type object.
- Parameters:
tpl (GtDispatchBooleanLocal)
- Return type:
bytes
- classmethod type_to_tuple(t)¶
Given a serialized JSON type object, returns the Python class object.
- Parameters:
t (bytes)
- Return type: