更新时间:2023-05-30 GMT+08:00
分享

接口函数

表1 APPClient接口说明

接口

说明

createFromEnv

根据环境变量创建客户端,相关配置参数从环境变量获取

setBusMessageCallback

设置消息总线回调,用于对设备上报的数据进行处理

sendBusMessage

向总线发送设备数据,用于将处理后的设备数据发送到总线

callDeviceCommand

调用设备命令

getDevicesStatus

查询设备状态

getDevicesInfos

查询子设备列表

getDeviceProperties

获取设备属性

setCustomizedMessageCallback

设置自定义消息回调,用于对自定义数据进行处理

sendCustomizedMessage

向总线发送自定义消息

  1. 创建客户端

    函数描述:

    public static AppClient createFromEnv()throws GeneraException

    函数功能:

    根据环境变量创建客户端,相关配置参数从环境变量获取

  2. 设备总线消息回调

    函数描述:

    public void setBusMessageCallback(java.lang.String inputName,BusMessageCallback callback)throws java.lang.IllegalArgumentException

    函数功能:

    设置总线消息回调,用于对设备上报的数据进行处理

    表2 参数说明

    参数名称

    类型

    参数描述

    inputName

    String

    模块输入点

    callback

    BusMessageCallback

    回调类实例

  3. 设备数据发送至总线

    函数描述:

    public void sendBusMessage(java.lang.String outputName,BusMessage message)throws java.lang.IllegalArgumentException,JsonException

    函数功能:

    向总线发送消息,用于将处理后的设备数据发送到总线

    表3 参数说明

    参数名称

    类型

    参数描述

    outputName

    String

    模块输出点

    message

    BusMessage

    设备数据

  4. 调用设备命令

    函数描述:

    public CommandRsp callDeviceCommand(Command command,int timeout)throws GeneraException

    函数功能:

    调用设备命令

    表4 参数说明

    参数名称

    类型

    参数描述

    command

    Command

    设备命令

    timeout

    int

    超时时间,单位毫秒

  5. 查询设备状态

    函数描述:

    public java.util.List<DeviceStatus> getDevicesStatus(java.lang.String[] deviceIds,int timeout)throws GeneraException

    函数功能:

    查询设备状态

    表5 参数说明

    参数名称

    类型

    参数描述

    deviceIds

    String[]

    设备Id数组

    timeout

    int

    超时时间,单位毫秒

  6. 查询子设备列表

    函数描述:

    public java.util.List<EdgeDeviceInfo> getDevicesInfos()throws GeneraException

    函数功能:

    查询子设备列表

  7. 获取设备属性

    函数描述:

    public ServiceData getDeviceProperties(java.lang.String deviceId,java.lang.String serviceId) throws GeneraException

    函数功能:

    获取设备属性

    表6 参数说明

    参数名称

    类型

    参数描述

    deviceId

    String

    子设备Id

    serviceId

    String

    服务Id

  8. 设置自定义消息回调

    函数描述:

    public void setCustomizedMessageCallback(CustomizedMessageCallback callback)

    函数功能:

    设置自定义消息回调,用于从消息总线中接收自定义消息

    表7 参数说明

    参数名称

    类型

    参数描述

    callback

    CustomizedMessageCallback

    回调类实例

  9. 自定义消息发送至总线

    函数描述:

    public void sendCustomizedMessage(java.lang.String topic,String payload)

    函数功能:

    向总线发送自定义消息

    表8 参数说明

    参数名称

    类型

    参数描述

    topic

    String

    自定义消息的目标topic

    payload

    String

    自定义消息

分享:

    相关文档

    相关产品