Repository navigation
Home
Welcome to homebridge-homematicip!
HmIP devices can be configured in the Homebridge UI under Per-device Options. Each entry requires the device's
SGTIN, which Apple Home displays as its serial number. The equivalent config.json format uses a devices array:
{
"bridge": {
"name": "Homebridge",
"username": "0E:47:xx:xx:xx:xx",
"port": 51355,
"pin": "xxx-xx-xxx",
"advertiser": "ciao"
},
"platforms": [{
"platform": "HomematicIP",
"name": "HomematicIP",
"access_point": "3014F711A000xxxxxxxxxxxx",
"auth_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"hideSecuritySystem": true,
"devices": [
{
"id": "3014F711A000xxxxxxxxxxEF",
"openLatch": true,
"pin": "1234"
},
{
"id": "3014F711A000xxxxxxxxxx22",
"hide": true
}
]
}]
}Enter the SGTIN without dashes and using capital letters. To hide the Home Security System, use the separate
hideSecuritySystem option shown in the Homebridge UI.
Upgrading from a version before 2.8.0? Follow the migration guide before opening the graphical plugin settings.
Devices can be removed by setting their hide option to true. After restarting Homebridge, the device is removed
from the HomeKit database. The option defaults to false, so all supported devices are added by default.
Some devices have device-specific options:
| Parameter | Description | Default |
|---|---|---|
| openLatch | When unlocking, the lock will be unlocked and the latch will be pulled so the door will jump open. | false |
| pin | Optional PIN if it was assigned to the lock in HmIP app (Settings / Access authorizations). | none |
Example:
{
"id": "3014F711A000xxxxxxxxxxEF",
"openLatch": true,
"pin": "1234"
}| Parameter | Description | Default |
|---|---|---|
| lightSwitch | Adds the optional light output as a HomeKit switch. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxEF",
"lightSwitch": true
}| Parameter | Description | Default |
|---|---|---|
| asClimateSensor | Hide the temperature controls and identify the device as a climate sensor only. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"asClimateSensor": true
}| Parameter | Description | Default |
|---|---|---|
| lightSensor | Add the device's brightness measurement as a HomeKit light sensor. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"lightSensor": true
}By default, the rotary handle sensor appears as a three-state HomeKit window: closed, tilted, or open. The optional contact-sensor representation is useful for simpler Siri queries and automations that only need closed or not closed.
| Parameter | Description | Default |
|---|---|---|
| asContactSensor | Replace the window service with a read-only contact sensor. Closed means contact detected; tilted or open means contact not detected. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"asContactSensor": true
}Restart Homebridge after changing this option. Switching representations replaces the HomeKit service, so related scenes and automations may need to be configured again.
| Parameter | Description | Default |
|---|---|---|
| simpleSwitch | True removes the two lightbulb services (top and bottom light) from the accessory. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"simpleSwitch": true
}These options add occupancy-style HomeKit sensors for weather conditions so they can be used in scenes and automations.
| Parameter | Applicable devices | Description | Default |
|---|---|---|---|
| withRainSensor | HmIP-SWO-PL, HmIP-SWO-PR | Indicate when the weather sensor detects rain. | false |
| withStormSensor | HmIP-SWO-B, HmIP-SWO-PL, HmIP-SWO-PR | Indicate when the weather sensor detects a storm. | false |
| withSunshineSensor | HmIP-SWO-B, HmIP-SWO-PL, HmIP-SWO-PR | Indicate when the weather sensor detects sunshine. | false |
| withWindSpeedSensor | HmIP-SWO-B, HmIP-SWO-PL, HmIP-SWO-PR | Indicate elevated wind speed. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"withRainSensor": true,
"withStormSensor": true,
"withSunshineSensor": true,
"withWindSpeedSensor": true
}The separateChannels option is supported by these multichannel devices:
- Inputs: HmIPW-DRI16 and HmIP-FCI6
- Dimmers: HmIPW-DRD3 and HmIP-DRDI3
| Parameter | Description | Default |
|---|---|---|
| separateChannels | Expose every assigned input or dimmer output as an independent HomeKit accessory so each channel can be assigned to its own room. | false |
Example:
{
"id": "3014F711A000xxxxxxxxxxxx",
"separateChannels": true
}Restart Homebridge after changing this option. The individual channel accessories can then be renamed and assigned to rooms in Apple Home. For multichannel input devices, unassigned inputs remain hidden.
Changing between grouped and separate channels replaces the corresponding HomeKit accessories. Existing room assignments, scenes, and automations for those channels may therefore need to be configured again. Each separated channel counts towards the HomeKit limit of 150 accessories per bridge.