AtnParams

Python pydantic class corresponding to json type `atn.params`.

class gwatn.types.AtnParams(*, GNodeAlias, HomeCity='MILLINOCKET_ME', TimezoneString='US/Eastern', TypeName='atn.params', Version='000', **extra_data)

Generic AtnParams.

This is a partial type, which is expected to be satisfied by all types starting with atn.params (like atn.params.heatpumpwithbooststore). It is used to describe the generic info required for configuring an AtomicTNode.

Parameters:

  • GNodeAlias (str) –

  • HomeCity (str) –

  • TimezoneString (str) –

  • TypeName (str) –

  • Version (str) –

  • extra_data (Any) –

GNodeAlias:

  • Description:

  • Format: LeftRightDot

HomeCity:

  • Description:

TimezoneString:

  • Description:

class gwatn.types.atn_params.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.AtnParams_Maker(g_node_alias, home_city, timezone_string)
Parameters:

  • g_node_alias (str) –

  • home_city (str) –

  • timezone_string (str) –

classmethod tuple_to_type(tuple)

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

Parameters:

tuple (AtnParams) –

Return type:

str

classmethod type_to_tuple(t)

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

Parameters:

t (str) –

Return type:

AtnParams