Class HAPServer

constructor

• new HAPServer(accessoryInfo): HAPServer

• Parameters

  • accessoryInfo: AccessoryInfo

  Returns HAPServer

allowInsecureRequest

destroy

• destroy(): void

• Returns void

emit

• emit(event, port, address): boolean

• Parameters

  • event: "listening"
  • port: number
  • address: string

  Returns boolean

• emit(event, callback): boolean

• Parameters

  • event: "identify"
  • callback: VoidCallback

  Returns boolean

• emit(event, connection, username, publicKey, permission, callback): boolean

• Parameters

  • event: "add-pairing"
  • connection: HAPConnection
  • username: string
  • publicKey: Buffer
  • permission: PermissionTypes
  • callback: AddPairingCallback

  Returns boolean

• emit(event, connection, username, callback): boolean

• Parameters

  • event: "remove-pairing"
  • connection: HAPConnection
  • username: string
  • callback: RemovePairingCallback

  Returns boolean

• emit(event, connection, callback): boolean

• Parameters

  • event: "list-pairings"
  • connection: HAPConnection
  • callback: ListPairingsCallback

  Returns boolean

• emit(event, username, clientLTPK, callback): boolean

• Parameters

  • event: "pair"
  • username: string
  • clientLTPK: Buffer
  • callback: VoidCallback

  Returns boolean

• emit(event, connection, callback): boolean

• Parameters

  • event: "accessories"
  • connection: HAPConnection
  • callback: AccessoriesCallback

  Returns boolean

• emit(event, connection, request, callback): boolean

• Parameters

  • event: "get-characteristics"
  • connection: HAPConnection
  • request: CharacteristicsReadRequest
  • callback: ReadCharacteristicsCallback

  Returns boolean

• emit(event, connection, request, callback): boolean

• Parameters

  • event: "set-characteristics"
  • connection: HAPConnection
  • request: CharacteristicsWriteRequest
  • callback: WriteCharacteristicsCallback

  Returns boolean

• emit(event, resource, callback): boolean

• Parameters

  • event: "request-resource"
  • resource: ResourceRequest
  • callback: ResourceRequestCallback

  Returns boolean

• emit(event, connection): boolean

• Parameters

  • event: "connection-closed"
  • connection: HAPConnection

  Returns boolean

listen

• listen(port?, host?): void

• Parameters

  • port: number = 0
  • Optionalhost: string

  Returns void

on

• on(event, listener): this

• Parameters

  • event: "listening"
  • listener: ((port: number, address: string) => void)
    • • (port, address): void

      • Parameters

        • port: number
        • address: string

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "identify"
  • listener: ((callback: VoidCallback) => void)
    • • (callback): void

      • Parameters

        • callback: VoidCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "add-pairing"
  • listener: ((connection: HAPConnection, username: string, publicKey: Buffer, permission: PermissionTypes, callback: AddPairingCallback) => void)
    • • (connection, username, publicKey, permission, callback): void

      • Parameters

        • connection: HAPConnection
        • username: string
        • publicKey: Buffer
        • permission: PermissionTypes
        • callback: AddPairingCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "remove-pairing"
  • listener: ((connection: HAPConnection, username: string, callback: RemovePairingCallback) => void)
    • • (connection, username, callback): void

      • Parameters

        • connection: HAPConnection
        • username: string
        • callback: RemovePairingCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "list-pairings"
  • listener: ((connection: HAPConnection, callback: ListPairingsCallback) => void)
    • • (connection, callback): void

      • Parameters

        • connection: HAPConnection
        • callback: ListPairingsCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "pair"
  • listener: ((username: string, clientLTPK: Buffer, callback: VoidCallback) => void)
    • • (username, clientLTPK, callback): void

      • Parameters

        • username: string
        • clientLTPK: Buffer
        • callback: VoidCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "accessories"
  • listener: ((connection: HAPConnection, callback: AccessoriesCallback) => void)
    • • (connection, callback): void

      • Parameters

        • connection: HAPConnection
        • callback: AccessoriesCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "get-characteristics"
  • listener: ((connection: HAPConnection, request: CharacteristicsReadRequest, callback: ReadCharacteristicsCallback) => void)
    • • (connection, request, callback): void

      • Parameters

        • connection: HAPConnection
        • request: CharacteristicsReadRequest
        • callback: ReadCharacteristicsCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "set-characteristics"
  • listener: ((connection: HAPConnection, request: CharacteristicsWriteRequest, callback: WriteCharacteristicsCallback) => void)
    • • (connection, request, callback): void

      • Parameters

        • connection: HAPConnection
        • request: CharacteristicsWriteRequest
        • callback: WriteCharacteristicsCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "request-resource"
  • listener: ((resource: ResourceRequest, callback: ResourceRequestCallback) => void)
    • • (resource, callback): void

      • Parameters

        • resource: ResourceRequest
        • callback: ResourceRequestCallback

        Returns void

  Returns this

• on(event, listener): this

• Parameters

  • event: "connection-closed"
  • listener: ((connection: HAPConnection) => void)
    • • (connection): void

      • Parameters

        • connection: HAPConnection

        Returns void

  Returns this

sendEventNotifications

• sendEventNotifications(aid, iid, value, originator?, immediateDelivery?): 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.
  • Optionaloriginator: HAPConnection

    If specified, the connection will not get an event message.
  • OptionalimmediateDelivery: boolean

    The HAP spec requires some characteristics to be delivery immediately. Namely, for the Characteristic.ButtonEvent and the Characteristic.ProgrammableSwitchEvent characteristics.

  Returns void

stop

• stop(): void

• Returns void