PowerWatts

Python pydantic class corresponding to json type power.watts, version 000.

class gwproto.types.PowerWatts(*, Watts, TypeName='power.watts', Version='000')

Real-time power of TerminalAsset in Watts.

Used by a SCADA -> Atn or Atn -> AggregatedTNode to report real-time power of their TerminalAsset. Positive number means WITHDRAWAL from the grid - so generating electricity creates a negative number. This message is considered worse than useless to send after the first attempt, and does not require an ack. Shares the same purpose as gs.pwr, but is not designed to minimize bytes so comes in JSON format.

Parameters:

• Watts (int)

• TypeName (Literal['power.watts'])

• Version (Literal['000'])

as_dict()

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

Instances in the class are python-native representations of power.watts.000 objects, while the actual power.watts.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 PowerWatts.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

Watts:

• Description: Current Power in Watts.

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.PowerWatts_Maker(watts)

Parameters:

watts (int)

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a power.watts.000 message object into a PowerWatts python object for internal use.

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

Returns:

PowerWatts

Return type:

PowerWatts

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (PowerWatts)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

PowerWatts