Configuration

⚠️ It is recommended (and easier) to use the Homebridge UI plugin settings screen to configure the plugin. The settings screen is generated from the same source as this page, and always reflects the full, current set of options.

This page is for reference and for users who edit their configuration JSON manually.

Required Settings

Add the following to your configuration file inside the platforms array.

{
   "name": "Matter",
   "platform": "Matter"
}

• ⚠️ The "platform": "Matter" line must not be changed
• Every device this plugin exposes is enabled individually with the enable... toggles below - see the wiki's device-type pages for what each one does.

Optional Settings

Setting	Type	Default	Explanation
enableOnOffLight	boolean	false	Enable the on/off light example accessory (Matter Spec § 4.1).
enableDimmableLight	boolean	false	Enable the dimmable light example accessory (Matter Spec § 4.2).
enableColourTemperatureLight	boolean	false	Enable the colour temperature light example accessory (Matter Spec § 4.3).
enableExtendedColourLight	boolean	false	Enable the extended colour light (hue/saturation + colour temperature) example accessory (Matter Spec § 4.4).
enableOnOffOutlet	boolean	false	Enable the on/off outlet (smart plug) example accessory (Matter Spec § 5.1). Also demonstrates electrical power and energy measurement (requires Homebridge v2.2.0 or later) by simulating a 60 W load while on.
enableOnOffSwitch	boolean	false	Enable the on/off light switch example accessory (Matter Spec § 6.1).
enableGenericSwitch	boolean	false	Enable the generic switch (stateless remote/button) example accessory (Matter Spec § 6.6).
enableAirQualitySensor	boolean	false	Enable the air quality sensor example accessory (Matter Spec § 7.6). Monitors air quality, PM2.5, PM10, temperature, and humidity.
enableContactSensor	boolean	false	Enable the contact sensor example accessory (Matter Spec § 7.1).
enableLightSensor	boolean	false	Enable the light sensor example accessory (Matter Spec § 7.2).
enableOccupancySensor	boolean	false	Enable the occupancy sensor example accessory (Matter Spec § 7.3).
enableTemperatureSensor	boolean	false	Enable the temperature sensor example accessory (Matter Spec § 7.4).
enableHumiditySensor	boolean	false	Enable the humidity sensor example accessory (Matter Spec § 7.7).
enableSmokeSensor	boolean	false	Enable the smoke and carbon monoxide alarm example accessory (Matter Spec § 7.9).
smokeSensorRemoveSmokeAlarm	boolean	false	Expose a carbon-monoxide-only alarm.
smokeSensorRemoveCoAlarm	boolean	false	Expose a smoke-only alarm.
enableLeakSensor	boolean	false	Enable the water leak detector example accessory (Matter Spec § 7.12).
enableDoorLock	boolean	false	Enable the door lock example accessory (Matter Spec § 8.1).
enableWindowBlind	boolean	false	Enable the window blind example accessory (Matter Spec § 8.3).
enableVenetianBlind	boolean	false	Enable the Venetian blind with tilt control example accessory (Matter Spec § 8.3).
enableThermostat	boolean	false	Enable the thermostat example accessory (Matter Spec § 9.1).
thermostatRemoveAutoMode	boolean	false	Expose the thermostat with Heat and Cool but no Auto mode. Requires Homebridge v2.4.0 or later.
thermostatRemoveHeatMode	boolean	false	Expose a cooling-only thermostat. Requires Homebridge v2.4.0 or later.
thermostatRemoveCoolMode	boolean	false	Expose a heating-only thermostat. Requires Homebridge v2.4.0 or later.
enableFan	boolean	false	Enable the fan example accessory (Matter Spec § 9.2).
enableRobotVacuum	boolean	false	Enable the robotic vacuum cleaner example accessory (Matter Spec § 12.1). This device is automatically published on its own dedicated Matter bridge for Apple Home compatibility. You'll receive separate commissioning codes (QR code + manual code) for the robot vacuum in the Homebridge logs when Homebridge starts.
robotVacuumDirectModeChange	boolean	false	Let controllers change the clean mode while the vacuum is running, not only when it is idle (the DirectModeChange feature). Requires Homebridge v2.5.0 or later.
enableRoomAirConditioner	boolean	false	Enable the room air conditioner example accessory (Matter Spec § 13.3), with Heat, Cool and Auto modes. Requires Homebridge v2.5.0 or later.
enableWaterHeater	boolean	false	Enable the water heater example accessory (Matter Spec § 14.2), with Off, Manual and Timed modes and a boost. Requires Homebridge v2.5.0 or later. It is not yet known how Apple Home shows this device type.
enableEvCharger	boolean	false	Enable the EV charger example accessory (Matter Spec § 14.1). Requires Homebridge v2.5.0 or later. It is not yet known how Apple Home shows this device type.
enableSolarPower	boolean	false	Enable the solar power example accessory (Matter Spec § 14.3), reporting generation. Requires Homebridge v2.5.0 or later. It is not yet known how Apple Home shows this device type.
enableBatteryStorage	boolean	false	Enable the home battery example accessory (Matter Spec § 14.4). Requires Homebridge v2.5.0 or later. It is not yet known how Apple Home shows this device type.
enableElectricalMeter	boolean	false	Enable the electricity meter example accessory (Matter Spec § 14.8), reporting power and energy both ways. Requires Homebridge v2.5.0 or later. It is not yet known how Apple Home shows this device type.
enablePowerStrip	boolean	false	Enable the power strip with 4 outlets example accessory. This is a custom device demonstrating how to manage multiple logical outlets within a single Matter device.