homebridge-loxone-cedricb
TypeScript icon, indicating that this package has built-in type declarations

2.0.2 • Public • Published

logo

npm verified-by-homebridge apache-license

Homebridge Dynamic Platform Plugin which exposes a Loxone System to Homekit.

The plugin uses Loxone Lxcommunicator to setup a websocket connection to a Loxone miniserver. It retrieves the loxone Structure-File and tries to map all items to HomeKit accessories. The websocket connection allows for realtime 2 way updates between Loxone and HomeKit.

Mapped Items

The following list displays all supported itemtypes supported by this plugin.

loxone Item HomeKit Accessory Mapping Note
Alarm SecuritySystem Auto
Brightness LightSensor Manual InfoOnlyAnalog Item. Requires a mapping.
ColorPickerV2 Lightbulb Auto Individual ColorPickers, or items parsed from LightControllerV2.
Dimmer Lightbulb Auto Individual Dimmers, or items parsed from LightControllerV2.
Gate GarageDoorOpener Auto
Humidity HumiditySensor Manual InfoOnlyAnalog Item. Requires a mapping.
Intercom Doorbell, Camera Auto
IntercomV2 Doorbell, MotionSensor, Camera Auto "Use in userinterface" has to be enabled on the MotionSensor for it to be detected.
IRoomControllerV2 Thermostat Auto
Jalousie Window Covering Auto
LightControllerV2 MoodSwitch, Lightbulb Auto When enabled, all LightControllerV2 moods are mapped to a Switch Group as a seperate switch. Individual lights are mapped to a Lightbulb.
Lock LockMechanism Manual Switch Item. Requires a mapping.
Motion MotionSensor Manual InfoOnlyDigital Item. Requires a mapping.
PresenceDetector OccupancySensor Auto
Switch, Pushbutton Switch, Outlet, or Lightbulb Auto
Temperature TemperatureSensor Manual InfoOnlyAnalog Item. Requires a mapping.
Ventilation Fanv2 Auto
WindowMonitor ContactSensor Auto

For the plugin to recognize the items, the item needs to be vissible in the user interface. This can be done by enabling "use" in the userinterface section of the item.

useinuserinterface

Configuration

Configuration of the plugin can be done using the Homebridge UI without having to manually edit the Homebridge config.json file.

Required Settings

At a minimum, the plugin requires these settings to connect to the miniserver.

Parameter Note
host IP of your loxone miniserver
port optional, port of your miniserver (default: 80)
username loxone username
password loxone password

If you create a dedicated user for the plugin, you can filter items by only assigning rights to items you want to expose to HomeBridge.

Filters

Filters allow you to select what to expose to HomeKit.

Moodswitches

When enabled, all LightControllerV2 moods are mapped to a homekit switch. All Switches from the same LightController will be grouped together. In homeKit this works as a radio switch, so only one switch (mood) can be active at the same time. Mixing moods is not possible.

Exclusions

To exclude Itemtypes from being mapped, they can be added to the Exclussions section in the config. Use a comma-seperated list for multiple ItemTypes.

filters

The itemtype name can be found in the "mapped items" table.

Room Filter

The roomfilter List can fuction as a filter for certain rooms. Use a comma-seperated list for multiple Rooms. Depending on the roomfilter Type, this serves as an inclusion, or exclusion list.

Manual mapping

Some items cannot be mapped automatically and require a naming convention to be recognized. For example, giving all Brightness sensors the convention "MH0'XX'" in Loxone Config

mapping2

and then setting the alias "MH0" in the plugin will result in all InfoOnlyAnalog items with "MH0" in the name being recognized as LightSensors.

filters

Items that require an alias are listed in the "mapped items" table.

Limitations

Apple does not allow more than 150 items per bridge. This plugin will not map more than 150 items, but if you have other plugins activated, you might still hit this limit. To prevent this you can run this plugin as a child bridge. Another way to solve it is to use a dedicated loxone user for the plugin and only expose the items that you want to use in HomeKit.

Package Sidebar

Install

npm i homebridge-loxone-cedricb

Weekly Downloads

2

Version

2.0.2

License

Apache-2.0

Unpacked Size

253 kB

Total Files

184

Last publish

Collaborators

  • cedriic.b