Class AccessoryInfo

category

displayName

model

pairedAdminClients

pairedClients

pincode

setupID

signPk

signSk

username

Static ReadonlydeviceIdPattern

addPairedClient

• addPairedClient(username, publicKey, permission): void

• Add a paired client to memory.

  Parameters

  • username: string
  • publicKey: Buffer
  • permission: PermissionTypes

  Returns void

checkForCurrentConfigurationNumberIncrement

• checkForCurrentConfigurationNumberIncrement(configuration, checkFirmwareIncrement?): boolean

• Checks based on the current accessory configuration if the current configuration number needs to be incremented. Additionally, if desired, it checks if the firmware version was incremented (aka the HAP-NodeJS) version did grow.

  Parameters

  • configuration: AccessoryJsonObject[]

    The current accessory configuration.
  • OptionalcheckFirmwareIncrement: boolean

  Returns boolean

  True if the current configuration number was incremented and thus a new TXT must be advertised.

getClientPublicKey

• getClientPublicKey(username): undefined | Buffer

• Parameters

  • username: string

  Returns undefined | Buffer

getConfigVersion

• getConfigVersion(): number

• Returns number

hasAdminPermissions

• hasAdminPermissions(username): boolean

• Parameters

  • username: string

  Returns boolean

isPaired

• isPaired(username): boolean

• Check if username is paired

  Parameters

  • username: string

  Returns boolean

listPairings

• listPairings(): PairingInformation[]

• Returns PairingInformation[]

paired

• paired(): boolean

• Returns boolean

removePairedClient

• removePairedClient(connection, username): void

• Remove a paired client from memory.

  Parameters

  • connection: HAPConnection

    the session of the connection initiated the removal of the pairing
  • username: string

  Returns void

save

• save(): void

• Returns void

updatePermission

• updatePermission(username, permission): void

• Parameters

  • username: string
  • permission: PermissionTypes

  Returns void

StaticassertValidUsername

• assertValidUsername(username): void

• Parameters

  • username: string

  Returns void

Staticcreate

• create(username): AccessoryInfo

• Parameters

  • username: string

  Returns AccessoryInfo

Staticload

• load(username): null | AccessoryInfo

• Parameters

  • username: string

  Returns null | AccessoryInfo

StaticpersistKey

• persistKey(username): string

• Parameters

  • username: string

  Returns string

Staticremove

• remove(username): void

• Parameters

  • username: string

  Returns void