-
Notifications
You must be signed in to change notification settings - Fork 2
Setup and Configuration

Each HomeKitLink Bridge device has a config dialog with all the tools needed to manage published accessories.

The first dropdown in the config dialog is a device category filter:
| Filter | Shows |
|---|---|
| All Indigo Devices | Every device in Indigo |
| Lights | Dimmer and relay devices likely to be lights |
| Sensors | Sensor-type devices |
| Cameras | BlueIris / SecuritySpy camera devices |
| (others) | Category-specific subsets |
These filters only affect the list — all are duplicated in the "All" list. Use them to make searching easier when you have hundreds of devices.
The Show All Options checkbox unlocks every HomeKit device type for the currently selected Indigo device. By default HKLS restricts the type list to sensible choices for the device category.
⚠️ Use with care. Selecting an incompatible type (e.g. trying to use a temperature sensor as a camera) can cause the bridge to fail. If a bridge stops responding after a type change, see Troubleshooting.

The device list shows:
- Normal text — devices published to this bridge
- Greyed-out — devices published to another bridge (you must edit that bridge to change them)

HKLS automatically selects the best HomeKit type for a device. You can override this with Show All Options. See Supported Devices for the full list.
When publishing a sensor device, HKLS asks which device state to use as the sensor value:
- For most sensors:
sensorValue(the standard Indigo sensor value) - For plugin devices (piBeacon, RFXCOM, etc.): choose the state that matches the data type
- The config menu shows the current value of each state to help you choose
Type requirements:
- On/Off sensors (motion, occupancy, contact): must be
true/false - Temperature / humidity: must be a plain number —
22.1, not"22.1°C"
If a device sends the wrong type, HKLS will display 0 or may cause the bridge to stall. Fix by unpublishing the device (uncheck Publish, Save) and reconfiguring.
Open via Plugins → HomeKitLink Siri → Configure…

| Option | Description |
|---|---|
| 1. Debug Plugin HomeKit Callbacks | Verbose HAP callback logging |
| 2. Debug Device Updating Reporting | Log every device state update sent to HomeKit |
| 3. Debug HomeKit Library (Verbose!) | Full pyhap library debug — very noisy |
| 4. Debug Plugin Getter Callback | Log every HomeKit property read |
| 5. Debug Plugin Setter Callback | Log every HomeKit property write |
| 6. Debug HomeKit Devices | Device-level HomeKit state tracing |
| 7. Debug HomeKit Camera | Camera stream debug |
| 8. Debug Indigo Device Selection | Device list / filter debug |
| 9. Debug IID Manager | HomeKit IID allocation tracing |
| 10. Debug mDNS (File Only!) | Very verbose mDNS/Bonjour log — written to file only, not Indigo log |
| 11. Debug Actions | Action group triggering debug |
| Debug Device | Select a single Indigo device to trace — useful for isolating one problematic device |
⚠️ Only enable debug levels you actually need. Debug 3 (HomeKit Library) and Debug 10 (mDNS) are extremely verbose. Debug 10 goes to file only to avoid flooding the Indigo log.
| Setting | Description |
|---|---|
| Camera Max Refresh Time | Maximum seconds between camera image refreshes. Default: 30s. Lower = higher CPU usage. |
| Passive Camera Update Image Time | How often HKLS updates the stored image buffer when the Home app is NOT actively viewing. Prevents stale snapshots (e.g. 1 hour = image is at most 1 hour old when you reopen the app). |
| Image Width | Width of the snapshot image requested from the camera. |

See Advanced Configuration for full details.
| Limit | Value |
|---|---|
| Devices per bridge | Up to 95 |
| Bridges per plugin | Unlimited |
| Device per plugin total | Effectively unlimited (multiple bridges) |
Tip: Some users create one bridge per room, or one bridge per device type. There's no right answer — do whatever makes management easiest. Avoid creating bridges you don't need, but multiple bridges add only modest overhead.
Important: Changing a device from one HomeKit type to another (e.g. Switch → Blind) requires a specific sequence:
- Uncheck Publish for the device — click Save Device
- Click Save in the dialog (restarts the bridge)
- Verify in the Home app that the old accessory has disappeared
- Re-open the bridge config → re-add the device with the new type
- Click Save again
Skipping this causes HomeKit to retain the old device type, leading to control failures.
An Indigo device can only be published to one HKLS bridge at a time. If you need the same physical device to appear under two different names in HomeKit (e.g. "Bedroom Light" and "Upstairs Light"):
- Use the Masquerade plugin, or
- Create an Indigo Virtual Device that mirrors the original
Both approaches create a second Indigo device that HKLS can publish independently.
→ Supported Devices — see all HomeKit accessory types
Getting Started
Features
Reference
Support
Before posting:
Run menu items
1, 2 & 3 ❗