Optional
bridgeOptional
lastAdd the given service instance to the Accessory.
Returns the service instance passed to the method call.
Adds a given service by calling the provided Service constructor with the provided constructor arguments.
A Service service constructor (e.g. Service.Switch).
Rest
...constructorArgs: ConstructorArgs<S>The arguments passed to the given constructor.
Returns the constructed service instance.
This method is used to set up a new Controller for this accessory. See Controller for a more detailed explanation what a Controller is and what it is capable of.
The controller can be passed as an instance of the class or as a constructor (without any necessary parameters) for a new Controller. Only one Controller of a given ControllerIdentifier can be configured for a given Accessory.
When called, it will be checked if there are any services and persistent data the Controller (for the given ControllerIdentifier) can be restored from. Otherwise, the Controller will be created with new services.
The Controller instance or constructor to the Controller with no required arguments.
Publishes this accessory on the local network for iOS clients to communicate with.
info.username
- formatted as a MAC address, like CC:22:3D:E3:CE:F6
, of this accessory.
Must be globally unique from all Accessories on your local network.info.pincode
- the 8-digit pin code for clients to use when pairing this Accessory.
Must be formatted as a string like 031-45-154
.info.category
- one of the values of the Accessory.Category
enum, like Accessory.Category.SWITCH
.
This is a hint to iOS clients about what "type" of Accessory this represents, so
that for instance an appropriate icon can be drawn for the user while adding a
new Accessory.Required info for publishing.
Optional
allowInsecureRequest: booleanWill allow unencrypted and unauthenticated access to the http server
This method will remove a given Controller from this accessory. The controller object will be restored to its initial state. This also means that any event handlers setup for the controller will be removed.
The controller which should be removed from the accessory.
Static
cleanupStatic
deserializeStatic
serialize
Accessory is a virtual HomeKit device. It can publish an associated HAP server for iOS devices to communicate with - or it can run behind another "Bridge" Accessory server.
Bridged Accessories in this implementation must have a UUID that is unique among all other Accessories that are hosted by the Bridge. This UUID must be "stable" and unchanging, even when the server is restarted. This is required so that the Bridge can provide consistent "Accessory IDs" (aid) and "Instance IDs" (iid) for all Accessories, Services, and Characteristics for iOS clients to reference later.