智能小程序 Ray 开发 —— 激光扫地机 API 接口汇总

清扫记录 

获取清扫记录列表

getCleaningRecords

引入

@ray-js/ray^1.5.23 且 基础库版 2.21.0 以上版本可使用

import { getCleaningRecords } from '@ray-js/ray';

参数

GetCleaningRecordsParams

获取清扫记录列表查询条件。

参数属性 GetRecipeCollectionListParams

属性	类型	默认值	必填	说明
devId	string		是	设备Id
startTime	number		是	开始时间
endTime	number		是	结束时间
limit	number		是	返回的数据长度限制
offset	number		是	偏移量
fileType	number		否	默认'pic'

返回

GetCleaningRecordsResponse

获取清扫记录列表返回值。

属性	类型	说明
datas	CleaningRecord[]	清扫记录列表
totalCount	number	清扫记录总长度

CleaningRecord

属性	类型	说明
id	number	清扫记录的唯一ID
time	number	清扫时间
file	string	清扫记录文件地址
bucket	string	清扫记录文件所在的bucket
extend	string	清扫信息
devId	string	设备Id
fileType	string	文件类型

函数定义示例

/**
 * 获取清扫记录列表
 * @param {GetCleaningRecordsParams} params - 获取清扫记录列表请求参数
 * @returns {Promise<GetCleaningRecordsResponse>} - 获取清扫记录列表响应的 Promise 对象
 */
export const getCleaningRecords: (
  params: GetCleaningRecordsParams
) => Promise<GetCleaningRecordsResponse>;

---

删除清扫记录

deleteCleaningRecord

引入

@ray-js/ray^1.5.23 且基础库版本 2.21.0 以上版本可使用

import { deleteCleaningRecord } from '@ray-js/ray';

参数

DeleteCleaningRecordParams

删除清扫记录的请求参数。

属性	类型	默认值	必填	说明
devId	string		是	设备 Id
fileIds	number[]		是	要删除的记录 Id 数组

返回

DeleteCleaningRecordResponse

删除清扫记录的响应值，表示删除操作是否成功。

类型	说明
boolean	删除操作是否成功

函数定义示例

/**
 * 删除清扫记录
 * @param {DeleteCleaningRecordParams} params - 删除清扫记录请求参数
 * @returns {Promise<DeleteCleaningRecordResponse>} - 删除清扫记录结果的 Promise 对象
 */
export const deleteCleaningRecord: (
  params: DeleteCleaningRecordParams
) => Promise<DeleteCleaningRecordResponse>;

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

 

机器语音

获取扫地机的语音包列表

getVoiceList

引入

@ray-js/ray^1.5.23 且基础库版本 2.21.0 以上版本可使用

import { getVoiceList } from '@ray-js/ray';

参数

GetVoiceListParams

获取扫地机语音包列表的请求参数。

属性	类型	默认值	必填	说明
devId	string		是	设备 Id
deviceId	string		否	设备 Id（兼容字段）
offset	number		是	分页偏移量，一般配置的语言包不多，可以不使用分页查询，传 0 即可
limit	number		是	每页大小，建议传入 100

返回

GetVoiceListResponse

获取扫地机语音包列表的响应值。

属性	类型	说明
datas	VoiceData[]	语音包数据数组
pageNo	number	当前页码
totalCount	number	数据总数

VoiceData

属性	类型	说明
auditionUrl	string	试听链接
desc	string	描述（可选）
extendData	ExtendData	扩展数据
id	number	语音包 ID
imgUrl	string	图片链接
name	string	名称
officialUrl	string	官方链接
productId	string	产品 ID
region	string[]	区域代码数组

ExtendData

属性	类型	说明
extendId	number	扩展 ID，用于与设备上报的语言包 ID 进行对比，判断语音包是否正在使用
version	string	版本号

函数定义示例

/**
 * 获取扫地机的语音包列表
 * @param {GetVoiceListParams} params - 获取扫地机的语音包列表请求参数
 * @returns {Promise<GetVoiceListResponse>} - 获取扫地机语音包列表结果的 Promise 对象
 */
export const getVoiceList: (
  params: GetVoiceListParams
) => Promise<GetVoiceListResponse>;

 

多地图

获取扫地机的历史地图

getMultipleMapFiles

引入

@ray-js/ray^1.5.23 且基础库版本 2.21.0 以上版本可使用

import { getMultipleMapFiles } from '@ray-js/ray';

参数

GetMultipleMapFilesParams

获取扫地机历史地图的请求参数。

属性	类型	默认值	必填	说明
devId	string		是	设备 Id

返回

GetMultipleMapFilesResponse

获取扫地机历史地图的响应值。

属性	类型	说明
datas	MapFileData[]	历史地图列表
totalCount	number	数据总数

MapFileData

属性	类型	说明
bucket	string	存储文件的存储桶
extend	string	文件的附加信息
time	number	文件的时间戳
id	number	文件的唯一标识符
file	string	文件路径或地址
devId	string	与文件关联的设备 ID
fileType	string	文件类型

函数定义示例

/**
 * 获取扫地机的历史地图
 * @param {GetMultipleMapFilesParams} params - 获取扫地机的历史地图请求参数
 * @returns {Promise<GetMultipleMapFilesResponse>} - 获取扫地机历史地图结果的 Promise 对象
 */
export const getMultipleMapFiles: (
  params: GetMultipleMapFilesParams
) => Promise<GetMultipleMapFilesResponse>;

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