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

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.origin.UbiqOriginParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Show JSON schema

{
   "title": "UbiqOriginParams",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {
      "router": {
         "$ref": "#/$defs/RouterParams",
         "description": "Connection specific parameters"
      }
   },
   "$defs": {
      "RouterParams": {
         "additionalProperties": false,
         "description": "Process and validate the class configuration parameters.",
         "properties": {
            "server": {
               "description": "Server address for connection",
               "minLength": 1,
               "title": "Server",
               "type": "string"
            },
            "timeout": {
               "default": 30,
               "description": "Timeout connecting to server",
               "maximum": 300,
               "minimum": 1,
               "title": "Timeout",
               "type": "integer"
            },
            "username": {
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Username",
               "type": "string"
            },
            "password": {
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Password",
               "type": "string"
            },
            "site": {
               "default": "default",
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Site",
               "type": "string"
            },
            "ssl_verify": {
               "default": true,
               "description": "Verify the ceritifcate valid",
               "title": "Ssl Verify",
               "type": "boolean"
            },
            "ssl_capem": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Verify the ceritifcate valid",
               "title": "Ssl Capem"
            }
         },
         "required": [
            "server",
            "username",
            "password"
         ],
         "title": "RouterParams",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "router"
   ]
}

Config:

• extra: str = forbid

Fields:

• router (enconnect.ubiquiti.params.RouterParams)

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

Connection specific parameters

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.DriverUbiqClientParams

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:

• clients (list[str])

• since (int)

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

pydantic model enhomie.ubiquiti.params.UbiqOriginParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Show JSON schema

{
   "title": "UbiqOriginParams",
   "description": "Process and validate the Homie configuration parameters.",
   "type": "object",
   "properties": {
      "router": {
         "$ref": "#/$defs/RouterParams",
         "description": "Connection specific parameters"
      }
   },
   "$defs": {
      "RouterParams": {
         "additionalProperties": false,
         "description": "Process and validate the class configuration parameters.",
         "properties": {
            "server": {
               "description": "Server address for connection",
               "minLength": 1,
               "title": "Server",
               "type": "string"
            },
            "timeout": {
               "default": 30,
               "description": "Timeout connecting to server",
               "maximum": 300,
               "minimum": 1,
               "title": "Timeout",
               "type": "integer"
            },
            "username": {
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Username",
               "type": "string"
            },
            "password": {
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Password",
               "type": "string"
            },
            "site": {
               "default": "default",
               "description": "Parameter for the integration",
               "minLength": 1,
               "title": "Site",
               "type": "string"
            },
            "ssl_verify": {
               "default": true,
               "description": "Verify the ceritifcate valid",
               "title": "Ssl Verify",
               "type": "boolean"
            },
            "ssl_capem": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Verify the ceritifcate valid",
               "title": "Ssl Capem"
            }
         },
         "required": [
            "server",
            "username",
            "password"
         ],
         "title": "RouterParams",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "router"
   ]
}

Config:

• extra: str = forbid

Fields:

• router (Annotated[enconnect.ubiquiti.params.RouterParams, FieldInfo(annotation=NoneType, required=True, description='Connection specific parameters')])

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

Connection specific parameters