GtDispatchBoolean

Python pydantic class corresponding to json type `gt.dispatch.boolean`.

class gwatn.types.GtDispatchBoolean(*, AboutNodeName, ToGNodeAlias, FromGNodeAlias, FromGNodeInstanceId, RelayState, SendTimeUnixMs, TypeName='gt.dispatch.boolean', Version='110')

.

Boolean dispatch command sent over the cloud broker from one GNode (FromGNodeAlias/ FromGNodeId) to another (ToGNodeAlias). AboutNodeAlias is the node getting dispatched. It may be a GNode, but it can also be a SpaceHeatNode.

Parameters:

  • AboutNodeName (str) –

  • ToGNodeAlias (str) –

  • FromGNodeAlias (str) –

  • FromGNodeInstanceId (str) –

  • RelayState (int) –

  • SendTimeUnixMs (int) –

  • TypeName (Literal['gt.dispatch.boolean']) –

  • Version (str) –

AboutNodeName:

  • Description: The Spaceheat Node getting dispatched

  • Format: LeftRightDot

ToGNodeAlias:

  • Description: GNodeAlias of the SCADA

  • Format: LeftRightDot

FromGNodeAlias:

  • Description: GNodeAlias of AtomicTNode

  • Format: LeftRightDot

FromGNodeInstanceId:

  • Description: GNodeInstance of the AtomicTNode

  • Format: UuidCanonicalTextual

RelayState:

  • Description: 0 or 1

SendTimeUnixMs:

  • Description: Time the AtomicTNode sends the dispatch, by its clock

  • Format: ReasonableUnixTimeMs

class gwatn.types.gt_dispatch_boolean.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gwatn.types.gt_dispatch_boolean.check_is_left_right_dot(v)

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

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gwatn.types.gt_dispatch_boolean.check_is_reasonable_unix_time_ms(v)

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

Raises:

ValueError – if not ReasonableUnixTimeMs format

Parameters:

v (str) –

class gwatn.types.GtDispatchBoolean_Maker(about_node_name, to_g_node_alias, from_g_node_alias, from_g_node_instance_id, relay_state, send_time_unix_ms)
Parameters:

  • about_node_name (str) –

  • to_g_node_alias (str) –

  • from_g_node_alias (str) –

  • from_g_node_instance_id (str) –

  • relay_state (int) –

  • send_time_unix_ms (int) –

classmethod tuple_to_type(tuple)

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

Parameters:

tuple (GtDispatchBoolean) –

Return type:

str

classmethod type_to_tuple(t)

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

Parameters:

t (str) –

Return type:

GtDispatchBoolean