enconnect.hubitat package#

Subpackages#

enconnect.hubitat.test package

Submodules#

enconnect.hubitat.bridge module#

Functions and routines associated with Enasis Network Remote Connect.

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

class enconnect.hubitat.bridge.Bridge(params: BridgeParams)[source]#

Bases: object

Interact with the local service API with various methods.

Parameters:: params – Parameters used to instantiate the class.

property client: HTTPClient#

Return the value for the attribute from class instance.

Returns:: Value for the attribute from class instance.

property params: BridgeParams#

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

request(method: Literal['delete', 'get', 'post', 'patch', 'put'], path: str, params: dict[str, Any] | None = None, *, timeout: int | None = None) → Response[source]#

Return the response for upstream request to the server.

Parameters:

method – Method for operation with the API server.
path – Path for the location to upstream endpoint.
params – Optional parameters included in request.
timeout – Timeout waiting for the server response. This will override the default client instantiated.

Returns:

Response from upstream request to the server.

enconnect.hubitat.params module#

Functions and routines associated with Enasis Network Remote Connect.

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

pydantic model enconnect.hubitat.params.BridgeParams[source]#

Bases: BaseModel

Process and validate the class configuration parameters.

Show JSON schema

{
   "title": "BridgeParams",
   "description": "Process and validate the class configuration parameters.",
   "type": "object",
   "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"
      },
      "appid": {
         "description": "Parameter for the integration",
         "minimum": 0,
         "title": "Appid",
         "type": "integer"
      },
      "token": {
         "description": "Parameter for the integration",
         "minLength": 1,
         "title": "Token",
         "type": "string"
      },
      "ssl_verify": {
         "default": false,
         "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"
      }
   },
   "additionalProperties": false,
   "required": [
      "server",
      "appid",
      "token"
   ]
}

Config:

extra: str = forbid

Fields:

appid (int)
server (str)
ssl_capem (str | None)
ssl_verify (bool)
timeout (int)
token (str)

field appid: Annotated[int, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[Ge(ge=0)])] [Required]#

Parameter for the integration

Constraints:

ge = 0

field server: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Server address for connection', metadata=[MinLen(min_length=1)])] [Required]#

Server address for connection

Constraints:

min_length = 1

field ssl_capem: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Verify the ceritifcate valid', metadata=[MinLen(min_length=1)])] = None#

Verify the ceritifcate valid

Constraints:

min_length = 1

field ssl_verify: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Verify the ceritifcate valid')] = False#: Verify the ceritifcate valid

field timeout: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=30, description='Timeout connecting to server', metadata=[Ge(ge=1), Le(le=300)])] = 30#

Timeout connecting to server

Constraints:

ge = 1
le = 300

field token: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[MinLen(min_length=1)])] [Required]#

Parameter for the integration

Constraints:

min_length = 1

Module contents#

Functions and routines associated with Enasis Network Remote Connect.

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

class enconnect.hubitat.Bridge(params: BridgeParams)[source]#

Bases: object

Interact with the local service API with various methods.

Parameters:: params – Parameters used to instantiate the class.

property client: HTTPClient#

Return the value for the attribute from class instance.

Returns:: Value for the attribute from class instance.

property params: BridgeParams#

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

request(method: Literal['delete', 'get', 'post', 'patch', 'put'], path: str, params: dict[str, Any] | None = None, *, timeout: int | None = None) → Response[source]#

Return the response for upstream request to the server.

Parameters:

method – Method for operation with the API server.
path – Path for the location to upstream endpoint.
params – Optional parameters included in request.
timeout – Timeout waiting for the server response. This will override the default client instantiated.

Returns:

Response from upstream request to the server.

pydantic model enconnect.hubitat.BridgeParams[source]#

Bases: BaseModel

Process and validate the class configuration parameters.

Show JSON schema

{
   "title": "BridgeParams",
   "description": "Process and validate the class configuration parameters.",
   "type": "object",
   "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"
      },
      "appid": {
         "description": "Parameter for the integration",
         "minimum": 0,
         "title": "Appid",
         "type": "integer"
      },
      "token": {
         "description": "Parameter for the integration",
         "minLength": 1,
         "title": "Token",
         "type": "string"
      },
      "ssl_verify": {
         "default": false,
         "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"
      }
   },
   "additionalProperties": false,
   "required": [
      "server",
      "appid",
      "token"
   ]
}

Config:

extra: str = forbid

Fields:

appid (Annotated[int, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[Ge(ge=0)])])
server (Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Server address for connection', metadata=[MinLen(min_length=1)])])
ssl_capem (Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Verify the ceritifcate valid', metadata=[MinLen(min_length=1)])])
ssl_verify (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Verify the ceritifcate valid')])
timeout (Annotated[int, FieldInfo(annotation=NoneType, required=False, default=30, description='Timeout connecting to server', metadata=[Ge(ge=1), Le(le=300)])])
token (Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[MinLen(min_length=1)])])

field appid: Annotated[int, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[Ge(ge=0)])] [Required]#

Parameter for the integration

Constraints:

ge = 0

field server: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Server address for connection', metadata=[MinLen(min_length=1)])] [Required]#

Server address for connection

Constraints:

min_length = 1

field ssl_capem: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Verify the ceritifcate valid', metadata=[MinLen(min_length=1)])] = None#

Verify the ceritifcate valid

Constraints:

min_length = 1

field ssl_verify: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Verify the ceritifcate valid')] = False#: Verify the ceritifcate valid

field timeout: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=30, description='Timeout connecting to server', metadata=[Ge(ge=1), Le(le=300)])] = 30#

Timeout connecting to server

Constraints:

ge = 1
le = 300

field token: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Parameter for the integration', metadata=[MinLen(min_length=1)])] [Required]#

Parameter for the integration

Constraints:

min_length = 1

enconnect.hubitat package#

Subpackages#

Submodules#

enconnect.hubitat.bridge module#

enconnect.hubitat.params module#

Module contents#

This Page