matterbridge-loxone

A matterbridge plugin allowing connecting Loxone devices to Matter. The plugin was mostly tested against Apple Home but should work wirh any Matter-compatible ecosystems.

As the plugin uses Loxone websocket connection, it can be used with all generations of Loxone Miniserver, including Gen.1.

Supported devices

This plugin supports the following Loxone device types

• Lightcontroller
  • on/off light
  • dimmable light
  • mood
• Switches and pushbuttons
• Any read-only component or sensor with an InfoOnlyAnalog (0 or 1 digital value) internal type (memory flags, status values, switch outputs, etc.)
• Radio button values
• Shading
• Smoke alarm
• CO sensor
• AC

Installation

Install this plugin using the matterbridge web UI by typing matterbridge-loxone into the Install plugins section and clicking the Install button.

Don't forget to restart matterbridge afterwards.

Configuration

The plugin needs to be configured before use with the following values:

• host - the IP address of the Loxone Miniserver
• port - the port of the web interface on Loxone
• username - the username to use for connecting
• passowrd - the passowrd to use for connecting
• uuidsandtypes - list of UUID's and types to map to matter devices
• logevents - when enabled, log will contain all received Loxone events, not just the ones that have been configured (careful, lot of log!)
• dumpcontrols - dumps all discovered Loxone controls and their UUIDs
• dumpstates - dumps all discovered Loxone states and their UUIDs
• debug - enables debug mode on the plugin

NOTE: Breaking changes in v2.0.0: configuration moved to a key-value approach from the simple comma-separated approach.

UUID and type mapping

The UUID and type mapping needs to be supplied in the format of:

<UUID>,<type>,<comma_separated_optionalsettings_key_value_pairs>

The plugin supports the following types |type string|mapped Matter device type|mapped Loxone device|additional aparameters|notes| |--|--|--|--|--| |contactsensor|contact sensor|any InfoOnlyDigital device (0/1 values)|none| |humidity|humidity sensor|any InfoOnlyAnalog device (numeric values)|none| |temperature|temperature sensor|any InfoOnlyAnalog device (numeric values)|none| |pressure|pressure sensor|any InfoOnlyAnalog device (numeric values)|none| |waterleak|water leak sensor|any InfoOnlyDigital device (0/1 values)|none| |motion|occupancy sensor|any InfoOnlyDigital device (0/1 values)|none| |switch|onOffSwitch|any Pushbutton or Switch device (0/1 values)|none| |button|onOffSwitch|any Pushbutton or Switch device (0/1 values)|none|switches automatically back to off after 1 second| |pushbutton|genericSwitch|any Pushbutton or Switch device (0/1 values)|none|input device only, no Home app UI| |outlet|switch (outlet)|any Pushbutton or Switch device (0/1 values)|none| |light|switch (light)|any Pushbutton or Switch device (0/1 values)|none| |switch|switch|any Pushbutton or Switch device (0/1 values)|none| |dimmer|dimmable light|LightControllerV2 circuit|none|UUID needs to be in the format <UUID>/AIxx |mood|switch (light)|LightControllerV2 mood|moodId ID of the mood|| |radio|switch|Radio|outputId output number of the radio button|| |smoke|smoke alarm|SmokeAlarm|none|| |co|CO alarm|InfoOnlyDigital device (0/1 values)|none|| |ac|airconditioner|AcControl device|none|| |shade|window covering|Window shade or roof shade device|none||

Optional settings are in the format of key=value and are separated by a comma.

Additionally, all devices support specifying remaining battery %, by adding a battery setting to the optional settings: battery=<batterystatusUUID>.

Don't forget to restart matterbridge after making a configuration change

Examples:

• 161f7bd3-0200-79f6-ffff796b564594c0,radio,outputId=2 - results in a switch that corresponds to the second output of the radio button
• 121b4263-0076-a710-ffff796b564594c0,mood,moodId=5 - results in a light that corresponds to mood with ID 5 on a light controller
• 120f23ad-02cd-14f3-ffff796b564594c0,motion,battery=1df94ed2-00f0-7c32-ffff796b564594c0 - results in an occupancy sensor with batter % remaining displayed