更新时间:2023-05-22 06:38:30下载pdf
扫地机 SDK 提供 HTTP/HTTPS 接口请求和实时通道两种数据查询方式。查询、删除历史记录等数据需要请求 HTTP/HTTPS 接口,扫地机清扫中传递的数据可以通过注册实时通道监听查询。
HTTP/HTTPS 类接口采用 智能生活 App SDK 的 通用接口。您需要传入接口名称、接口版本号、入参等。
API 入口
TuyaHomeSdk.getRequestInstance()
代码示例
public interface ITuyaSmartRequest {
/**
*
* @param apiName 接口名称
* @param version 接口版本号
* @param postData 发送数据
* @param callback 接口回调
* @param object 接收回调数据的数据结构,例如相应的 Java Bean
*/
<T> void requestWithApiName(String apiName, String version, Map<String, Object> postData, Class<T> object, final ITuyaDataCallback<T> callback);
<T> void requestWithApiNameWithoutSession(String apiName, String version, Map<String, Object> postData, Class<T> object, final ITuyaDataCallback<T> callback);
void onDestroy();
}
请求参数
apiName:tuya.m.device.media.latest
version:2.0
postData:
{
"devId": "xxx",
"start":"",
"size": 500
}
返回示例
{
"devId": "xxx",
"startRow": "mtnva58ee6817b605ddcc6_35_1535629239586",
"dataList": [ "373702373700", "383702383802373901383901383800"],
"subRecordId": 35,
"hasNext": true,
"startTime": 1535629049,
"endTime": 1535629244,
"status": 2
}
请求参数
apiName:tuya.m.sweeper.cleaning.history.get
version:1.0
postData:
字段 | 类型 | 描述 |
---|---|---|
devId | String | 设备 ID |
offset | Integer | 偏移值 |
limit | Integer | 分页数量 |
startTime | Long | 开始时间 |
endTime | Long | 结束时间 |
返回示例
{
"datas":[{
"recordId":"162992AAXKaZCdL2tDvVcWYecT9AA9630150",
"gid":38498424,
"dpId":15,
"gmtCreate":1629929630203,
"value":"20210826052504804100145",
"uuid":"ecc8c633ef1d9ede"
}],
"totalCount":1
}
字段 | 类型 | 描述 |
---|---|---|
recordId | String | 地图的唯一 ID |
gid | int | 家庭组 ID |
dpId | int | 扫地机产品在涂鸦 IoT 平台配置的清扫记录的 DP ID |
gmtCreate | long | 创建时间 |
value | String | 地图信息,用来解析 subRecordId |
uuid | String | 设备唯一 ID |
请求参数
apiName:tuya.m.device.media.detail
version:2.0
postData:
{
"devId": "xxx",
"subRecordId": 31,
"start":"",
"size": 500
}
字段 | 类型 | 描述 |
---|---|---|
devId | String | 设备 ID |
subRecordId | Integer | 清扫记录 ID,通过解析历史记录列表的 value 数据,根据数据长度使用不同的解析规则,规则见下表 |
start | String | 第一次传空串,后面取下一页时填上一页返回值里的 startRow 值 |
size | Integer | 请求数据大小 |
value
解析协议
记录时间 长度 12 位 |
清扫时间 长度 3 位 |
清扫面积 长度 3 位 |
subRecordId 长度 5 位 |
举例 | 说明 |
---|---|---|---|---|---|
有 | 有 | 有 | 有 | 20200319202500300200123 |
|
没有 | 有 | 有 | 有 | 00300200123 |
|
有 | 有 | 有 | 没有 | 202003192025003002 |
|
没有 | 有 | 有 | 没有 | 003002 |
|
返回示例
{
"devId": "xxx",
"startRow": "mtnva58ee6817b605ddcc6_31_1535622776561",
"dataList": ["3e3f02403e013e3f00", "3f3f024040013f3f00"],
"subRecordId": 31,
"hasNext": true,
"startTime": 1535621566,
"endTime": 1535623017,
"status": 2
}
字段 | 类型 | 描述 |
---|---|---|
startRow | String | 下次请求传入的 Start 值 |
subRecordId | Integer | 清扫记录 ID |
startTime | String | 开始时间 |
endTime | String | 结束时间 |
hasNext | Boolean | 是否有下一页 |
最多可以删除 100 条记录。
请求参数
apiName:tuya.m.sweeper.cleaning.history.delete
version:1.0
postData:
{
"devId": "xxx",
"uuid": "15607600058B81A6C4A0273FDD61091D0B02403848501,
15607600058B81A6C4A0273FDD61091D0B0240384850"、
}
以上 JSON 片段中的 uuid
是清扫记录唯一标识,不是设备 uuid
,而是历史记录的 recordId
。
返回示例
{
"result":true,
"success":true,
"status":"ok",
"t":1557740732829
}
注册实时数据通道监听设备数据流上报,返回数据是数组形式,根据机器协议解析成可用数据,如 x 坐标、y 坐标、颜色值等。
API 入口:TuyaHomeSdk.getTransferInstance();
接口说明
void registerTransferDataListener(ITuyaDataCallback<TransferDataBean> callback);
代码示例
TuyaHomeSdk.getTransferInstance().registerTransferDataListener(new ITuyaDataCallback<TransferDataBean>() {
@Override
public void onSuccess(TransferDataBean result) {
}
@Override
public void onError(String errorCode, String errorMessage) {
}
});
TransferDataBean
字段 | 类型 | 描述 |
---|---|---|
data | byte[] |
|
devId | String | 设备 ID |
接口说明
void unRegisterTransferDataListener(ITuyaDataCallback<TransferDataBean> callback);
代码示例
TuyaHomeSdk.getTransferInstance().unRegisterTransferDataListener(this);
该内容对您有帮助吗?
是意见反馈该内容对您有帮助吗?
是意见反馈