-
-
Notifications
You must be signed in to change notification settings - Fork 127
Multi Channel Devices
Use the 'Multi Channel Devices' (multiDevices[]
) configuration section to customise how your multi-channel switch, outlet and light switch devices are exposed to HomeKit.
See Supported Devices to see which devices can be customised using this section.
By default, each channel of a multi-channel device will appear in Homebridge as a single switch. You can use the Home app to change how this accessory appears:
- a switch (by default, useful for devices like the Sonoff 4CH)
- a light (useful for devices like the T1-2C/3C, TX-2C/3C)
- a fan
An extra accessory will also be added to Homebridge which acts as an "All On/Off", similar to the functionality of the eWeLink app. Some users may know this accessory as the 'SW0' accessory. This accessory will show as
-
ON
if any of it's channels are on, and turning it off will turn all of it's channels off -
OFF
if all it's channels are off, and turning it on will turn all of it's channels on
It is possible to hide both the "All On/Off" accessory and any other channel accessory from Homebridge. You can do this using the hideChannels
option. If you hide any channel using the above method then it will not be available to be used in any HomeKit automation.
The easiest way to customise these devices is via the Homebridge/HOOBS UI. However, if you prefer to edit your Homebridge config file manually then here is a list of the options and and examples:
Entry | Type | Required | Default | Min | Explanation |
---|---|---|---|---|---|
label |
str |
No | "" |
This setting has no effect except to help identify this device. | |
deviceId |
str |
Yes | "" |
eWeLink Device ID (10 characters e.g. "10000abcde" . |
|
ignoreDevice |
bool |
No | false |
If true , this accessory will be removed and ignored from HomeKit. |
|
deviceModel |
str |
See 1 | "" |
Set the model for this device.
|
|
showAs |
str |
No | "default" |
Expose this device as a different HomeKit accessory type.
|
|
showAsMotor |
str |
No | "blind" |
Only has effect if The accessory type to show in HomeKit:
|
|
hideChannels |
str |
No | "" |
Only has effect when A comma separated list of channels to hide for this device. For example |
|
inUsePowerThreshold |
int |
No | 0 |
0 |
Only has effect when HomeKit will set the 'In Use' status of outlet devices to true when the wattage is above this number. |
sensorType |
str |
No | "motion" |
The type of sensor to show in HomeKit if
|
|
operationTime |
int |
See 2 | 100 |
20 |
2 Required if
This setting is in deciseconds - count the time in seconds and multiply by 10, for example |
operationTimeDown |
int |
No | - |
20 |
Only has effect if If your device has a different operation time for up and down, use this setting to specify the operation time DOWN (in deciseconds) and the other setting to specify the operation time UP. This setting is in deciseconds - count the time in seconds and multiply by 10, for example |
sensorId |
str |
No | "" |
Only has effect if Enter the 10 digit eWeLink Device ID for a DW2 or Zigbee contact sensor that can be used to determine the current state of the garage door or lock. |
|
hideSensor |
bool |
No | false |
Only has effect if Hide the contact sensor (defined above in |
|
obstructId |
str |
No | "" |
Only has effect if An optional switch that will trigger the Obstruction Detected feature depending on its value. |
|
ipAddress |
str |
No | "" |
Has no effect if You can manually set the IP address for this device if it cannot be discovered by the plugin. |
|
overrideLogging |
str |
No | "default" |
Override global logging setting for this device.
|
An example to set a custom IP and no disabling all accessory logging for a Sonoff 4CHPROR3:
"multiDevices": [
{
"deviceId": "10009553c8",
"deviceModel": "4ch",
"ipAddress": "192.168.1.13",
"overrideLogging": "disable"
}
]
An example for a DUALR3 in switch mode to set the OutletInUse
state to true only when the when power is over 10W:
"multiDevices": [
{
"deviceId": "10009553c8",
"deviceModel": "dualr3_switch",
"inUsePowerThreshold": 10
}
]
An example for a DUALR3 in motor mode to show as a window accessory type:
"multiDevices": [
{
"deviceId": "10009553c8",
"deviceModel": "dualr3_motor",
"showAsMotor": "window"
}
]
- 1 Garage Door (with multi channel device)
- 2 Garage Doors (with multi channel device)
- 4 Garage Doors (with multi channel device)
- 1 Window Blind (with multi channel device)
- 1 Door (with multi channel device)
- 1 Window (with multi channel device)
- 1 Lock (with single or multi channel device)
- 1 Tap/Faucet (with single or multi channel device)
- 2 Taps/Faucets (with multi channel device)
- 1 Irrigation Valve (with single or multi channel device)
- 2 Irrigation Valves (with multi channel device)
- 4 Irrigation Valves (with multi channel device)
- 1 Switch + 1 Irrigation Valve (with multi channel device)
- 1 Sensor (with single or multi channel device)
- 1 Programmable Button (with single or multi channel device)
- 1 Doorbell (with single or multi channel device)