智能小程序 Ray 开发门锁 API ——设备 API 接口汇总

设置设备属性

setDeviceProperties

引入

@ray-js/ray^1.5.0 以上版本可使用

import { setDeviceProperties } from '@ray-js/ray'

参数

SetDevicePropertiesParams

属性	类型	必填	说明
devId	string	是	设备 ID
propKvs	string	是	JSON 字符串，例如：{"LOST_ALERTER_HELPER": true}

返回

SetDevicePropertiesResponse

boolean，表示设置是否成功。

函数定义示例

/**
 * 设置设备属性
 */
export function setDeviceProperties(
  params: SetDevicePropertiesParams
): Promise<SetDevicePropertiesResponse>

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

查看设置的设备属性

getDeviceProperties

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getDeviceProperties } from '@ray-js/ray'

参数

GetDevicePropertiesParams

属性	类型	必填	说明
devId	string	是	设备 ID
props	string	是	属性代码字符串，多个代码用逗号隔开，如："LOST_ALERTER_HELPER"

返回

GetDevicePropertiesResponse

Record<string, string>，返回参数键值对，key 为属性代码，值为对应状态字符串。

函数定义示例

/**
 * 查看设置的设备属性
 */
export function getDeviceProperties(
  params: GetDevicePropertiesParams
): Promise<GetDevicePropertiesResponse>

获取家庭成员基础信息列表

getMemberList

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getMemberList } from '@ray-js/ray'

参数

MemberListParams

属性	类型	必填	说明
devId	string	是	门锁编号

返回

MemberListResponse

Array<MemberListResponseItem>，包含家庭成员基础信息列表项。

函数定义示例

/**
 * 获取家庭成员基础信息列表
 */
export function getMemberList(params: MemberListParams): Promise<MemberListResponse>

解锁方式同步

syncUnlockMode

引入

@ray-js/ray^1.5.0 以上版本可使用

import { syncUnlockMode } from '@ray-js/ray'

参数

UnlockSyncParams

属性	类型	必填	说明
devId	string	是	门锁编号
dpIds	Array<string>	是	需要同步的解锁方式 dp

返回

UnlockSyncResponse

属性	类型	说明
ins	string	同步指令（仅协议部分）
distributed	number	是否需要下发
dpId	number	dp 点

函数定义示例

/**
 * 解锁方式同步
 */
export function syncUnlockMode(params: UnlockSyncParams): Promise<UnlockSyncResponse>

查询时间对应的格式

queryDateFormat

引入

@ray-js/ray^1.5.0 以上版本可使用

import { queryDateFormat } from '@ray-js/ray'

参数

QueryDateFormatParams

属性	类型	必填	说明
devId	string	是	设备 ID
uiId	string	是	面板 ID

返回

QueryDateFormatResponse

string，日期格式化格式。

函数定义示例

/**
 * 查询时间对应的格式
 */
export function queryDateFormat(params: QueryDateFormatParams): Promise<QueryDateFormatResponse>

用户获取设备自身的激活时间（配网时间）

queryDeviceActiveDate

引入

@ray-js/ray^1.5.0 以上版本可使用

import { queryDeviceActiveDate } from '@ray-js/ray'

参数

QueryActiveDateParams

属性	类型	必填	说明
devId	string	是	设备 ID

返回

QueryActiveDateResponse

string，64 dp password_offline_time 最新数据。

函数定义示例

/**
 * 用户获取设备自身的激活时间（配网时间）
 */
export function queryDeviceActiveDate(
  params: QueryActiveDateParams
): Promise<QueryActiveDateResponse>

获取设备位置

queryDeviceTrackDetails

引入

@ray-js/ray^1.5.0 以上版本可使用

import { queryDeviceTrackDetails } from '@ray-js/ray'

参数

QueryTrackDetailsParams

属性	类型	必填	说明
devId	string	是	设备 ID
startTime	number	是	开始时间
stopTime	number	是	结束时间

返回

QueryTrackDetailsResponse

属性	类型	说明
lat	number	纬度
lng	number	经度

函数定义示例

/**
 * 获取设备位置
 */
export function queryDeviceTrackDetails(
  params: QueryTrackDetailsParams
): Promise<QueryTrackDetailsResponse>

 👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。