homeassistant.components.matter.vacuum Namespace Reference

Classes
class	MatterVacuum
class	ModeTag
class	OperationalState

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
list	DISCOVERY_SCHEMAS

Detailed Description

Matter vacuum platform.

Function Documentation

async_setup_entry()

None homeassistant.components.matter.vacuum.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up Matter vacuum platform from Config Entry.

Definition at line 53 of file vacuum.py.

Variable Documentation

DISCOVERY_SCHEMAS

list homeassistant.components.matter.vacuum.DISCOVERY_SCHEMAS

Initial value:

=  [
    MatterDiscoverySchema(
        platform=Platform.VACUUM,
        entity_description=StateVacuumEntityDescription(
            key="MatterVacuumCleaner", name=None
        ),
        entity_class=MatterVacuum,
        required_attributes=(
            clusters.RvcRunMode.Attributes.CurrentMode,
            clusters.RvcOperationalState.Attributes.CurrentPhase,
        ),
        optional_attributes=(
            clusters.RvcCleanMode.Attributes.CurrentMode,
            clusters.PowerSource.Attributes.BatPercentRemaining,
        ),
        device_type=(device_types.RoboticVacuumCleaner,),
    ),
]

Definition at line 209 of file vacuum.py.