enhomie.ubiquiti.params.plugins package#

Submodules#

enhomie.ubiquiti.params.plugins.client module#

Functions and routines associated with Enasis Network Homie Automate.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model enhomie.ubiquiti.params.plugins.client.DriverUbiqClientParams[source]#

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Show JSON schema
{
   "title": "DriverUbiqClientParams",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {
      "clients": {
         "description": "Clients that are in scope",
         "items": {
            "type": "string"
         },
         "minItems": 1,
         "title": "Clients",
         "type": "array"
      },
      "since": {
         "default": 0,
         "description": "Minimum time since changed",
         "minimum": 0,
         "title": "Since",
         "type": "integer"
      }
   },
   "additionalProperties": false,
   "required": [
      "clients"
   ]
}

Config:

  • extra: str = forbid

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

Clients that are in scope

Constraints:

  • min_length = 1

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

Minimum time since changed

Constraints:

  • ge = 0

Module contents#

Functions and routines associated with Enasis Network Homie Automate.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model enhomie.ubiquiti.params.plugins.DriverUbiqClientParams[source]#

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Show JSON schema
{
   "title": "DriverUbiqClientParams",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {
      "clients": {
         "description": "Clients that are in scope",
         "items": {
            "type": "string"
         },
         "minItems": 1,
         "title": "Clients",
         "type": "array"
      },
      "since": {
         "default": 0,
         "description": "Minimum time since changed",
         "minimum": 0,
         "title": "Since",
         "type": "integer"
      }
   },
   "additionalProperties": false,
   "required": [
      "clients"
   ]
}

Config:

  • extra: str = forbid

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

Clients that are in scope

Constraints:

  • min_length = 1

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

Minimum time since changed

Constraints:

  • ge = 0