GtShStatus

Python pydantic class corresponding to json type gt.sh.status, version 110.

class gwproto.types.GtShStatus(*, FromGNodeAlias, FromGNodeId, AboutGNodeAlias, SlotStartUnixS, ReportingPeriodS, SimpleTelemetryList, MultipurposeTelemetryList, BooleanactuatorCmdList, StatusUid, TypeName='gt.sh.status', Version='110')

Status message sent by a Spaceheat SCADA every 5 minutes

Parameters:
as_dict()

Translate the object into a dictionary representation that can be serialized into a gt.sh.status.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.sh.status.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.sh.status.110 representation.

Instances in the class are python-native representations of gt.sh.status.110 objects, while the actual gt.sh.status.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 GtShStatus.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

FromGNodeAlias:

  • Description:

  • Format: LeftRightDot

FromGNodeId:

  • Description:

  • Format: UuidCanonicalTextual

AboutGNodeAlias:

  • Description:

  • Format: LeftRightDot

SlotStartUnixS:

  • Description:

  • Format: ReasonableUnixTimeS

ReportingPeriodS:

  • Description:

SimpleTelemetryList:

  • Description:

MultipurposeTelemetryList:

  • Description:

BooleanactuatorCmdList:

  • Description:

StatusUid:

  • Description:

  • Format: UuidCanonicalTextual

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_status.check_is_reasonable_unix_time_s(v)

Checks ReasonableUnixTimeS format

ReasonableUnixTimeS format: unix seconds between Jan 1 2000 and Jan 1 3000

Parameters:

v (int) – the candidate

Raises:

ValueError – if v is not ReasonableUnixTimeS format

class gwproto.types.gt_sh_status.check_is_uuid_canonical_textual(v)

Checks UuidCanonicalTextual format

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

Parameters:

v (str) – the candidate

Raises:

ValueError – if v is not UuidCanonicalTextual format

class gwproto.types.gt_sh_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.GtShStatus_Maker(from_g_node_alias, from_g_node_id, about_g_node_alias, slot_start_unix_s, reporting_period_s, simple_telemetry_list, multipurpose_telemetry_list, booleanactuator_cmd_list, status_uid)
Parameters:
classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a gt.sh.status.110 message object into a GtShStatus python object for internal use.

This is the near-inverse of the GtShStatus.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 GtShStatus object.

Returns:

GtShStatus

Return type:

GtShStatus

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (GtShStatus)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

GtShStatus