enhomie.philips.plugins package

Subpackages

• enhomie.philips.plugins.test package
  • Submodules
  • enhomie.philips.plugins.test.test_button module
    • test_DriverPhueButton()
    • test_DriverPhueButton_cover()
  • enhomie.philips.plugins.test.test_change module
    • test_DriverPhueChange()
    • test_DriverPhueChange_cover()
  • enhomie.philips.plugins.test.test_contact module
    • test_DriverPhueContact()
    • test_DriverPhueContact_cover()
  • enhomie.philips.plugins.test.test_helpers module
    • test_phue_changed()
    • test_phue_current()
    • test_phue_sensors()
  • enhomie.philips.plugins.test.test_motion module
    • test_DriverPhueMotion()
    • test_DriverPhueMotion_cover()
  • enhomie.philips.plugins.test.test_scene module
    • test_DriverPhueScene()
    • test_DriverPhueScene_cover()
  • Module contents

Submodules

enhomie.philips.plugins.button 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.philips.plugins.button.DriverPhueButton(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

enhomie.philips.plugins.change 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.philips.plugins.change.DriverPhueChange(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

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.philips.plugins.contact 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.philips.plugins.contact.DriverPhueContact(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

enhomie.philips.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.philips.plugins.helpers.phue_changed(source: PhueFetch) → dict[str, Time | None]

Return the timestamp for the services that have changed.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for the services that have changed.

enhomie.philips.plugins.helpers.phue_current(source: PhueFetch) → dict[str, float | bool | str | None]

Return the various values for the services within scope.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Various values for the services within scope.

enhomie.philips.plugins.helpers.phue_sensors(source: PhueFetch) → dict[str, str]

Return the unique identifier for services on the device.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for the services that have changed.

enhomie.philips.plugins.motion 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.philips.plugins.motion.DriverPhueMotion(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

enhomie.philips.plugins.scene 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.philips.plugins.scene.DriverPhueScene(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

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

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

class enhomie.philips.plugins.DriverPhueChange(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

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

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

class enhomie.philips.plugins.DriverPhueMotion(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

class enhomie.philips.plugins.DriverPhueScene(plugin: HomiePlugin, params: HomieParamsModel)

Bases: HomieDriver

Match specific conditions for determining desired state.

property family: Literal['philips']

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

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

enhomie.philips.plugins.phue_changed(source: PhueFetch) → dict[str, Time | None]

Return the timestamp for the services that have changed.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for the services that have changed.

enhomie.philips.plugins.phue_current(source: PhueFetch) → dict[str, float | bool | str | None]

Return the various values for the services within scope.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Various values for the services within scope.

enhomie.philips.plugins.phue_sensors(source: PhueFetch) → dict[str, str]

Return the unique identifier for services on the device.

Parameters:

source – Dictionary of parameters from the bridge.

Returns:

Timestamp for the services that have changed.