全部产品
云市场

物模型开发

更新时间:2019-02-21 20:49:36

设备可以使用物模型功能,实现属性上报(如上报设备状态)、事件上报(上报设备异常或错误)和服务调用(通过云端调用设备提供的服务)。

getDeviceThing() 返回的 IThing 接口 介绍参见 IThing ApiReference

设备属性

  • 设备属性上报

    1. // 设备上报
    2. Map<String, ValueWrapper> reportData = new HashMap<>();
    3. // identifier 是云端定义的属性的唯一标识,valueWrapper是属性的值
    4. // reportData.put(identifier, valueWrapper); // 参考示例,更多使用可参考demo
    5. LinkKit.getInstance().getDeviceThing().thingPropertyPost(reportData, new IPublishResourceListener() {
    6. @Override
    7. public void onSuccess(String resID, Object o) {
    8. // 属性上报成功 resID 设备属性对应的唯一标识
    9. }
    10. @Override
    11. public void onError(String resId, AError aError) {
    12. // 属性上报失败
    13. }
    14. });
  • 设备属性获取

    1. // 根据 identifier 获取当前物模型中该属性的值
    2. String identifier = "xxx";
    3. LinkKit.getInstance().getDeviceThing().getPropertyValue(identifier);
    4. // 获取所有属性
    5. LinkKit.getInstance().getDeviceThing().getProperties()

设备事件

  • 设备事件上报

    1. HashMap<String, ValueWrapper> hashMap = new HashMap<>();
    2. // TODO 用户根据实际情况设置
    3. // hashMap.put("ErrorCode", new ValueWrapper.IntValueWrapper(0));
    4. OutputParams params = new OutputParams(hashMap);
    5. LinkKit.getInstance().getDeviceThing().thingEventPost(identifier, params, new IPublishResourceListener() {
    6. @Override
    7. public void onSuccess(String resId, Object o) { // 事件上报成功
    8. }
    9. @Override
    10. public void onError(String resId, AError aError) { // 事件上报失败
    11. }
    12. });

设备服务

  • 设备服务获取 Service 定义参见 Service API Reference
    1. // 获取设备支持的所有服务
    2. LinkKit.getInstance().getDeviceThing().getServices()
  • 设备服务调用监听 云端在添加设备服务时,需设置该服务的调用方式,由Service中的callType 字段表示。同步服务调用时callType="sync";异步服务调用callType="async"。设备属性设置和获取也是通过服务调用监听方式实现云端服务的下发。

    • 异步服务调用 设备先注册服务的处理监听器,当云端触发异步服务调用的时候,下行的请求会到注册的监听器中。一个设备会有多种服务,通常需要注册所有服务的处理监听器。onProcess 是设备收到的云端下行的服务调用,第一个参数是需要调用服务对应的 identifier,用户可以根据 identifier (identifier 是云端在创建属性或事件或服务的时候的标识符,可以在云端产品的功能定义找到每个属性或事件或服务对应的identifier)做不同的处理。云端调用设置服务的时候,设备需要在收到设置指令后,调用设备执行真实操作,操作结束后上报一条属性状态变化的通知。

      1. // 用户可以根据实际情况注册自己需要的服务的监听器
      2. LinkKit.getInstance().getDeviceThing().setServiceHandler(service.getIdentifier(), mCommonHandler);
      3. // 服务处理的handler
      4. private ITResRequestHandler mCommonHandler = new ITResRequestHandler() {
      5. @Override
      6. public void onProcess(String identify, Object result, ITResResponseCallback itResResponseCallback) {
      7. // 收到云端异步服务调用 identify 设备端属性或服务唯一标识 result 下行服务调用数据
      8. // iotResResponseCallback 用户处理完服务调用之后响应云端 具体使用参见 Demo 代码
      9. try {
      10. if (SERVICE_SET.equals(identify)) { // set 异步服务调用
      11. // TODO 用户按照真实设备的接口调用 设置设备的属性
      12. // 设置完真实设备属性之后,上报设置完成的属性值
      13. // 用户根据实际情况判断属性是否设置成功 这里测试直接返回成功
      14. boolean isSetPropertySuccess = true;
      15. if (isSetPropertySuccess){
      16. if (result instanceof InputParams) {
      17. Map<String, ValueWrapper> data = (Map<String, ValueWrapper>) ((InputParams) result).getData();
      18. // 响应云端 接收数据成功
      19. itResResponseCallback.onComplete(identify, null, null);
      20. } else {
      21. itResResponseCallback.onComplete(identify, null, null);
      22. }
      23. } else {
      24. AError error = new AError();
      25. error.setCode(100);
      26. error.setMsg("setPropertyFailed.");
      27. itResResponseCallback.onComplete(identify, new ErrorInfo(error), null);
      28. }
      29. } else if (SERVICE_GET.equals(identify)){ // get异步服务调用
      30. // 初始化的时候将默认值初始化传进来,物模型内部会直接返回云端缓存的值
      31. } else { // 用户定义服务调用
      32. // 根据不同的服务做不同的处理,跟具体的服务有关系
      33. OutputParams outputParams = new OutputParams();
      34. // outputParams.put("op", new ValueWrapper.IntValueWrapper(20));
      35. itResResponseCallback.onComplete(identify,null, outputParams);
      36. }
      37. } catch (Exception e) {
      38. e.printStackTrace();
      39. }
      40. }
      41. @Override
      42. public void onSuccess(Object o, OutputParams outputParams) {
      43. // 服务注册成功 tag:用户传入的tag,未使用到 outputParams:异步回调成功的返回数据,outparams等类型
      44. }
      45. @Override
      46. public void onFail(Object o, ErrorInfo errorInfo) {
      47. // 服务注册失败
      48. }
      49. };
    • 同步服务调用 同步服务调用是一个 RRPC 调用。用户可以注册一个下行数据监听,当云端触发服务调用时,可以在 onNotify 收到云端的下行服务调用。收到云端的下行服务调用之后,用户根据实际服务调用对设备做服务处理,处理之后需要回复云端的请求,即发布一个带有处理结果的请求到云端。当前版本添加了支持使用自定义RRPC,云端的同步服务属性下行将走自定义RRPC通道下行,用户在升级SDK之后要注意这个改动点。

      1. if (CONNECT_ID.equals(connectId) && !TextUtils.isEmpty(topic) &&
      2. topic.startsWith("/ext/rrpc/")) {
      3. showToast("收到云端自定义RRPC下行");
      4. // ALog.d(TAG, "receice Message=" + new String((byte[]) aMessage.data));
      5. // 服务端返回数据示例 {"method":"thing.service.test_service","id":"123374967","params":{"vv":60},"version":"1.0.0"}
      6. MqttPublishRequest request = new MqttPublishRequest();
      7. // 支持 0 和 1, 默认0
      8. // request.qos = 0;
      9. request.isRPC = false;
      10. request.topic = topic.replace("request", "response");
      11. String[] array = topic.split("/");
      12. String resId = array[3];
      13. request.msgId = resId;
      14. // TODO 用户根据实际情况填写 仅做参考
      15. request.payloadObj = "{\"id\":\"" + resId + "\", \"code\":\"200\"" + ",\"data\":{} }";
      16. // aResponse.data =
      17. LinkKit.getInstance().publish(request, new IConnectSendListener() {
      18. @Override
      19. public void onResponse(ARequest aRequest, AResponse aResponse) {
      20. Log.d(TAG, "onResponse() called with: aRequest = [" + aRequest + "], aResponse = [" + aResponse + "]");
      21. }
      22. @Override
      23. public void onFailure(ARequest aRequest, AError aError) {
      24. Log.d(TAG, "onFailure() called with: aRequest = [" + aRequest + "], aError = [" + aError + "]");
      25. }
      26. });
      27. }