HomeKit accessory
localby ALYT
What it adds to a house
Section titled “What it adds to a house”adds thermostats, lights, switches, sensors and locks.
How a person connects it
Section titled “How a person connects it”Method: pair. The eight-digit setup code printed on the accessory or shown in its app.
| Field | Kind | Required |
|---|---|---|
Setup code (setupCode) | text, secret | yes |
What it can look for
Section titled “What it can look for”Yes: “Look for accessories”.
What stops working when it is disconnected
Section titled “What stops working when it is disconnected”The things it brought stop answering until it is connected again.
The descriptor
Section titled “The descriptor”Connection fields are served for a program at /connectors/homekit.json.
{ "source": "built-in", "visibility": "public", "listed": true, "version": "1.0.0", "docsUrl": "https://developers.alyt.com/connectors/homekit", "kind": "HOMEKIT", "logo": { "url": "/integrations/logos/homekit.svg", "color": "#F4A400", "ratio": 1, "background": "#FFFFFF", "inset": 0.12, "scale": 1 }, "name": "HomeKit accessory", "icon": "house", "connectivity": "local", "brings": [ "thermostat", "light", "switch", "sensor", "lock" ], "connect": { "method": "pair", "help": "The eight-digit setup code printed on the accessory or shown in its app.", "fields": [ { "key": "setupCode", "label": "Setup code", "kind": "text", "secret": true, "required": true, "placeholder": "XXX-XX-XXX" } ] }, "discovery": { "verb": "Look for accessories" }, "disconnect": { "consequence": "{count} {things} stop answering until it is connected again." }, "author": { "kind": "alyt", "name": "ALYT", "url": "https://alyt.com" }}The guide
Section titled “The guide”HomeKit accessory connects to a local accessory with the eight-digit setup code printed on the accessory or shown in its app. After pairing, ALYT exposes the accessory through the household API as the device types it brings: thermostat, light, switch, sensor, and lock. Because this connector is local, it keeps working during a cloud outage as long as the accessory and local network remain available. If you disconnect it, the accessory stops answering until it is connected again.
Connect
Section titled “Connect”Use the pair flow and enter the required setupCode value. The field is secret and required. The setup code is the eight-digit code from the accessory label or the accessory app. Pairing is local, so the accessory must be on the same reachable home network at connect time.
If pairing fails, check the code format first, then confirm the accessory is powered, nearby, and still in pairing mode. A failed local network path prevents connection even when the code is correct.
What it exposes
Section titled “What it exposes”This connector brings these HomeKit accessory types into ALYT:
- thermostat
- light
- switch
- sensor
- lock
The page does not promise every feature on every model. What you can use depends on the accessory category and the specific accessory model.
What to expect from each type
Section titled “What to expect from each type”Thermostat
Section titled “Thermostat”You can use thermostat state and control operations that the accessory supports through HomeKit. Treat unsupported device features as unavailable rather than assumed.
Light and switch
Section titled “Light and switch”Lights and switches expose their normal state and control operations. Use the household API to read their current state and send changes.
Sensor
Section titled “Sensor”Sensors expose their state for monitoring. They are for reading values and reacting to changes, not for direct control.
Locks expose lock state and the control needed to change that state when the accessory supports it. Keep household permissions in mind: household users have narrower access than staff.
Disconnect behavior
Section titled “Disconnect behavior”When you disconnect the accessory, {count} {things} stop answering until it is connected again. Any automations or client code that depend on it should treat disconnect as a temporary loss of availability, not a permanent removal.
Failure checks
Section titled “Failure checks”When the connector does not work, check these in order:
- Confirm the accessory still has power.
- Confirm the local network can reach the accessory.
- Confirm the
setupCodematches the accessory’s current HomeKit code. - Confirm the accessory is still available to pair.
Because the connector is local, cloud outage does not block normal operation. If the accessory itself or the local network is down, the connector cannot answer.
Access boundaries
Section titled “Access boundaries”Household permissions are narrower than staff permissions. Use the access level that matches the action you want to perform. This connector is for the developer building against the API and the household that will use the accessory, so keep the pairing code private and expose only the accessory functions that the household should control.