enhomie.homie.plugins package#

Subpackages#

Submodules#

enhomie.homie.plugins.common 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.homie.plugins.driver 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.plugins.driver.HomieDriver(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: object

Match specific conditions for determining desired state.

Parameters:

  • plugin – Plugin class instance for Homie Automate.

  • params – Parameters used to instantiate the class.

property family: HomieFamily#

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.

occur(sitem: HomieStreamItem) → bool[source]#

Return the boolean indicating the conditional outcomes.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

property params: HomieParamsModel#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property plugin: HomiePlugin#

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

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.homie.plugins.occur 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.plugins.occur.HomieOccur(homie: Homie, params: HomiePluginParams)[source]#

Bases: HomiePlugin

Match specific conditions for determining desired state.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

Returns:

Homie class definition for its instantiation.

property kind: Literal['occur']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomieOccurParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

when(sitem: HomieStreamItem) → bool[source]#

Return the boolean indicating the conditional outcomes.

Note

Somewhat similar to same method within HomieWhere.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

enhomie.homie.plugins.plugin 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.plugins.plugin.HomiePlugin(homie: Homie, params: HomiePluginParams)[source]#

Bases: object

Match specific conditions for determining desired state.

Parameters:

  • homie – Primary class instance for Homie Automate.

  • params – Parameters used to instantiate the class.

property drivers: list[HomieDriver]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property family: HomieFamily#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

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.

property kind: HomiePluginKinds#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomiePluginParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

enhomie.homie.plugins.where 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.plugins.where.HomieWhere(homie: Homie, params: HomiePluginParams)[source]#

Bases: HomiePlugin

Match specific conditions for determining desired state.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

Returns:

Homie class definition for its instantiation.

property kind: Literal['where']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomieWhereParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

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

Return the boolean indicating the conditional outcomes.

Note

Somewhat similar to same method within HomieOccur.

Parameters:

time – Time that will be used in the conditionals.

Returns:

Boolean indicating the conditional outcomes.

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.plugins.HomieDriver(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: object

Match specific conditions for determining desired state.

Parameters:

  • plugin – Plugin class instance for Homie Automate.

  • params – Parameters used to instantiate the class.

property family: HomieFamily#

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.

occur(sitem: HomieStreamItem) → bool[source]#

Return the boolean indicating the conditional outcomes.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

property params: HomieParamsModel#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property plugin: HomiePlugin#

Return the Homie instance to which the instance belongs.

Returns:

Homie instance to which the instance belongs.

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.

class enhomie.homie.plugins.HomieOccur(homie: Homie, params: HomiePluginParams)[source]#

Bases: HomiePlugin

Match specific conditions for determining desired state.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

Returns:

Homie class definition for its instantiation.

property kind: Literal['occur']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomieOccurParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

when(sitem: HomieStreamItem) → bool[source]#

Return the boolean indicating the conditional outcomes.

Note

Somewhat similar to same method within HomieWhere.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

class enhomie.homie.plugins.HomiePlugin(homie: Homie, params: HomiePluginParams)[source]#

Bases: object

Match specific conditions for determining desired state.

Parameters:

  • homie – Primary class instance for Homie Automate.

  • params – Parameters used to instantiate the class.

property drivers: list[HomieDriver]#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property family: HomieFamily#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

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.

property kind: HomiePluginKinds#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomiePluginParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

class enhomie.homie.plugins.HomieWhere(homie: Homie, params: HomiePluginParams)[source]#

Bases: HomiePlugin

Match specific conditions for determining desired state.

get_drivers() → dict[str, Type[HomieDriver]][source]#

Return the Homie class definition for its instantiation.

Returns:

Homie class definition for its instantiation.

property kind: Literal['where']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: HomieWhereParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None[source]#

Perform advanced validation on the parameters provided.

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

Return the boolean indicating the conditional outcomes.

Note

Somewhat similar to same method within HomieOccur.

Parameters:

time – Time that will be used in the conditionals.

Returns:

Boolean indicating the conditional outcomes.