enconnect.hubitat package#

Submodules#

enconnect.hubitat.bridge module#

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 params: BridgeParams#

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

property client: HTTPClient#

Return the value for the attribute from class instance.

Returns:: Value for the attribute from class instance.

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#

class enconnect.hubitat.params.BridgeParams[source]#

Bases: BaseModel

Process and validate the class configuration parameters.

Fields#
Field	Type	Required	Default	Constraints
`appid`	`int`	Yes		ge=0
`server`	`str`	Yes		min_length=1
`ssl_capem`	`str` \| `None`	No	`None`	min_length=1
`ssl_verify`	`bool`	No	`False`
`timeout`	`int`	No	`30`	ge=1, le=300
`token`	`str`	Yes		min_length=1

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

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

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

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

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

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

Module contents#

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