程序包 me.hekr.iotos.api

类 IotClient

java.lang.Object

me.hekr.iotos.api.IotClient

public class IotClient
extends Object

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	IotClient.Builder

方法概要

修饰符和类型	方法	说明
DeviceApiDTO	addDevice(DeviceAddReq reqDto)	新增设备
AddTopoResp	addTopo(String pk, String devId, TopoSub sub)	网关添加子设备
String	assembleToken(String path, String timestamp, String method, String accessKey, String accessSecret)
Map<String,Object>	batchAddDevices(DevIdListReq devIdListReq)	导入设备
static IotClient.Builder	builder()
CloudSendMsgDTO	cloudSendMsgInfo(String messageId)	查询命令状态
Pagec<CloudSendMsgDTO>	cloudSendMsgList(Integer page, Integer size, String pk, String devId, Long startTime, Long endTime)	查询历史控制命令
DeviceApiDTO	createDevice(DeviceAddReq addReq)	创建设备
void	delDevice(String pk, String devId, boolean delSnapshot)	删除设备
DelTopoResp	delTopo(String pk, String devId, TopoSub sub)	网关删除子设备
KlinkResp	deviceCloudSend(String pk, String devId, ModelData data)	下发控制命令
DeviceApiDTO	deviceInfo(String pk, String devId)	查询设备详情
static <T> T	execute(retrofit2.Call<T> call)
List<ProductDTO>	getAllProducts()	获取所有产品信息
List<DeviceApiDTO>	getBatchDevices(String pk, String batchName)	获取批次下所有设备
DeviceApiDTO	getDevice(String pk, String devId)	获取设备信息
DeviceAggPacketResp	getDeviceAggData(AggDataQuery query)	查询设备指标聚合
List<DevicePacketResp>	getDeviceHistoryData(String pk, String devId, Long startTime, Long endTime, String action, String cmd, int page, int size)	查询历史上下行数
Pagec<DeviceApiDTO>	getDeviceList(String pk, String keyword, int page, DeviceType deviceType, Boolean online, int size)	查询设备列表
Snapshot	getDeviceSnapshot(String pk, String devId)	查询设备影子
List<DeviceStatusRes>	getDeviceStatus(DevIdListReq req)	获取鉴权信息
List<ParamValue>	getParamValue(ParamValueQuery req)	查询设备指标趋势
Pagec<ProductDTO>	getProduct(int page, int size)	获取产品列表
ModelProtocolDTO	getProtocol(String pk)
String	getToken(String path, String accessKey, String accessSecret)
byte[]	hmacSHA1Encrypt(String encryptText, String encryptKey)
String	parseByte2HexStr(byte[] buf)
<T> T	register(Class<T> clazz)
void	updateName(DeviceUpdateNameReq req)	更改设备名称

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

builder

public static IotClient.Builder builder()

execute

public static <T> T execute(retrofit2.Call<T> call)

register

public <T> T register(Class<T> clazz)

getAllProducts

public List<ProductDTO> getAllProducts()

获取所有产品信息

返回:

产品列表

createDevice

public DeviceApiDTO createDevice(DeviceAddReq addReq)

创建设备

参数:

addReq - 设备信息

返回:

添加的设备信息

getDevice

public DeviceApiDTO getDevice(String pk,
                              String devId)

获取设备信息

参数:

pk - pk

devId - 设备ID

返回:

Device

getProtocol

public ModelProtocolDTO getProtocol(String pk)

getToken

public String getToken(String path,
                       String accessKey,
                       String accessSecret)

hmacSHA1Encrypt

public byte[] hmacSHA1Encrypt(String encryptText,
                              String encryptKey)
                       throws Exception

抛出:

Exception

parseByte2HexStr

public String parseByte2HexStr(byte[] buf)

assembleToken

public String assembleToken(String path,
                            String timestamp,
                            String method,
                            String accessKey,
                            String accessSecret)
                     throws Exception

抛出:

Exception

getProduct

public Pagec<ProductDTO> getProduct(int page,
                                    int size)

获取产品列表

获取产品列表

参数:

page - 当前页，从0开始

size - 分页大小，最大100，最小1

返回:

产品

getBatchDevices

public List<DeviceApiDTO> getBatchDevices(String pk,
                                          String batchName)

获取批次下所有设备

获取批次下所有设备

参数:

pk - 产品PK

batchName - 批次名称

返回:

设备列表

updateName

public void updateName(DeviceUpdateNameReq req)

更改设备名称

更改设备名称

参数:

req - 设备信息（pk，devId，name）

getDeviceStatus

public List<DeviceStatusRes> getDeviceStatus(DevIdListReq req)

获取鉴权信息

获取鉴权信息

参数:

req - 设备信息（pk，devId，name）

返回:

鉴权信息

getParamValue

public List<ParamValue> getParamValue(ParamValueQuery req)

查询设备指标趋势

查询设备指标趋势

参数:

req - 设备信息（pk，devId，name）

返回:

设备信息列表

addDevice

public DeviceApiDTO addDevice(DeviceAddReq reqDto)

新增设备

新增设备

参数:

reqDto - 设备信息（pk，devId，name）

返回:

设备信息

batchAddDevices

public Map<String,Object> batchAddDevices(DevIdListReq devIdListReq)

导入设备

导入设备

参数:

devIdListReq - （产品PK和设备ID列表）

返回:

包含批次名称和添加数量

getDeviceList

public Pagec<DeviceApiDTO> getDeviceList(String pk,
                                         String keyword,
                                         int page,
                                         DeviceType deviceType,
                                         Boolean online,
                                         int size)

查询设备列表

查询设备列表

参数:

pk - 产品PK

keyword - 搜索关键词

page - 当前页面，最大100，最小1

deviceType - 节点类型（普通设备：GENERAL；中继设备：SWITCH；网关设备：GATEWAY；终端子设备：TERMINAL）

online - 是否在线，true为在线

size - 分页大小，默认10，

返回:

设备信息

deviceInfo

public DeviceApiDTO deviceInfo(String pk,
                               String devId)

查询设备详情

查询设备详情

参数:

pk - 产品PK

devId - 设备ID

返回:

设备信息

getDeviceSnapshot

public Snapshot getDeviceSnapshot(String pk,
                                  String devId)

查询设备影子

查询设备影子

参数:

pk - 产品PK

devId - 设备ID

返回:

设备影子

delDevice

public void delDevice(String pk,
                      String devId,
                      boolean delSnapshot)

删除设备

删除设备

参数:

pk - 产品PK

devId - 设备ID

delSnapshot - 是否删除设备影子

getDeviceHistoryData

public List<DevicePacketResp> getDeviceHistoryData(String pk,
                                                   String devId,
                                                   Long startTime,
                                                   Long endTime,
                                                   String action,
                                                   String cmd,
                                                   int page,
                                                   int size)

查询历史上下行数

查询历史上下行数据

参数:

pk - 产品PK

devId - 设备ID

startTime - 开始时间

endTime - 结束时间

action - 事件 (可选)

cmd - 命令 (可选)

page - 当前页 从0开始

size - 分页大小，最大100，最小1

返回:

上下行数据信息

deviceCloudSend

public KlinkResp deviceCloudSend(String pk,
                                 String devId,
                                 ModelData data)

下发控制命令

下发控制命令

参数:

pk - 产品PK

devId - 设备ID

data - （cmd 命令标识符 ，params 参数值）

返回:

指令信息

cloudSendMsgInfo

public CloudSendMsgDTO cloudSendMsgInfo(String messageId)

查询命令状态

查询命令状态

参数:

messageId - 所查询命令的ID

返回:

命令信息

cloudSendMsgList

public Pagec<CloudSendMsgDTO> cloudSendMsgList(Integer page,
                                               Integer size,
                                               String pk,
                                               String devId,
                                               Long startTime,
                                               Long endTime)

查询历史控制命令

查询历史控制命令

参数:

page - 当前页面，最小0

size - 分页大小，最大100，最小0

pk - 产品PK

devId - 设备ID

startTime - 查询开始时间

endTime - 查询结束事件

返回:

命令信息

addTopo

public AddTopoResp addTopo(String pk,
                           String devId,
                           TopoSub sub)

网关添加子设备

网关添加子设备

参数:

pk - 产品PK

devId - 设备ID

sub - 子设备

返回:

添加的子设备信息

delTopo

public DelTopoResp delTopo(String pk,
                           String devId,
                           TopoSub sub)

网关删除子设备

参数:

pk - 产品PK

devId - 设备ID

sub - 子设备

返回:

删除的子设备信息

getDeviceAggData

public DeviceAggPacketResp getDeviceAggData(AggDataQuery query)

查询设备指标聚合

查询设备指标聚合

参数:

query - 查询条件

返回:

DeviceAggPacketResp