Class Bridge

Bridge is a special type of HomeKit Accessory that hosts other Accessories "behind" it. This way you can simply publish() the Bridge (with a single HAPServer on a single port) and all bridged Accessories will be hosted automatically, instead of needed to publish() every single Accessory as a separate server.

Hierarchy

Accessory
- Bridge

Constructors

constructor

new Bridge(displayName: string, UUID: string): Bridge
Parameters
- displayName: string
- UUID: string
Returns Bridge
Overrides Accessory.constructor
- Defined in lib/Bridge.ts:11

Properties

UUID

UUID: string

_isBridge

_isBridge: boolean = false

aid

aid: Nullable<number> = null

`Optional` bridge

bridge?: Accessory

bridged

bridged: boolean = false

bridgedAccessories

bridgedAccessories: Accessory[] = []

displayName

displayName: string

`Optional` lastKnownUsername

lastKnownUsername?: string

reachable

reachable: boolean = true

services

services: Service[] = []

shouldPurgeUnusedIDs

shouldPurgeUnusedIDs: boolean = true

`Static` Categories

Categories: typeof Categories = Categories

Deprecated

Please use the Categories const enum above.

Methods

addBridgedAccessories

addBridgedAccessories(accessories: Accessory[]): void
Parameters
- accessories: Accessory[]
Returns void
Inherited from Accessory.addBridgedAccessories
- Defined in lib/Accessory.ts:705

addBridgedAccessory

addBridgedAccessory(accessory: Accessory, deferUpdate?: boolean): Accessory
Parameters
- accessory: Accessory
- deferUpdate: boolean = false
Returns Accessory
Inherited from Accessory.addBridgedAccessory
- Defined in lib/Accessory.ts:668

addService

addService(service: Service): Service
Add the given service instance to the Accessory.

Returns
Returns the service instance passed to the method call.
Parameters
- service: Service
  
  A Service instance.
Returns Service
Inherited from Accessory.addService
- Defined in lib/Accessory.ts:531
addService<S>(serviceConstructor: S, ...constructorArgs: ConstructorArgs<S>): Service
Adds a given service by calling the provided Service constructor with the provided constructor arguments.

Returns
Returns the constructed service instance.
Type Parameters
- S extends typeof Service
Parameters
- serviceConstructor: S
  
  A Service service constructor (e.g. Switch).
- Rest ...constructorArgs: ConstructorArgs<S>
  
  The arguments passed to the given constructor.
Returns Service
Inherited from Accessory.addService
- Defined in lib/Accessory.ts:538

configureCameraSource

configureCameraSource(cameraSource: LegacyCameraSource): CameraController
Method is used to configure an old style CameraSource. The CameraSource API was fully replaced by the new Controller API used by CameraController. The CameraStreamingDelegate used by the CameraController is the equivalent to the old CameraSource.

The new Controller API is much more refined and robust way of "grouping" services together. It especially is intended to fully support serialization/deserialization to/from persistent storage. This feature is also gained when using the old style CameraSource API. The CameraStreamingDelegate improves on the overall camera API though and provides some reworked type definitions and a refined callback interface to better signal errors to the requesting HomeKit device. It is advised to update to it.

Full backwards compatibility is currently maintained. A legacy CameraSource will be wrapped into an Adapter. All legacy StreamControllers in the "streamControllers" property will be replaced by CameraRTPManagement instances. Any services in the "services" property which are one of the following are ignored: - CameraRTPStreamManagement - CameraOperatingMode - CameraEventRecordingManagement

Deprecated
please refer to the new CameraController API and configureController
Parameters
- cameraSource: LegacyCameraSource
  
  The instance of the legacy camera source
Returns CameraController
Inherited from Accessory.configureCameraSource
- Defined in lib/Accessory.ts:792

configureController

configureController(controllerConstructor: Controller<ControllerServiceMap> | ControllerConstructor): void
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.
Parameters
- controllerConstructor: Controller<ControllerServiceMap> | ControllerConstructor
  
  The Controller instance or constructor to the Controller with no required arguments.
Returns void
Inherited from Accessory.configureController
- Defined in lib/Accessory.ts:840

destroy

destroy(): Promise<void>
Removes this Accessory from the local network Accessory object will no longer valid after invoking this method Trying to invoke publish() on the object will result undefined behavior

Returns Promise<void>
Inherited from Accessory.destroy
- Defined in lib/Accessory.ts:1375

disableUnusedIDPurge

disableUnusedIDPurge(): void
Returns void
Inherited from Accessory.disableUnusedIDPurge
- Defined in lib/Accessory.ts:1111

emit

emit(event: "identify", paired: boolean, callback: VoidCallback): boolean
Parameters
- event: "identify"
- paired: boolean
- callback: VoidCallback
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:394
emit(event: "listening", port: number, address: string): boolean
Parameters
- event: "listening"
- port: number
- address: string
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:395
emit(event: "advertised"): boolean
Parameters
- event: "advertised"
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:396
emit(event: "service-configurationChange", change: ServiceConfigurationChange): boolean
Parameters
- event: "service-configurationChange"
- change: ServiceConfigurationChange
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:398
emit(event: "service-characteristic-change", change: AccessoryCharacteristicChange): boolean
Parameters
- event: "service-characteristic-change"
- change: AccessoryCharacteristicChange
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:399
emit(event: "paired"): boolean
Parameters
- event: "paired"
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:401
emit(event: "unpaired"): boolean
Parameters
- event: "unpaired"
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:402
emit(event: "characteristic-warning", warning: CharacteristicWarning): boolean
Parameters
- event: "characteristic-warning"
- warning: CharacteristicWarning
Returns boolean
Inherited from Accessory.emit
- Defined in lib/Accessory.ts:404

enableUnusedIDPurge

enableUnusedIDPurge(): void
Returns void
Inherited from Accessory.enableUnusedIDPurge
- Defined in lib/Accessory.ts:1115

getPrimaryAccessory

getPrimaryAccessory(): Accessory
Returns the bridging accessory if this accessory is bridged. Otherwise, returns itself.

Returns
the primary accessory

Returns Accessory
Inherited from Accessory.getPrimaryAccessory
- Defined in lib/Accessory.ts:652

getService

getService<T>(name: string | T): undefined | Service
Type Parameters
- T extends WithUUID<typeof Service>
Parameters
- name: string | T
Returns undefined | Service
Inherited from Accessory.getService
- Defined in lib/Accessory.ts:622

getServiceById

getServiceById<T>(uuid: string | T, subType: string): undefined | Service
Type Parameters
- T extends WithUUID<typeof Service>
Parameters
- uuid: string | T
- subType: string
Returns undefined | Service
Inherited from Accessory.getServiceById
- Defined in lib/Accessory.ts:634

on

on(event: "identify", listener: ((paired: boolean, callback: VoidCallback) => void)): Bridge
Parameters
- event: "identify"
- listener: ((paired: boolean, callback: VoidCallback) => void)
  - - (paired: boolean, callback: VoidCallback): void
    - Parameters
      
      paired: boolean
      
      callback: VoidCallback
      
      Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:381
on(event: "listening", listener: ((port: number, address: string) => void)): Bridge
Parameters
- event: "listening"
- listener: ((port: number, address: string) => void)
  - - (port: number, address: string): void
    - Parameters
      
      port: number
      
      address: string
      
      Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:382
on(event: "advertised", listener: (() => void)): Bridge
Parameters
- event: "advertised"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:383
on(event: "service-configurationChange", listener: ((change: ServiceConfigurationChange) => void)): Bridge
Parameters
- event: "service-configurationChange"
- listener: ((change: ServiceConfigurationChange) => void)
  - - (change: ServiceConfigurationChange): void
    - Parameters
      
      change: ServiceConfigurationChange
      
      Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:385
on(event: "service-characteristic-change", listener: ((change: AccessoryCharacteristicChange) => void)): Bridge
Parameters
- event: "service-characteristic-change"
- listener: ((change: AccessoryCharacteristicChange) => void)
  - - (change: AccessoryCharacteristicChange): void
    - Parameters
      
      change: AccessoryCharacteristicChange
      
      Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:386
on(event: "paired", listener: (() => void)): Bridge
Parameters
- event: "paired"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:388
on(event: "unpaired", listener: (() => void)): Bridge
Parameters
- event: "unpaired"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:389
on(event: "characteristic-warning", listener: ((warning: CharacteristicWarning) => void)): Bridge
Parameters
- event: "characteristic-warning"
- listener: ((warning: CharacteristicWarning) => void)
  - - (warning: CharacteristicWarning): void
    - Parameters
      
      warning: CharacteristicWarning
      
      Returns void
Returns Bridge
Inherited from Accessory.on
- Defined in lib/Accessory.ts:391

publish

publish(info: PublishInfo, allowInsecureRequest?: boolean): Promise<void>
Publishes this Accessory on the local network for iOS clients to communicate with.
Parameters
- info: PublishInfo
  
  Required info for publishing.
- Optional allowInsecureRequest: boolean
  
  Will allow unencrypted and unauthenticated access to the http server
Returns Promise<void>
Inherited from Accessory.publish
- Defined in lib/Accessory.ts:1199

purgeUnusedIDs

purgeUnusedIDs(): void
Manually purge the unused ids if you like, comes handy when you have disabled auto purge, so you can do it manually

Returns void
Inherited from Accessory.purgeUnusedIDs
- Defined in lib/Accessory.ts:1123

removeAllBridgedAccessories

removeAllBridgedAccessories(): void
Returns void
Inherited from Accessory.removeAllBridgedAccessories
- Defined in lib/Accessory.ts:739

removeBridgedAccessories

removeBridgedAccessories(accessories: Accessory[]): void
Parameters
- accessories: Accessory[]
Returns void
Inherited from Accessory.removeBridgedAccessories
- Defined in lib/Accessory.ts:731

removeBridgedAccessory

removeBridgedAccessory(accessory: Accessory, deferUpdate?: boolean): void
Parameters
- accessory: Accessory
- deferUpdate: boolean = false
Returns void
Inherited from Accessory.removeBridgedAccessory
- Defined in lib/Accessory.ts:713

removeController

removeController(controller: Controller<ControllerServiceMap>): void
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.
Parameters
- controller: Controller<ControllerServiceMap>
  
  The controller which should be removed from the accessory.
Returns void
Inherited from Accessory.removeController
- Defined in lib/Accessory.ts:906

removeService

removeService(service: Service): void
Parameters
- service: Service
Returns void
Inherited from Accessory.removeService
- Defined in lib/Accessory.ts:595

setPrimaryService

setPrimaryService(service: Service): void
Deprecated
use setPrimaryService directly
Parameters
- service: Service
Returns void
Inherited from Accessory.setPrimaryService
- Defined in lib/Accessory.ts:591

setupURI

setupURI(): string
Returns string
Inherited from Accessory.setupURI
- Defined in lib/Accessory.ts:989

unpublish

unpublish(): Promise<void>
Returns Promise<void>
Inherited from Accessory.unpublish
- Defined in lib/Accessory.ts:1390

updateReachability

updateReachability(reachable: boolean): void
Deprecated
Not supported anymore
Parameters
- reachable: boolean
Returns void
Inherited from Accessory.updateReachability
- Defined in lib/Accessory.ts:659

`Static` cleanupAccessoryData

cleanupAccessoryData(username: string): void
Parameters
- username: string
Returns void
Inherited from Accessory.cleanupAccessoryData
- Defined in lib/Accessory.ts:2188

`Static` deserialize

deserialize(json: SerializedAccessory): Accessory
Parameters
- json: SerializedAccessory
Returns Accessory
Inherited from Accessory.deserialize
- Defined in lib/Accessory.ts:2141

`Static` serialize

serialize(accessory: Accessory): SerializedAccessory
Parameters
- accessory: Accessory
Returns SerializedAccessory
Inherited from Accessory.serialize
- Defined in lib/Accessory.ts:2086

Class Bridge

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

displayName: string

UUID: string

Returns Bridge

Properties

UUID

_isBridge

aid

Optional bridge

bridged

bridgedAccessories

category

displayName

Optional lastKnownUsername

reachable

services

shouldPurgeUnusedIDs

Static Categories

Deprecated

Methods

addBridgedAccessories

Parameters

accessories: Accessory[]

Returns void

addBridgedAccessory

Parameters

accessory: Accessory

deferUpdate: boolean = false

Returns Accessory

addService

Returns

Parameters

service: Service

Returns Service

Returns

Type Parameters

S extends typeof Service

Parameters

serviceConstructor: S

Rest ...constructorArgs: ConstructorArgs<S>

Returns Service

configureCameraSource

Deprecated

Parameters

cameraSource: LegacyCameraSource

Returns CameraController

configureController

Parameters

controllerConstructor: Controller<ControllerServiceMap> | ControllerConstructor

Returns void

destroy

Returns Promise<void>

disableUnusedIDPurge

Returns void

emit

Parameters

event: "identify"

paired: boolean

callback: VoidCallback

Returns boolean

Parameters

event: "listening"

port: number

address: string

Returns boolean

Parameters

event: "advertised"

Returns boolean

Parameters

event: "service-configurationChange"

change: ServiceConfigurationChange

Returns boolean

`Optional` bridge

`Optional` lastKnownUsername

`Static` Categories

`Rest` ...constructorArgs: ConstructorArgs<S>