docs/interfaces/AccessoryPlugin.html
Export types for basically everything but the actual API implementation
interface AccessoryPlugin {
getControllers?(): Controller<ControllerServiceMap>[];
getServices(): Service[];
identify?(): void;
}
getControllers?getServicesidentify?
OptionalgetControllersgetControllers?(): Controller<ControllerServiceMap>[]
This method will be called once on startup, to query all controllers to be exposed by the Accessory. It is optional to implement.
This includes controllers like the RemoteController or the CameraController. Any necessary controller specific setup should have been done when returning the array. In most cases the plugin will only return an array of the size 1.
In the case that the Plugin does not add any additional services (returned by getServices) the method getServices must be defined in any way and should just return an empty array.
controllers - returned controllers will be configured for the Accessory
getServices(): Service[]
This method will be called once on startup, to query all services to be exposed by the Accessory. All event handlers for characteristics should be set up before the array is returned.
services - returned services will be added to the Accessory
Optionalidentifyidentify?(): void
Optional method which will be called if a 'identify' of an Accessory is requested by HomeKit.
Member Visibility
ThemeOSLightDark