@bixu/homekit

v2026.04.23.1

Discover, pair with, read sensors from, control, and list HomeKit accessories — pure TypeScript HAP protocol implementation

Repository

https://github.com/bixu/swamp-homekit

Platforms

darwin-aarch64 darwin-x86_64 linux-x86_64 linux-aarch64

Labels

homekitiotmdns

models

Quality score

How well-documented and verifiable this extension is.

Grade A

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types0/1missing
Has description1/1earned
At least one platform tag (or universal)1/1earned
Two or more platform tags (or universal)1/1earned
License declared1/1earned
Verified public repository2/2earned

Install

$ swamp extension pull @bixu/homekit

@bixu/homekitv2026.03.15.1homekit.ts

Global Arguments

Argument	Type	Required	Description
discoveryTimeout	number	yes	Seconds to wait for mDNS discovery (default: 10)

discoverDiscover HomeKit accessories on the local network via mDNS

Argument	Type	Required	Description
timeout?	number	no	Override discovery timeout in seconds

pairPair with a HomeKit accessory using its setup code (from the accessory label or app)

Argument	Type	Required	Description
accessoryName	string	yes	Name of a discovered accessory to pair with
setupCode	string	yes	8-digit setup code in XXX-XX-XXX format

readSensorsRead sensor data (temperature, humidity, etc.) from a paired accessory

Argument	Type	Required	Description
accessoryName	string	yes	Name of a discovered accessory to read sensors from

controlAccessoryControl a paired HomeKit accessory (toggle lights, lock/unlock, set temperature, etc.)

Argument	Type	Required	Description
accessoryName	string	yes	Name of a discovered accessory to control
characteristic	string	yes	Characteristic to set (e.g., On, Brightness, LockTargetState, TargetTemperature)
value	union	yes	Value to set (e.g., true, 75, 0)
serviceName?	string	no	Service name to target (optional, for accessories with multiple services)

listAccessoriesList all services and characteristics for a paired accessory

Argument	Type	Required	Description
accessoryName	string	yes	Name of a discovered accessory to list

Resources

discovery(infinite)— Discovered HomeKit accessories on the local network

accessory(infinite)— Individual HomeKit accessory

summary(infinite)— Summary of a discovery or sensor operation

pairing(infinite)— Stored pairing credentials for a HomeKit accessory

sensorReading(infinite)— Sensor reading from a paired HomeKit accessory

sensorSummary(infinite)— Summary of sensor readings

controlResult(infinite)— Result of a control operation on a HomeKit accessory

controlSummary(infinite)— Summary of a control operation

accessoryList(infinite)— Full service and characteristic listing for a paired accessory

accessoryListSummary(infinite)— Summary of a listAccessories operation