Interface API

Export types for basically everything but the actual API implementation

Hierarchy

API

Index

Properties

Methods

Properties

Readonly hap

hap: __module

Readonly hapLegacyTypes

hapLegacyTypes: __module

Readonly platformAccessory

platformAccessory: typeof PlatformAccessory

Readonly serverVersion

serverVersion: string

The current homebridge semver version.

Readonly user

user: typeof User

Readonly version

version: number

The homebridge API version as a floating point number.

Methods

on

on(event: "didFinishLaunching", listener: () => void): API
on(event: "shutdown", listener: () => void): API

- Defined in api.ts:212
Parameters
- event: "didFinishLaunching"
- listener: () => void
  - - (): void
    - Returns void
Returns API
- Defined in api.ts:213
Parameters
- event: "shutdown"
- listener: () => void
  - - (): void
    - Returns void
Returns API

publishCameraAccessories

publishCameraAccessories(pluginIdentifier: string, accessories: PlatformAccessory<UnknownContext>[]): void

- Defined in api.ts:209
deprecated
use publishExternalAccessories directly to publish a standalone Accessory

Parameters
- pluginIdentifier: string
- accessories: PlatformAccessory<UnknownContext>[]
Returns void

publishExternalAccessories

publishExternalAccessories(pluginIdentifier: string, accessories: PlatformAccessory<UnknownContext>[]): void

- Defined in api.ts:210
Parameters
- pluginIdentifier: string
- accessories: PlatformAccessory<UnknownContext>[]
Returns void

registerAccessory

registerAccessory(accessoryName: string, constructor: AccessoryPluginConstructor): void
registerAccessory(pluginIdentifier: string, accessoryName: string, constructor: AccessoryPluginConstructor): void

- Defined in api.ts:197
Parameters
- accessoryName: string
- constructor: AccessoryPluginConstructor
Returns void
- Defined in api.ts:198
Parameters
- pluginIdentifier: string
- accessoryName: string
- constructor: AccessoryPluginConstructor
Returns void

registerPlatform

registerPlatform(platformName: string, constructor: PlatformPluginConstructor): void
registerPlatform(pluginIdentifier: string, platformName: string, constructor: PlatformPluginConstructor): void

- Defined in api.ts:200
Parameters
- platformName: string
- constructor: PlatformPluginConstructor
Returns void
- Defined in api.ts:201
Parameters
- pluginIdentifier: string
- platformName: string
- constructor: PlatformPluginConstructor
Returns void

registerPlatformAccessories

registerPlatformAccessories(pluginIdentifier: string, platformName: string, accessories: PlatformAccessory<UnknownContext>[]): void

- Defined in api.ts:202
Parameters
- pluginIdentifier: string
- platformName: string
- accessories: PlatformAccessory<UnknownContext>[]
Returns void

unregisterPlatformAccessories

unregisterPlatformAccessories(pluginIdentifier: string, platformName: string, accessories: PlatformAccessory<UnknownContext>[]): void

- Defined in api.ts:204
Parameters
- pluginIdentifier: string
- platformName: string
- accessories: PlatformAccessory<UnknownContext>[]
Returns void

updatePlatformAccessories

updatePlatformAccessories(accessories: PlatformAccessory<UnknownContext>[]): void

- Defined in api.ts:203
Parameters
- accessories: PlatformAccessory<UnknownContext>[]
Returns void

versionGreaterOrEqual

versionGreaterOrEqual(version: string): boolean

- Defined in api.ts:195
Returns true if the current running homebridge version is greater or equal to the passed version string.
Example:

We assume the homebridge version 1.3.0-beta.12 (serverVersion) and the following example calls below
```
 versionGreaterOrEqual("1.2.0"); // will return true
 versionGreaterOrEqual("1.3.0"); // will return false (the RELEASE version 1.3.0 is bigger than the BETA version 1.3.0-beta.12)
 versionGreaterOrEqual("1.3.0-beta.8); // will return true
```
Parameters
- version: string
Returns boolean