TelemetrySnapshotSpaceheat

Python pydantic class corresponding to json type telemetry.snapshot.spaceheat, version 000.

class gwproto.types.TelemetrySnapshotSpaceheat(*, ReportTimeUnixMs, AboutNodeAliasList, ValueList, TelemetryNameList, TypeName='telemetry.snapshot.spaceheat', Version='000')

Snapshot of Telemetry Data from a SpaceHeat SCADA.

A snapshot of all current sensed states, sent from a spaceheat SCADA to its AtomicTNode. The nth element of each of the three lists refer to the same reading (i.e., what is getting read, what the value is, what the TelemetryNames are.)

[More info](https://gridworks-protocol.readthedocs.io/en/latest/spaceheat-node.html)

Parameters:

  • ReportTimeUnixMs (int)

  • AboutNodeAliasList (List[str])

  • ValueList (List[int])

  • TelemetryNameList (List[TelemetryName])

  • TypeName (Literal['telemetry.snapshot.spaceheat'])

  • Version (Literal['000'])

as_dict()

Translate the object into a dictionary representation that can be serialized into a telemetry.snapshot.spaceheat.000 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 telemetry.snapshot.spaceheat.000 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 telemetry.snapshot.spaceheat.000 representation.

Instances in the class are python-native representations of telemetry.snapshot.spaceheat.000 objects, while the actual telemetry.snapshot.spaceheat.000 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 TelemetrySnapshotSpaceheat.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

classmethod check_axiom_1(v)

Axiom 1: ListLengthConsistency. AboutNodeAliasList, ValueList and TelemetryNameList must all have the same length.

Parameters:

v (dict)

Return type:

dict

ReportTimeUnixMs:

  • Description: ReportTimeUnixMs. The time, in unix ms, that the SCADA creates this type. It may not be when the SCADA sends the type to the atn (for example if Internet is down).

  • Format: ReasonableUnixTimeMs

AboutNodeAliasList:

  • Description: AboutNodeAliases. The list of Spaceheat nodes in the snapshot.

  • Format: LeftRightDot

ValueList:

  • Description: ValueList.

TelemetryNameList:

  • Description:

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.telemetry_snapshot_spaceheat.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.telemetry_snapshot_spaceheat.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.TelemetrySnapshotSpaceheat_Maker(report_time_unix_ms, about_node_alias_list, value_list, telemetry_name_list)
Parameters:

  • report_time_unix_ms (int)

  • about_node_alias_list (List[str])

  • value_list (List[int])

  • telemetry_name_list (List[TelemetryName])

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a telemetry.snapshot.spaceheat.000 message object into a TelemetrySnapshotSpaceheat python object for internal use.

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

Returns:

TelemetrySnapshotSpaceheat

Return type:

TelemetrySnapshotSpaceheat

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (TelemetrySnapshotSpaceheat)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

TelemetrySnapshotSpaceheat