EgaugeRegisterConfig

Python pydantic class corresponding to json type egauge.register.config, version 000.

class gwproto.types.EgaugeRegisterConfig(*, Address, Name, Description, Type, Denominator, Unit, TypeName='egauge.register.config', Version='000')

Used to translate eGauge’s Modbus Map.

This type captures the information provided by eGauge in its modbus csv map, when reading current, power, energy, voltage, frequency etc from an eGauge 4030.

Parameters:

  • Address (int)

  • Name (str)

  • Description (str)

  • Type (str)

  • Denominator (int)

  • Unit (str)

  • TypeName (Literal['egauge.register.config'])

  • Version (Literal['000'])

as_dict()

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

Instances in the class are python-native representations of egauge.register.config.000 objects, while the actual egauge.register.config.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 EgaugeRegisterConfig.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

Address:

  • Description: Address. EGauge’s modbus holding address. Note that the EGauge modbus map for holding address 100 will be 30100 - the ‘+30000’ indicates it is a holding address. We use the 4-digit address after the ‘3’.

Name:

  • Description: Name. The name assigned in the EGauge’s modbus map. This is configured by the user (see URL)

Description:

  • Description: Description. Again, assigned by the EGauge modbus map. Is usually ‘change in value’

Type:

  • Description: Type. EGauge’s numerical data type. Typically our power measurements are f32 ( 32-bit floating-point number). The serial number & firmware are t16 (which work to treat as 16-bit unsigned integer) and timestamps are u32 (32-bit unsigned integer).

Denominator:

  • Description: Denominator. Some of the modbus registers divide by 3.60E+06 (cumulative energy registers typically). For the power, current, voltage and phase angle the denominator is 1.

Unit:

  • Description: Unit. The EGauge unit - typically A, Hz, or W.

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.EgaugeRegisterConfig_Maker(address, name, description, type, denominator, unit)
Parameters:

  • address (int)

  • name (str)

  • description (str)

  • type (str)

  • denominator (int)

  • unit (str)

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a egauge.register.config.000 message object into a EgaugeRegisterConfig python object for internal use.

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

Returns:

EgaugeRegisterConfig

Return type:

EgaugeRegisterConfig

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (EgaugeRegisterConfig)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

EgaugeRegisterConfig