-
-
Notifications
You must be signed in to change notification settings - Fork 32
Single Channel Devices
Use the 'Single Channel Devices' (singleDevices[]
) configuration section to customise how your single-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, a 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)
- a light
- a fan
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 |
---|---|---|---|---|---|
name |
str |
Yes | "" |
A label for this device, will be used as the HomeKit name if setting up a local device. | |
serialNumber |
str |
Yes | "" |
32 digit serial number (uuid) of the device. | |
connection |
str |
No | "default" |
Connection method to use for this device. Must be one of:
|
|
deviceUrl |
str |
No | "" |
IP address to use for the device when connection is local . |
|
ignoreDevice |
bool |
No | false |
If true , this accessory will be removed and ignored from HomeKit. |
|
model |
str |
See 1 | "" |
1 Required when device has been setup as local Set the model for this device. One of:
|
|
showAs |
str |
No | "default" |
Expose this device as a different HomeKit accessory type.
|
|
inUsePowerThreshold |
int |
No | 0 |
0 |
HomeKit will set the 'In Use' status of outlet devices to true when the wattage is above this number. |
firmwareRevision |
str |
No | "" |
For local devices, HomeKit will show this as the firmware version. | |
userkey |
str |
No | "" |
Override the user key for this device if it is registered to a different Meross account. | |
overrideLogging |
str |
No | "default" |
Override global logging setting for this device.
|
An example for a single channel outlet device (that provides energy data) to show as an outlet and to set the OutletInUse
state to true only when the when power is over 5W:
"singleDevices": [
{
"name": "Fan Outlet",
"serialNumber": "2009############################",
"showAs": "outlet",
"inUsePowerThreshold": 5
}
]
The same example as above, but using local connection mode (by providing the deviceUrl
, model
and optionally firmwareRevision
:
"singleDevices": [
{
"name": "Fan Outlet",
"serialNumber": "2009############################",
"deviceUrl": "192.168.1.34",
"model": "MSS310",
"showAs": "outlet",
"inUsePowerThreshold": 5,
"firmwareRevision": "2.1.17"
}
]