Class HAPServer

constructor

• new HAPServer(accessoryInfo: AccessoryInfo): HAPServer

  Parameters

  • accessoryInfo: AccessoryInfo

  Returns HAPServer

allowInsecureRequest

destroy

• destroy(): void

  Returns void

emit

• emit(event: "listening", port: number, address: string): boolean

  Parameters

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

  Returns boolean

• emit(event: "identify", callback: VoidCallback): boolean

  Parameters

  • event: "identify"
  • callback: VoidCallback

  Returns boolean

• 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

• emit(
      event: "remove-pairing",
      connection: HAPConnection,
      username: string,
      callback: RemovePairingCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "list-pairings",
      connection: HAPConnection,
      callback: ListPairingsCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "pair",
      username: string,
      clientLTPK: Buffer,
      callback: VoidCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "accessories",
      connection: HAPConnection,
      callback: AccessoriesCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "get-characteristics",
      connection: HAPConnection,
      request: CharacteristicsReadRequest,
      callback: ReadCharacteristicsCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "set-characteristics",
      connection: HAPConnection,
      request: CharacteristicsWriteRequest,
      callback: WriteCharacteristicsCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(
      event: "request-resource",
      resource: ResourceRequest,
      callback: ResourceRequestCallback,
  ): boolean

  Parameters

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

  Returns boolean

• emit(event: "connection-closed", connection: HAPConnection): boolean

  Parameters

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

  Returns boolean

listen

• listen(port?: number, host?: string): void

  Parameters

  • port: number = 0
  • Optionalhost: string

  Returns void

on

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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.
  • 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