enhomie.ubiquiti.plugins package#

Subpackages#

Submodules#

enhomie.ubiquiti.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.

class enhomie.ubiquiti.plugins.client.DriverUbiqClient(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['ubiquiti']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kinds: list[HomiePluginKinds]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: DriverUbiqClientParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

where(time: Time) → bool[source]#

Return the boolean indicating the conditional outcomes.

Parameters:

time – Time that will be used in the conditionals.

Returns:

Boolean indicating the conditional outcomes.

enhomie.ubiquiti.plugins.helpers 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.

enhomie.ubiquiti.plugins.helpers.ubiq_latest(source: UbiqFetch) → Time[source]#

Return the timestamp for client association with router.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for client association with router.

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.

class enhomie.ubiquiti.plugins.DriverUbiqClient(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['ubiquiti']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kinds: list[HomiePluginKinds]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: DriverUbiqClientParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

where(time: Time) → bool[source]#

Return the boolean indicating the conditional outcomes.

Parameters:

time – Time that will be used in the conditionals.

Returns:

Boolean indicating the conditional outcomes.

enhomie.ubiquiti.plugins.ubiq_latest(source: UbiqFetch) → Time[source]#

Return the timestamp for client association with router.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for client association with router.