enhomie.philips.params.plugins package

Submodules

enhomie.philips.params.plugins.button module

class enhomie.philips.params.plugins.button.DriverPhueButtonParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
events	list[Literal[‘initial_press’, ‘long_release’, ‘short_release’]] | None	No	None	min_length=1
sensor	Literal[‘button1’, ‘button2’, ‘button3’, ‘button4’]	Yes

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

events: Annotated[list[Literal['initial_press', 'long_release', 'short_release']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Events that will be matched', metadata=[MinLen(min_length=1)])]

sensor: Annotated[Literal['button1', 'button2', 'button3', 'button4'], FieldInfo(annotation=NoneType, required=True, description='Sensor that will be matched')]

enhomie.philips.params.plugins.change module

class enhomie.philips.params.plugins.change.DriverPhueChangeParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
devices	list[str]	Yes		min_length=1
sensors	list[Literal[‘button1’, ‘button2’, ‘button3’, ‘button4’, ‘contact’, ‘motion’, ‘temperature’]] | None	No	None	min_length=1
since	int	No	0	ge=0

devices: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Devices that are in scope', metadata=[MinLen(min_length=1)])]

sensors: Annotated[list[Literal['button1', 'button2', 'button3', 'button4', 'contact', 'motion', 'temperature']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Sensors that will be matched', metadata=[MinLen(min_length=1)])]

since: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=0, description='Minimum time since changed', metadata=[Ge(ge=0)])]

enhomie.philips.params.plugins.contact module

class enhomie.philips.params.plugins.contact.DriverPhueContactParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
states	list[Literal[‘contact’, ‘no_contact’]] | None	No	None	min_length=1

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['contact', 'no_contact']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]

enhomie.philips.params.plugins.motion module

class enhomie.philips.params.plugins.motion.DriverPhueMotionParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
states	list[Literal[‘motion’, ‘no_motion’]] | None	No	None	min_length=1

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['motion', 'no_motion']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]

enhomie.philips.params.plugins.scene module

class enhomie.philips.params.plugins.scene.DriverPhueSceneParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
group	str	Yes		min_length=1
scene	str	Yes		min_length=1
states	list[Literal[‘active’, ‘inactive’]] | None	No	None	min_length=1

scene: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Scene that is in scope', metadata=[MinLen(min_length=1)])]

group: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Group that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['active', 'inactive']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]

Module contents

class enhomie.philips.params.plugins.DriverPhueButtonParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
events	list[Literal[‘initial_press’, ‘long_release’, ‘short_release’]] | None	No	None	min_length=1
sensor	Literal[‘button1’, ‘button2’, ‘button3’, ‘button4’]	Yes

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

events: Annotated[list[Literal['initial_press', 'long_release', 'short_release']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Events that will be matched', metadata=[MinLen(min_length=1)])]

sensor: Annotated[Literal['button1', 'button2', 'button3', 'button4'], FieldInfo(annotation=NoneType, required=True, description='Sensor that will be matched')]

class enhomie.philips.params.plugins.DriverPhueContactParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
states	list[Literal[‘contact’, ‘no_contact’]] | None	No	None	min_length=1

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['contact', 'no_contact']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]

class enhomie.philips.params.plugins.DriverPhueMotionParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
device	str	Yes		min_length=1
states	list[Literal[‘motion’, ‘no_motion’]] | None	No	None	min_length=1

device: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Device that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['motion', 'no_motion']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]

class enhomie.philips.params.plugins.DriverPhueChangeParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
devices	list[str]	Yes		min_length=1
sensors	list[Literal[‘button1’, ‘button2’, ‘button3’, ‘button4’, ‘contact’, ‘motion’, ‘temperature’]] | None	No	None	min_length=1
since	int	No	0	ge=0

devices: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Devices that are in scope', metadata=[MinLen(min_length=1)])]

sensors: Annotated[list[Literal['button1', 'button2', 'button3', 'button4', 'contact', 'motion', 'temperature']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Sensors that will be matched', metadata=[MinLen(min_length=1)])]

since: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=0, description='Minimum time since changed', metadata=[Ge(ge=0)])]

class enhomie.philips.params.plugins.DriverPhueSceneParams

Bases: HomieParamsModel

Process and validate the Homie configuration parameters.

Fields

Field	Type	Required	Default	Constraints
group	str	Yes		min_length=1
scene	str	Yes		min_length=1
states	list[Literal[‘active’, ‘inactive’]] | None	No	None	min_length=1

scene: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Scene that is in scope', metadata=[MinLen(min_length=1)])]

group: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Group that is in scope', metadata=[MinLen(min_length=1)])]

states: Annotated[list[Literal['active', 'inactive']] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='States that will be matched', metadata=[MinLen(min_length=1)])]