enhomie.ubiquiti package

Subpackages

• enhomie.ubiquiti.params package
  • Subpackages
    • enhomie.ubiquiti.params.plugins package
      • Submodules
      • enhomie.ubiquiti.params.plugins.client module
      • Module contents
  • Submodules
  • enhomie.ubiquiti.params.origin module
    • UbiqOriginParams
      • UbiqOriginParams.router
  • Module contents
    • DriverUbiqClientParams
      • DriverUbiqClientParams.clients
      • DriverUbiqClientParams.since
    • UbiqOriginParams
      • UbiqOriginParams.router
• enhomie.ubiquiti.plugins package
  • Subpackages
    • enhomie.ubiquiti.plugins.test package
      • Submodules
      • enhomie.ubiquiti.plugins.test.test_client module
      • enhomie.ubiquiti.plugins.test.test_helpers module
      • Module contents
  • Submodules
  • enhomie.ubiquiti.plugins.client module
    • DriverUbiqClient
      • DriverUbiqClient.family
      • DriverUbiqClient.kinds
      • DriverUbiqClient.params
      • DriverUbiqClient.validate()
      • DriverUbiqClient.where()
  • enhomie.ubiquiti.plugins.helpers module
    • ubiq_latest()
  • Module contents
    • DriverUbiqClient
      • DriverUbiqClient.family
      • DriverUbiqClient.kinds
      • DriverUbiqClient.params
      • DriverUbiqClient.validate()
      • DriverUbiqClient.where()
    • ubiq_latest()
• enhomie.ubiquiti.test package
  • Submodules
  • enhomie.ubiquiti.test.test_device module
    • test_UbiqDevice()
  • enhomie.ubiquiti.test.test_models module
    • test_UbiqModels_cover()
  • enhomie.ubiquiti.test.test_origin module
    • test_UbiqOrigin()
    • test_UbiqOrigin_source()
    • test_UbiqOrigin_update()
  • enhomie.ubiquiti.test.test_update module
    • test_UbiqUpdateItem()
  • Module contents
    • mock_ubiq()

Submodules

enhomie.ubiquiti.device 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.device.UbiqDevice(homie: Homie, name: str, params: HomieChildParams)

Bases: HomieDevice

Contain the relevant attributes from the related source.

property family: Literal['ubiquiti']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

enhomie.ubiquiti.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.helpers.merge_fetch(fetch: dict[str, Any]) → dict[str, dict[str, Any]]

Return the content related to the item in parent system.

Parameters:

fetch – Dictionary from the origin to be updated.

Returns:

Content related to the item in parent system.

enhomie.ubiquiti.helpers.merge_find(merge: dict[str, dict[str, Any]], kind: HomieKinds | None = None, unique: str | None = None, label: str | None = None) → list[dict[str, Any]]

Return the content related to the item in parent system.

Parameters:

• merge – Dictionary from the origin to be updated.

• kind – Which kind of Homie object will be located.

• unique – Unique identifier within parents system.

• label – Friendly name or label within the parent.

Returns:

Content related to the item in parent system.

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

Bases: object

Return the class object that was imported within method.

Note

These are used with the Homie Automate Jinja2 parser.

classmethod latest() → Callable[[...], Any]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

class enhomie.ubiquiti.models.UbiqDriverModels

Bases: object

Return the class object that was imported within method.

classmethod client() → Type[DriverUbiqClientParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod helpers() → Type[UbiqDriverHelpers]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

class enhomie.ubiquiti.models.UbiqModels

Bases: object

Return the class object that was imported within method.

classmethod drivers() → Type[UbiqDriverModels]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod origin() → Type[UbiqOriginParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod update() → Type[UbiqUpdateItem]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

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

class enhomie.ubiquiti.origin.UbiqOrigin(*args: Any, **kwargs: Any)

Bases: HomieOrigin

Contain the relevant attributes from the related source.

property family: Literal['ubiquiti']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property fetch: dict[str, Any] | None

Return the content related to the item in parent system.

Returns:

Content related to the item in parent system.

get_update() → HomieUpdateItem

Return the new item containing information for operation.

Returns:

New item containing information for operation.

property merge: dict[str, dict[str, Any]] | None

Return the content related to the item in parent system.

Returns:

Content related to the item in parent system.

refresh(timeout: int | None = None) → bool

Refresh the cached information for the remote upstream.

Parameters:

timeout – Timeout waiting for the server response.

Returns:

Boolean indicating the success of the refresh.

property router: Router

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

set_update(uitem: HomieUpdateBase) → bool

Replace or update internal configuration with provided.

Parameters:

uitem – Item containing information for operation.

Returns:

Boolean indicating whether or not was changed.

source(kind: HomieKinds | None = None, unique: str | None = None, label: str | None = None, relate: HomieActionNode | None = None) → dict[str, Any] | None

Return the content related to the item in parent system.

Note

This method is redundant with other origin classes.

Parameters:

• kind – Which kind of Homie object will be located.

• unique – Unique identifier within parents system.

• label – Friendly name or label within the parent.

• relate – Child class instance for Homie Automate.

Returns:

Content related to the item in parent system.

enhomie.ubiquiti.update 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.update.UbiqUpdate(*args: Any, **kwargs: Any)

Bases: HomieUpdate

Common methods and routines for Homie Automate threads.

class enhomie.ubiquiti.update.UbiqUpdateItem(origin: HomieOrigin, fetch: dict[str, Any])

Bases: HomieUpdateItem

Contain information for sharing using the Python queue.

fetch: dict[str, Any]

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.DriverUbiqClient(plugin: HomiePlugin, params: HomieParamsModel)

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

Perform advanced validation on the parameters provided.

where(time: Time) → bool

Return the boolean indicating the conditional outcomes.

Parameters:

time – Time that will be used in the conditionals.

Returns:

Boolean indicating the conditional outcomes.

class enhomie.ubiquiti.UbiqDevice(homie: Homie, name: str, params: HomieChildParams)

Bases: HomieDevice

Contain the relevant attributes from the related source.

property family: Literal['ubiquiti']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

class enhomie.ubiquiti.UbiqModels

Bases: object

Return the class object that was imported within method.

classmethod drivers() → Type[UbiqDriverModels]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod origin() → Type[UbiqOriginParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod update() → Type[UbiqUpdateItem]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

class enhomie.ubiquiti.UbiqOrigin(*args: Any, **kwargs: Any)

Bases: HomieOrigin

Contain the relevant attributes from the related source.

property family: Literal['ubiquiti']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property fetch: dict[str, Any] | None

Return the content related to the item in parent system.

Returns:

Content related to the item in parent system.

get_update() → HomieUpdateItem

Return the new item containing information for operation.

Returns:

New item containing information for operation.

property merge: dict[str, dict[str, Any]] | None

Return the content related to the item in parent system.

Returns:

Content related to the item in parent system.

refresh(timeout: int | None = None) → bool

Refresh the cached information for the remote upstream.

Parameters:

timeout – Timeout waiting for the server response.

Returns:

Boolean indicating the success of the refresh.

property router: Router

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

set_update(uitem: HomieUpdateBase) → bool

Replace or update internal configuration with provided.

Parameters:

uitem – Item containing information for operation.

Returns:

Boolean indicating whether or not was changed.

source(kind: HomieKinds | None = None, unique: str | None = None, label: str | None = None, relate: HomieActionNode | None = None) → dict[str, Any] | None

Return the content related to the item in parent system.

Note

This method is redundant with other origin classes.

Parameters:

• kind – Which kind of Homie object will be located.

• unique – Unique identifier within parents system.

• label – Friendly name or label within the parent.

• relate – Child class instance for Homie Automate.

Returns:

Content related to the item in parent system.

class enhomie.ubiquiti.UbiqUpdate(*args: Any, **kwargs: Any)

Bases: HomieUpdate

Common methods and routines for Homie Automate threads.