Class PlatformAccessory<T>

Export Platform Accessory Types

Type parameters

T: UnknownContext = UnknownContext

Hierarchy

EventEmitter
- PlatformAccessory

Constructors

constructor

new PlatformAccessory<T>(displayName: string, uuid: string, category?: Categories): PlatformAccessory<T>

- Defined in platformAccessory.ts:66
Type parameters
- T: UnknownContext = UnknownContext
Parameters
- displayName: string
- uuid: string
- Optional category: Categories
Returns PlatformAccessory<T>

Properties

UUID

UUID: string

_associatedHAPAccessory

_associatedHAPAccessory: Accessory

Optional _associatedPlatform

_associatedPlatform?: string

Optional _associatedPlugin

_associatedPlugin?: string

category

category: Categories

context

context: T = ...

This is a way for Plugin developers to store custom data with their accessory

displayName

displayName: string

reachable

reachable: boolean = false

deprecated: reachability has no effect and isn't supported anymore

services

services: Service[] = []

Methods

addService

addService(service: Service | typeof Service, ...constructorArgs: any[]): Service

- Defined in platformAccessory.ts:92
Parameters
- service: Service | typeof Service
- Rest ...constructorArgs: any[]
Returns Service

configureCameraSource

configureCameraSource(cameraSource: LegacyCameraSource): CameraController

- Defined in platformAccessory.ts:132
deprecated
see Accessory.configureCameraSource

Parameters
- cameraSource: LegacyCameraSource
Returns CameraController

configureController

configureController(controller: Controller<ControllerServiceMap> | ControllerConstructor): void

- Defined in platformAccessory.ts:142
Configures a new controller for the given accessory. See Accessory.configureController.

Parameters
- controller: Controller<ControllerServiceMap> | ControllerConstructor
Returns void

emit

emit(event: "identify"): boolean

- Defined in platformAccessory.ts:35
Parameters
- event: "identify"
Returns boolean

getService

getService<T>(name: string | T): undefined | Service

- Defined in platformAccessory.ts:100
Type parameters
- T: WithUUID<typeof Service>
Parameters
- name: string | T
Returns undefined | Service

getServiceById

getServiceById<T>(uuid: string | T, subType: string): undefined | Service

- Defined in platformAccessory.ts:114
Type parameters
- T: WithUUID<typeof Service>
Parameters
- uuid: string | T
- subType: string
Returns undefined | Service

getServiceByUUIDAndSubType

getServiceByUUIDAndSubType<T>(uuid: string | T, subType: string): undefined | Service

- Defined in platformAccessory.ts:110
deprecated
use getServiceById directly

Type parameters
- T: WithUUID<typeof Service>
Parameters
- uuid: string | T
- subType: string
Returns undefined | Service

on

on(event: "identify", listener: () => void): PlatformAccessory<T>

- Defined in platformAccessory.ts:33
Parameters
- event: "identify"
- listener: () => void
  - - (): void
    - Returns void
Returns PlatformAccessory<T>

removeController

removeController(controller: Controller<ControllerServiceMap>): void

- Defined in platformAccessory.ts:152
Removes a configured controller from the given accessory. See Accessory.removeController.

Parameters
- controller: Controller<ControllerServiceMap>
Returns void

removeService

removeService(service: Service): void

- Defined in platformAccessory.ts:96
Parameters
- service: Service
Returns void

updateReachability

updateReachability(reachable: boolean): void

- Defined in platformAccessory.ts:123
deprecated
reachability has no effect and isn't supported anymore

Parameters
- reachable: boolean
Returns void

Static deserialize

deserialize(json: SerializedPlatformAccessory<UnknownContext>): PlatformAccessory<UnknownContext>

- Defined in platformAccessory.ts:166
Parameters
- json: SerializedPlatformAccessory<UnknownContext>
Returns PlatformAccessory<UnknownContext>

Static serialize

serialize(accessory: PlatformAccessory<UnknownContext>): SerializedPlatformAccessory<UnknownContext>

- Defined in platformAccessory.ts:157
Parameters
- accessory: PlatformAccessory<UnknownContext>
Returns SerializedPlatformAccessory<UnknownContext>