enhomie.homie.members package

Subpackages

• enhomie.homie.members.test package
  • Submodules
  • enhomie.homie.members.test.test_actions module
    • test_HomieActions()
  • enhomie.homie.members.test.test_member module
    • test_HomieMember_cover()
  • enhomie.homie.members.test.test_restful module
    • test_HomieRestful()
  • enhomie.homie.members.test.test_streams module
    • test_HomieStreams()
  • enhomie.homie.members.test.test_updates module
    • test_HomieUpdates()
  • Module contents

Submodules

enhomie.homie.members.actions 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.homie.members.actions.HomieActions(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_actions() → None

Perform the operation related to Homie service members.

operate_aspires() → None

Perform the operation related to Homie service members.

operate_desires() → None

Perform the operation related to Homie service members.

put_actions(target: HomieActionNode, *, state: HomieState | None = None, color: str | None = None, level: int | None = None, scene: HomieScene | None = None) → None

Insert the new item containing information for operation.

Parameters:

• target – Device or group settings will be updated.

• state – Determine the state related to the target.

• color – Determine the color related to the target.

• level – Determine the level related to the target.

• scene – Determine the scene related to the target.

enhomie.homie.members.member 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.homie.members.member.HomieMember(service: HomieService)

Bases: object

Common methods and routines for Homie Automate members.

Parameters:

homie – Primary class instance for Homie Automate.

property aqueue: HomieQueue[HomieActionItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property cancel: Event

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property congest: list[tuple[str, int]]

Return the list of congested threads and members queues.

Returns:

List of congested threads and members queues.

property enqueue: list[tuple[str, int]]

Return the list of congested threads and members queues.

Returns:

List of congested threads and members queues.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

property homie: Homie

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

operate() → None

Perform the operation related to Homie service members.

operate_updates() → None

Perform the operation related to Homie service members.

property running: list[str]

Return the list of threads which are determined running.

Returns:

List of threads which are determined running.

property service: HomieService

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

soft() → None

Stop the various threads within the Homie class object.

property squeue: HomieQueue[HomieStreamItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

start() → None

Start the various threads within the Homie class object.

stop() → None

Stop the various threads within the Homie class object.

property threads: dict[str, HomieThread]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property uqueue: HomieQueue[HomieUpdateItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property vacate: Event

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property zombies: list[str]

Return the list of threads which are determined zombies.

Returns:

List of threads which are determined zombies.

enhomie.homie.members.restful 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.homie.members.restful.HomieRestful(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_updates() → None

Perform the operation related to Homie service members.

property restful: RestfulService

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property running: list[str]

Return the list of threads which are determined running.

Returns:

List of threads which are determined running.

soft() → None

Stop the various threads within the Homie class object.

stop() → None

Stop the various threads within the Homie class object.

property zombies: list[str]

Return the list of threads which are determined zombies.

Returns:

List of threads which are determined zombies.

enhomie.homie.members.streams 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.homie.members.streams.HomieStreams(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

enhomie.homie.members.updates 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.homie.members.updates.HomieUpdates(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_streams() → None

Perform the operation related to Homie service members.

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.homie.members.HomieActions(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_actions() → None

Perform the operation related to Homie service members.

operate_aspires() → None

Perform the operation related to Homie service members.

operate_desires() → None

Perform the operation related to Homie service members.

put_actions(target: HomieActionNode, *, state: HomieState | None = None, color: str | None = None, level: int | None = None, scene: HomieScene | None = None) → None

Insert the new item containing information for operation.

Parameters:

• target – Device or group settings will be updated.

• state – Determine the state related to the target.

• color – Determine the color related to the target.

• level – Determine the level related to the target.

• scene – Determine the scene related to the target.

class enhomie.homie.members.HomieMember(service: HomieService)

Bases: object

Common methods and routines for Homie Automate members.

Parameters:

homie – Primary class instance for Homie Automate.

property aqueue: HomieQueue[HomieActionItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property cancel: Event

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property congest: list[tuple[str, int]]

Return the list of congested threads and members queues.

Returns:

List of congested threads and members queues.

property enqueue: list[tuple[str, int]]

Return the list of congested threads and members queues.

Returns:

List of congested threads and members queues.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

property homie: Homie

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

operate() → None

Perform the operation related to Homie service members.

operate_updates() → None

Perform the operation related to Homie service members.

property running: list[str]

Return the list of threads which are determined running.

Returns:

List of threads which are determined running.

property service: HomieService

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

soft() → None

Stop the various threads within the Homie class object.

property squeue: HomieQueue[HomieStreamItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

start() → None

Start the various threads within the Homie class object.

stop() → None

Stop the various threads within the Homie class object.

property threads: dict[str, HomieThread]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property uqueue: HomieQueue[HomieUpdateItem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property vacate: Event

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property zombies: list[str]

Return the list of threads which are determined zombies.

Returns:

List of threads which are determined zombies.

class enhomie.homie.members.HomieRestful(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_updates() → None

Perform the operation related to Homie service members.

property restful: RestfulService

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property running: list[str]

Return the list of threads which are determined running.

Returns:

List of threads which are determined running.

soft() → None

Stop the various threads within the Homie class object.

stop() → None

Stop the various threads within the Homie class object.

property zombies: list[str]

Return the list of threads which are determined zombies.

Returns:

List of threads which are determined zombies.

class enhomie.homie.members.HomieStreams(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

class enhomie.homie.members.HomieUpdates(service: HomieService)

Bases: HomieMember

Common methods and routines for Homie Automate members.

get_thread(origin: HomieOrigin) → Type[HomieThread] | None

Return the Homie class definition for its instantiation.

Parameters:

origin – Child class instance for Homie Automate.

Returns:

Homie class definition for its instantiation.

operate() → None

Perform the operation related to Homie service members.

operate_streams() → None

Perform the operation related to Homie service members.