enhomie.philips.plugins package#

Submodules#

enhomie.philips.plugins.button module#

class enhomie.philips.plugins.button.DriverPhueButton(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

enhomie.philips.plugins.change module#

class enhomie.philips.plugins.change.DriverPhueChange(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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.

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.philips.plugins.contact module#

class enhomie.philips.plugins.contact.DriverPhueContact(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

enhomie.philips.plugins.helpers module#

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

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_sensors(source: PhueFetch) → dict[str, str][source]#

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.helpers.phue_current(source: PhueFetch) → dict[str, float | bool | str | None][source]#

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.motion module#

class enhomie.philips.plugins.motion.DriverPhueMotion(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

enhomie.philips.plugins.scene module#

class enhomie.philips.plugins.scene.DriverPhueScene(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

Module contents#

class enhomie.philips.plugins.DriverPhueButton(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

class enhomie.philips.plugins.DriverPhueChange(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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.

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

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

class enhomie.philips.plugins.DriverPhueMotion(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

class enhomie.philips.plugins.DriverPhueScene(plugin: HomiePlugin, params: HomieParamsModel)[source]#

Bases: HomieDriver

Match specific conditions for determining desired state.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

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.

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

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

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][source]#

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.