com.huaweicloud.sdk.iot.device.client

类 DeviceClient

java.lang.Object

com.huaweicloud.sdk.iot.device.client.DeviceClient

所有已实现的接口:

RawMessageListener

public class DeviceClient
extends java.lang.Object
implements RawMessageListener

设备客户端，提供和平台的通讯能力，包括： 消息：双向，异步，不需要定义模型 属性：双向，设备可以上报属性，平台可以向设备读写属性，属性需要在模型定义 命令：单向，同步，平台向设备调用设备的命令 事件：双向、异步，需要在模型定义 用户不能直接创建DeviceClient实例，只能先创建IoTDevice实例，然后通过IoTDevice的getClient接口获取DeviceClient实例

构造器概要

构造器

构造器和说明
DeviceClient(ClientConf clientConf, AbstractDevice device)

方法概要

限定符和类型	方法和说明
void	close()
int	connect() 和平台建立连接，此接口为阻塞调用，超时时长60s。
ClientConf	getClientConf()
java.lang.String	getDeviceId() 获取设备id
void	onMessageReceived(RawMessage message) 收到消息通知
void	publishRawMessage(RawMessage rawMessage, ActionListener listener) 发布原始消息，原始消息和设备消息（DeviceMessage）的区别是： 1、可以自定义topic，该topic需要在平台侧配置 2、不限制payload的格式
void	reportDeviceMessage(DeviceMessage deviceMessage, ActionListener listener) 上报设备消息 如果需要上报子设备消息，需要调用DeviceMessage的setDeviceId接口设置为子设备的设备id
void	reportDeviceMessage(DeviceMessage deviceMessage, ActionListener listener, int qos) 上报设备消息，支持指定qos
void	reportEvent(DeviceEvent event, ActionListener listener) 事件上报
void	reportProperties(java.util.List<ServiceProperty> properties, ActionListener listener) 上报设备属性
void	reportSubDeviceProperties(java.util.List<DeviceProperty> deviceProperties, ActionListener listener) 批量上报子设备属性
void	respondCommand(java.lang.String requestId, CommandRsp commandRsp) 上报命令响应
void	respondPropsGet(java.lang.String requestId, java.util.List<ServiceProperty> services) 上报读属性响应
void	respondPropsSet(java.lang.String requestId, IotResult iotResult) 上报写属性响应
void	setCommandListener(CommandListener commandListener) 设置命令监听器，用于接收平台下发的命令。
void	setConnectListener(ConnectListener connectListener) 设置连接监听器，用户接收连接建立和断开事件
void	setDevice(AbstractDevice device)
void	setDeviceMessageListener(DeviceMessageListener deviceMessageListener) 设置消息监听器，用于接收平台下发的消息 此监听器只能接收平台到直连设备的请求，子设备的请求由AbstractGateway处理
void	setPropertyListener(PropertyListener propertyListener) 设置属性监听器，用于接收平台下发的属性读写。
void	subscribeTopic(java.lang.String topic, ActionListener actionListener, RawMessageListener rawMessageListener) 订阅自定义topic。

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

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

构造器详细资料

DeviceClient

public DeviceClient(ClientConf clientConf,
                    AbstractDevice device)

方法详细资料

getClientConf

public ClientConf getClientConf()

connect

public int connect()

和平台建立连接，此接口为阻塞调用，超时时长60s。连接成功时，SDK会自动向平台订阅系统定义的topic。

返回:

0表示连接成功，其他表示连接失败

reportDeviceMessage

public void reportDeviceMessage(DeviceMessage deviceMessage,
                                ActionListener listener)

上报设备消息 如果需要上报子设备消息，需要调用DeviceMessage的setDeviceId接口设置为子设备的设备id

参数:

deviceMessage - 设备消息

listener - 监听器，用于接收上报结果

reportDeviceMessage

public void reportDeviceMessage(DeviceMessage deviceMessage,
                                ActionListener listener,
                                int qos)

上报设备消息，支持指定qos

参数:

deviceMessage - 设备消息

listener - 监听器，用于接收上报结果

qos - 消息qos，0或1

publishRawMessage

public void publishRawMessage(RawMessage rawMessage,
                              ActionListener listener)

发布原始消息，原始消息和设备消息（DeviceMessage）的区别是： 1、可以自定义topic，该topic需要在平台侧配置 2、不限制payload的格式

参数:

rawMessage - 原始消息

listener - 监听器

reportProperties

public void reportProperties(java.util.List<ServiceProperty> properties,
                             ActionListener listener)

上报设备属性

参数:

properties - 设备属性列表

listener - 发布监听器

reportSubDeviceProperties

public void reportSubDeviceProperties(java.util.List<DeviceProperty> deviceProperties,
                                      ActionListener listener)

批量上报子设备属性

参数:

deviceProperties - 子设备属性列表

listener - 发布监听器

onMessageReceived

public void onMessageReceived(RawMessage message)

从接口复制的说明: RawMessageListener

收到消息通知

指定者:

onMessageReceived 在接口中 RawMessageListener

参数:

message - 原始消息

close

public void close()

respondCommand

public void respondCommand(java.lang.String requestId,
                           CommandRsp commandRsp)

上报命令响应

参数:

requestId - 请求id，响应的请求id必须和请求的一致

commandRsp - 命令响应

respondPropsGet

public void respondPropsGet(java.lang.String requestId,
                            java.util.List<ServiceProperty> services)

上报读属性响应

参数:

requestId - 请求id，响应的请求id必须和请求的一致

services - 服务属性

respondPropsSet

public void respondPropsSet(java.lang.String requestId,
                            IotResult iotResult)

上报写属性响应

参数:

requestId - 请求id，响应的请求id必须和请求的一致

iotResult - 写属性结果

getDeviceId

public java.lang.String getDeviceId()

获取设备id

返回:

设备id

setConnectListener

public void setConnectListener(ConnectListener connectListener)

设置连接监听器，用户接收连接建立和断开事件

参数:

connectListener -

subscribeTopic

public void subscribeTopic(java.lang.String topic,
                           ActionListener actionListener,
                           RawMessageListener rawMessageListener)

订阅自定义topic。系统topic由SDK自动订阅，此接口只能用于订阅自定义topic

参数:

topic - 自定义topic

actionListener - 订阅结果监听器

rawMessageListener - 接收自定义消息的监听器

setPropertyListener

public void setPropertyListener(PropertyListener propertyListener)

设置属性监听器，用于接收平台下发的属性读写。 此监听器只能接收平台到直连设备的请求，子设备的请求由AbstractGateway处理

参数:

propertyListener - 属性监听器

setCommandListener

public void setCommandListener(CommandListener commandListener)

设置命令监听器，用于接收平台下发的命令。 此监听器只能接收平台到直连设备的请求，子设备的请求由AbstractGateway处理

参数:

commandListener - 命令监听器

setDeviceMessageListener

public void setDeviceMessageListener(DeviceMessageListener deviceMessageListener)

设置消息监听器，用于接收平台下发的消息 此监听器只能接收平台到直连设备的请求，子设备的请求由AbstractGateway处理

参数:

deviceMessageListener - 消息监听器

setDevice

public void setDevice(AbstractDevice device)

reportEvent

public void reportEvent(DeviceEvent event,
                        ActionListener listener)

事件上报

参数:

event - 事件

listener - 监听器