enhomie.builtins package

Subpackages

• enhomie.builtins.params package
  • Submodules
  • enhomie.builtins.params.period module
    • DriverBltnPeriodParams
      • DriverBltnPeriodParams.days
      • DriverBltnPeriodParams.start
      • DriverBltnPeriodParams.stop
      • DriverBltnPeriodParams.tzname
  • enhomie.builtins.params.regexp module
    • DriverBltnRegexpParams
      • DriverBltnRegexpParams.complete
      • DriverBltnRegexpParams.patterns
  • enhomie.builtins.params.store module
    • DriverBltnStoreParams
      • DriverBltnStoreParams.operator
      • DriverBltnStoreParams.unique
      • DriverBltnStoreParams.value
  • Module contents
    • DriverBltnPeriodParams
      • DriverBltnPeriodParams.days
      • DriverBltnPeriodParams.start
      • DriverBltnPeriodParams.stop
      • DriverBltnPeriodParams.tzname
    • DriverBltnRegexpParams
      • DriverBltnRegexpParams.complete
      • DriverBltnRegexpParams.patterns
    • DriverBltnStoreParams
      • DriverBltnStoreParams.operator
      • DriverBltnStoreParams.unique
      • DriverBltnStoreParams.value
• enhomie.builtins.test package
  • Submodules
  • enhomie.builtins.test.test_models module
    • test_BltnModels_cover()
  • enhomie.builtins.test.test_period module
    • test_DriverBltnPeriod()
    • test_DriverBltnPeriod_cover()
  • enhomie.builtins.test.test_regexp module
    • test_DriverBltnRegexp()
  • enhomie.builtins.test.test_store module
    • test_DriverBltnStore()
    • test_DriverBltnStore_cover()
  • Module contents

Submodules

enhomie.builtins.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.builtins.models.BltnDriverModels

Bases: object

Return the class object that was imported within method.

classmethod period() → Type[DriverBltnPeriodParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod regexp() → Type[DriverBltnRegexpParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod store() → Type[DriverBltnStoreParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

class enhomie.builtins.models.BltnModels

Bases: object

Return the class object that was imported within method.

classmethod drivers() → Type[BltnDriverModels]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

enhomie.builtins.period 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.builtins.period.DriverBltnPeriod(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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: DriverBltnPeriodParams

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.

enhomie.builtins.regexp 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.builtins.regexp.DriverBltnRegexp(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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

Return the boolean indicating the conditional outcomes.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

property params: DriverBltnRegexpParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

enhomie.builtins.store 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.builtins.store.DriverBltnStore(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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: DriverBltnStoreParams

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.

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.builtins.BltnModels

Bases: object

Return the class object that was imported within method.

classmethod drivers() → Type[BltnDriverModels]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

class enhomie.builtins.DriverBltnPeriod(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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: DriverBltnPeriodParams

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

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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

Return the boolean indicating the conditional outcomes.

Parameters:

sitem – Item containing information for operation.

Returns:

Boolean indicating the conditional outcomes.

property params: DriverBltnRegexpParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

class enhomie.builtins.DriverBltnStore(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['builtins']

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: DriverBltnStoreParams

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.