Class HAPServer

The actual HAP server that iOS devices talk to.

Notes

It turns out that the IP-based version of HomeKit's HAP protocol operates over a sort of pseudo-HTTP. Accessories are meant to host a TCP socket server that initially behaves exactly as an HTTP/1.1 server. So iOS devices will open up a long-lived connection to this server and begin issuing HTTP requests. So far, this conforms with HTTP/1.1 Keepalive. However, after the "pairing" process is complete, the connection is expected to be "upgraded" to support full-packet encryption of both HTTP headers and data. This encryption is NOT SSL. It is a customized ChaCha20+Poly1305 encryption layer.

Additionally, this "HTTP Server" supports sending "event" responses at any time without warning. The iOS device simply keeps the connection open after it's finished with HTTP request/response traffic, and while the connection is open, the server can elect to issue "EVENT/1.0 200 OK" HTTP-style responses. These are typically sent to inform the iOS device of a characteristic change for the accessory (like "Door was Unlocked").

See EventedHTTPServer for more detail on the implementation of this protocol.

Hierarchy

EventEmitter
- HAPServer

Index

Constructors

constructor

new HAPServer(accessoryInfo: AccessoryInfo): HAPServer
Parameters
- accessoryInfo: AccessoryInfo
Returns HAPServer
- Defined in lib/HAPServer.ts:359

Properties

allowInsecureRequest

allowInsecureRequest: boolean

Methods

destroy

destroy(): void
Returns void
- Defined in lib/HAPServer.ts:384

emit

emit(event: "listening", port: number, address: string): boolean
Parameters
- event: "listening"
- port: number
- address: string
Returns boolean
- Defined in lib/HAPServer.ts:307
emit(event: "identify", callback: VoidCallback): boolean
Parameters
- event: "identify"
- callback: VoidCallback
Returns boolean
- Defined in lib/HAPServer.ts:308
emit(event: "add-pairing", connection: HAPConnection, username: string, publicKey: Buffer, permission: PermissionTypes, callback: AddPairingCallback): boolean
Parameters
- event: "add-pairing"
- connection: HAPConnection
- username: string
- publicKey: Buffer
- permission: PermissionTypes
- callback: AddPairingCallback
Returns boolean
- Defined in lib/HAPServer.ts:310
emit(event: "remove-pairing", connection: HAPConnection, username: string, callback: RemovePairingCallback): boolean
Parameters
- event: "remove-pairing"
- connection: HAPConnection
- username: string
- callback: RemovePairingCallback
Returns boolean
- Defined in lib/HAPServer.ts:318
emit(event: "list-pairings", connection: HAPConnection, callback: ListPairingsCallback): boolean
Parameters
- event: "list-pairings"
- connection: HAPConnection
- callback: ListPairingsCallback
Returns boolean
- Defined in lib/HAPServer.ts:319
emit(event: "pair", username: string, clientLTPK: Buffer, callback: VoidCallback): boolean
Parameters
- event: "pair"
- username: string
- clientLTPK: Buffer
- callback: VoidCallback
Returns boolean
- Defined in lib/HAPServer.ts:320
emit(event: "accessories", connection: HAPConnection, callback: AccessoriesCallback): boolean
Parameters
- event: "accessories"
- connection: HAPConnection
- callback: AccessoriesCallback
Returns boolean
- Defined in lib/HAPServer.ts:322
emit(event: "get-characteristics", connection: HAPConnection, request: CharacteristicsReadRequest, callback: ReadCharacteristicsCallback): boolean
Parameters
- event: "get-characteristics"
- connection: HAPConnection
- request: CharacteristicsReadRequest
- callback: ReadCharacteristicsCallback
Returns boolean
- Defined in lib/HAPServer.ts:323
emit(event: "set-characteristics", connection: HAPConnection, request: CharacteristicsWriteRequest, callback: WriteCharacteristicsCallback): boolean
Parameters
- event: "set-characteristics"
- connection: HAPConnection
- request: CharacteristicsWriteRequest
- callback: WriteCharacteristicsCallback
Returns boolean
- Defined in lib/HAPServer.ts:324
emit(event: "request-resource", resource: ResourceRequest, callback: ResourceRequestCallback): boolean
Parameters
- event: "request-resource"
- resource: ResourceRequest
- callback: ResourceRequestCallback
Returns boolean
- Defined in lib/HAPServer.ts:325
emit(event: "connection-closed", connection: HAPConnection): boolean
Parameters
- event: "connection-closed"
- connection: HAPConnection
Returns boolean
- Defined in lib/HAPServer.ts:327

listen

listen(port?: number, host?: string): void
Parameters
- port: number = 0
- Optional host: string
Returns void
- Defined in lib/HAPServer.ts:370

on

on(event: "listening", listener: ((port: number, address: string) => void)): HAPServer
Parameters
- event: "listening"
- listener: ((port: number, address: string) => void)
  - - (port: number, address: string): void
    - Parameters
      
      port: number
      
      address: string
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:282
on(event: "identify", listener: ((callback: VoidCallback) => void)): HAPServer
Parameters
- event: "identify"
- listener: ((callback: VoidCallback) => void)
  - - (callback: VoidCallback): void
    - Parameters
      
      callback: VoidCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:283
on(event: "add-pairing", listener: ((connection: HAPConnection, username: string, publicKey: Buffer, permission: PermissionTypes, callback: AddPairingCallback) => void)): HAPServer
Parameters
- event: "add-pairing"
- listener: ((connection: HAPConnection, username: string, publicKey: Buffer, permission: PermissionTypes, callback: AddPairingCallback) => void)
  - - (connection: HAPConnection, username: string, publicKey: Buffer, permission: PermissionTypes, callback: AddPairingCallback): void
    - Parameters
      
      connection: HAPConnection
      
      username: string
      
      publicKey: Buffer
      
      permission: PermissionTypes
      
      callback: AddPairingCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:285
on(event: "remove-pairing", listener: ((connection: HAPConnection, username: string, callback: RemovePairingCallback) => void)): HAPServer
Parameters
- event: "remove-pairing"
- listener: ((connection: HAPConnection, username: string, callback: RemovePairingCallback) => void)
  - - (connection: HAPConnection, username: string, callback: RemovePairingCallback): void
    - Parameters
      
      connection: HAPConnection
      
      username: string
      
      callback: RemovePairingCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:289
on(event: "list-pairings", listener: ((connection: HAPConnection, callback: ListPairingsCallback) => void)): HAPServer
Parameters
- event: "list-pairings"
- listener: ((connection: HAPConnection, callback: ListPairingsCallback) => void)
  - - (connection: HAPConnection, callback: ListPairingsCallback): void
    - Parameters
      
      connection: HAPConnection
      
      callback: ListPairingsCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:290
on(event: "pair", listener: ((username: string, clientLTPK: Buffer, callback: VoidCallback) => void)): HAPServer
Parameters
- event: "pair"
- listener: ((username: string, clientLTPK: Buffer, callback: VoidCallback) => void)
  - - (username: string, clientLTPK: Buffer, callback: VoidCallback): void
    - Parameters
      
      username: string
      
      clientLTPK: Buffer
      
      callback: VoidCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:291
on(event: "accessories", listener: ((connection: HAPConnection, callback: AccessoriesCallback) => void)): HAPServer
Parameters
- event: "accessories"
- listener: ((connection: HAPConnection, callback: AccessoriesCallback) => void)
  - - (connection: HAPConnection, callback: AccessoriesCallback): void
    - Parameters
      
      connection: HAPConnection
      
      callback: AccessoriesCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:293
on(event: "get-characteristics", listener: ((connection: HAPConnection, request: CharacteristicsReadRequest, callback: ReadCharacteristicsCallback) => void)): HAPServer
Parameters
- event: "get-characteristics"
- listener: ((connection: HAPConnection, request: CharacteristicsReadRequest, callback: ReadCharacteristicsCallback) => void)
  - - (connection: HAPConnection, request: CharacteristicsReadRequest, callback: ReadCharacteristicsCallback): void
    - Parameters
      
      connection: HAPConnection
      
      request: CharacteristicsReadRequest
      
      callback: ReadCharacteristicsCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:294
on(event: "set-characteristics", listener: ((connection: HAPConnection, request: CharacteristicsWriteRequest, callback: WriteCharacteristicsCallback) => void)): HAPServer
Parameters
- event: "set-characteristics"
- listener: ((connection: HAPConnection, request: CharacteristicsWriteRequest, callback: WriteCharacteristicsCallback) => void)
  - - (connection: HAPConnection, request: CharacteristicsWriteRequest, callback: WriteCharacteristicsCallback): void
    - Parameters
      
      connection: HAPConnection
      
      request: CharacteristicsWriteRequest
      
      callback: WriteCharacteristicsCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:298
on(event: "request-resource", listener: ((resource: ResourceRequest, callback: ResourceRequestCallback) => void)): HAPServer
Parameters
- event: "request-resource"
- listener: ((resource: ResourceRequest, callback: ResourceRequestCallback) => void)
  - - (resource: ResourceRequest, callback: ResourceRequestCallback): void
    - Parameters
      
      resource: ResourceRequest
      
      callback: ResourceRequestCallback
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:302
on(event: "connection-closed", listener: ((connection: HAPConnection) => void)): HAPServer
Parameters
- event: "connection-closed"
- listener: ((connection: HAPConnection) => void)
  - - (connection: HAPConnection): void
    - Parameters
      
      connection: HAPConnection
      
      Returns void
Returns HAPServer
- Defined in lib/HAPServer.ts:304

sendEventNotifications

sendEventNotifications(aid: number, iid: number, value: Nullable<CharacteristicValue>, originator?: HAPConnection, immediateDelivery?: boolean): void
Send an even notification for given characteristic and changed value to all connected clients. If originator is specified, the given HAPConnection will be excluded from the broadcast.
Parameters
- aid: number
  
  The accessory id of the updated characteristic.
- iid: number
  
  The instance id of the updated characteristic.
- value: Nullable<CharacteristicValue>
  
  The newly set value of the characteristic.
- Optional originator: HAPConnection
  
  If specified, the connection will not get an event message.
- Optional immediateDelivery: boolean
  
  The HAP spec requires some characteristics to be delivery immediately. Namely, for the ButtonEvent and the ProgrammableSwitchEvent characteristics.
Returns void
- Defined in lib/HAPServer.ts:400

stop

stop(): void
Returns void
- Defined in lib/HAPServer.ts:380

Class HAPServer

Notes

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

accessoryInfo: AccessoryInfo

Returns HAPServer

Properties

allowInsecureRequest

Methods

destroy

Returns void

emit

Parameters

event: "listening"

port: number

address: string

Returns boolean

Parameters

event: "identify"

callback: VoidCallback

Returns boolean

Parameters

event: "add-pairing"

connection: HAPConnection

username: string

publicKey: Buffer

permission: PermissionTypes

callback: AddPairingCallback

Returns boolean

Parameters

event: "remove-pairing"

connection: HAPConnection

username: string

callback: RemovePairingCallback

Returns boolean

Parameters

event: "list-pairings"

connection: HAPConnection

callback: ListPairingsCallback

Returns boolean

Parameters

event: "pair"

username: string

clientLTPK: Buffer

callback: VoidCallback

Returns boolean

Parameters

event: "accessories"

connection: HAPConnection

callback: AccessoriesCallback

Returns boolean

Parameters

event: "get-characteristics"

connection: HAPConnection

request: CharacteristicsReadRequest

callback: ReadCharacteristicsCallback

Returns boolean

Parameters

event: "set-characteristics"

connection: HAPConnection

request: CharacteristicsWriteRequest

callback: WriteCharacteristicsCallback

Returns boolean

Parameters

event: "request-resource"

resource: ResourceRequest

callback: ResourceRequestCallback

Returns boolean

Parameters

event: "connection-closed"

connection: HAPConnection

Returns boolean

listen

Parameters

`Optional` host: string