Matter for Home Assistant (built-in integration)

About

Matter is a built-in integration that connects Matter devices to Home Assistant over the local network. It adds many entity types, including lights, locks, climate, covers, fans, vacuums, valves, water heaters, sirens, sensors, switches and update entities. Number and select entities expose device settings such as auto-relock time, spin speed and operating mode. Lock actions cover managing users and credentials, reading lock capabilities, and checking credential slot status. Another action opens the commissioning window for 60 seconds so a device can be added to a second Matter network, and a water heater boost action is available. Setup happens in the UI, devices can be discovered on the network, and repair notices flag problems such as disabled IPv6 or a mismatched Matter Server version.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Lights
Climate
Water heaters
Fans
Covers
Valves
Locks
Vacuums
Switches
Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Enter the address

Select connection method

Use the official Matter Server Supervisor app

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsHardware faults, Network faults, Radio faults, Actuator, Door alarm, Battery alert, Boost state, Configuration status, Inflow alarm, and 18 more
ButtonsCancel boost, Pause, Reset filter condition, Resume, Self-test, Start, Stop, Temporary mute
ClimateThermostat
CoversCover
EventsButton
FansFan
LightsLight
LocksLock
NumbersAltitude above sea level, Auto-relock time, Cooking time, Detection delay, Detection threshold, Hold time, LED off intensity, LED on intensity, Occupied setback, and 16 more
SelectsClean mode, Energy management mode, Operating mode, Sound volume, Number of rinses, Spin speed, Mode, Power level (W), and 9 more
SensorsActivated carbon filter condition, Active current, Air quality, Apparent current, Auto-close time, Battery charge state, Battery type, Time remaining, and 47 more
SirensSiren
SwitchesAudible alarm enabled, Child lock, Display, Enable charging, One-touch locking, Power, Privacy mode button, Mute, and 2 more
VacuumsVacuum
ValvesValve
Water heatersWater heater

Actions

Clear lock credentialRemoves a credential from a lock.Fields: Credential index, Credential type
Clear lock userDeletes a lock user and all associated credentials. Use index 65534 to clear all users.Fields: User index
Get lock credential statusReturns the status of a credential slot on a lock.Fields: Credential index, Credential type
Get lock infoReturns lock capabilities including supported credential types, user capacity, and PIN length constraints.
Get lock usersReturns all users configured on a lock with their credentials.
Open commissioning windowAllows adding one of your devices to another Matter network by opening the commissioning window for this Matter device for 60 seconds.Fields: Device
Set lock credentialAdds or updates a credential on a lock.Fields: Credential data, Credential index, Credential type, User index, User status, User type
Set lock userCreates or updates a lock user.Fields: Credential rule, User index, User name, User type
Boost water heaterEnables water heater boost for a specific duration.Fields: Duration, Emergency boost, Temporary setpoint

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:IPv6 is disabled but required by Matter, Older version of Matter Server needed, Newer version of Matter Server needed