getFitBleKeyList()

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

Description

Get the accessory's Bluetooth key list.

Parameters

None

Return Value

Type: Promise<FitBleKeyItem[]>
Bluetooth key list
FitBleKeyItem
PropertyTypeDescription
idstringKey ID
unlockBindingIdstringUnlock binding ID (used for rename/update/delete)
namestringKey name
opModeSubTypenumberSubtype; in the Bluetooth key scenario, `10` is a permanent key, other values are temporary keys.
Validity configuration (time/period)
snnumberHardware ID
userNamestringUsername (permanent key scenario)
devNameListstring[]List of associated lock names

Referenced Types

interfaceEffectiveConfig
PropertyTypeDescription
effectiveDatenumberEffective date (seconds-level timestamp)
expiredDatenumberExpiration date (seconds-level timestamp)
repeat"none" | "week"Repeat policy: none or weekly
weeksWeekWeekly repeat bitmap
effectiveTimenumberDaily start time (minutes)
expiredTimenumberDaily end time (minutes)
typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

Valid Values

EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--

Examples

import { getFitBleKeyList } from '@ray-js/lock-sdk';
const list = await getFitBleKeyList();