enhomie.ubiquiti.params package

Subpackages

• enhomie.ubiquiti.params.plugins package
  • Submodules
  • enhomie.ubiquiti.params.plugins.client module
    • DriverUbiqClientParams
      • DriverUbiqClientParams.clients
      • DriverUbiqClientParams.since
  • Module contents
    • DriverUbiqClientParams
      • DriverUbiqClientParams.clients
      • DriverUbiqClientParams.since

Submodules

enhomie.ubiquiti.params.origin module

class enhomie.ubiquiti.params.origin.UbiqOriginParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default
router	RouterParams	Yes

router: Annotated[RouterParams, FieldInfo(annotation=NoneType, required=True, description='Connection specific parameters')]

Module contents

class enhomie.ubiquiti.params.UbiqOriginParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default
router	RouterParams	Yes

router: Annotated[RouterParams, FieldInfo(annotation=NoneType, required=True, description='Connection specific parameters')]

class enhomie.ubiquiti.params.DriverUbiqClientParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
clients	list[str]	Yes		min_length=1
since	int	No	0	ge=0

clients: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Clients that are in scope', metadata=[MinLen(min_length=1)])]

since: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=0, description='Minimum time since changed', metadata=[Ge(ge=0)])]