getBoundLockList()

Requires:
@ray-js/lock-sdk≥1.2.0

Description

Get the list of locks bound to the current accessory; each item includes a security version compatibility check

Parameters

None

Return Value

Type: Promise<BoundLockListItem[]>
List of bound locks
BoundLockListItem
PropertyTypeDescription
securityVersionMismatchbooleanWhether the lock’s security version is incompatible with the accessory (the lock supports the security version but the accessory has not enabled the secure channel)
securityNeedUpdatebooleanWhether the lock needs to be "activated" (re-provision security keys)
bindingIdstringBinding ID
devNamestringDevice name
fittingNamestringAccessory name
devIdstringDevice ID
devUnlockIdstringDevice unlock ID
devUuidstringDevice UUID
fittingIdstringAccessory ID
fittingUnlockIdstringAccessory unlock ID
iconstringIcon
isSupportScybooleanWhether scy is supported
onlinebooleanWhether online
protocolVersionstringProtocol version
randomStrstringRandom string

Examples

import { getBoundLockList } from '@ray-js/lock-sdk';
const lockList = await getBoundLockList();
console.log(lockList.filter(item => item.securityVersionMismatch));