zeevin/libiocm

中国电信物联网开放平台API对接库

1.1.5 2024-03-12 03:46 UTC

README

Total Downloads Monthly downloads Latest Stable Version License

Libiocm 实现了对中国电信物联网开发平台(北向)API的对接。

关于NB-IoT的开发,有兴趣的朋友可以加QQ群交流:群号:577640752

安装

composer require zeevin/libiocm

对接进度:


应用安全接入(对应tests文件夹内的示例)
 鉴权 seclogin.php
 刷新token secrefresh.php

设备管理
 注册直连设备 Zeevin\Libiocm\Reg\RegClient
 刷新设备密钥 Zeevin\Libiocm\Reg\RefreshKeyClient
 修改设备信息 Zeevin\Libiocm\Dm\UpdateDeviceClient
 删除直连设备 Zeevin\Libiocm\Dm\DeleteDeviceClient
 查询设备激活状态 Zeevin\Libiocm\Reg\CheckActivatedStatClient
 
批量处理
 创建批量任务 Zeevin\Libiocm\BatchTask\CreateClient
 查询单个任务信息 Zeevin\Libiocm\BatchTask\QueryClient :响应中的param参数未适配动态类型
 查询任务详情信息 Zeevin\Libiocm\BatchTask\QueryDetailClient :响应中QueryTaskDetailDTOCloud2NA结构体的param参数未适配动态类型

规则管理 :稍后适配

订阅管理
 订阅平台业务数据 Zeevin\Libiocm\Sub\RegClient
 订阅平台管理数据 subscribecreate.php
 查询单个订阅  Zeevin\Libiocm\Sub\QueryClient
 批量查询订阅 Zeevin\Libiocm\Sub\BatchQueryClient
 删除单个订阅 Zeevin\Libiocm\Sub\DeleteClient
 批量删除订阅 Zeevin\Libiocm\Sub\BatchDeleteClient
 
消息推送 :此为推送信息,最后适配


命令下发
 创建设备命令 Zeevin\Libiocm\Cmd\CreateClient
 查询设备命令 Zeevin\Libiocm\Cmd\QueryClient
 修改设备命令 Zeevin\Libiocm\Cmd\UpdateClient
 创建设备命令撤销任务 Zeevin\Libiocm\Cmd\CreateTaskClient
 查询设备命令撤销任务 Zeevin\Libiocm\Cmd\QueryTaskClient
 
查询设备命令撤销任务 
 查询单个设备信息 singlequery.php
 批量查询设备信息列表 Zeevin\Libiocm\Dm\QueryDevicesClient
 查询设备历史数据 Zeevin\Libiocm\Data\QueryHistoryClient :响应参数中含有totalCount、pageSize、pageNo,但是文档没写,这里我仍然保留
 查询设备服务能力 Zeevin\Libiocm\Data\QueryCapabilitiesClient
 
设备组管理
 创建设备组 Zeevin\Libiocm\Devgroup\CreateClient
 删除设备组 Zeevin\Libiocm\Devgroup\DeleteClient
 修改设备组 Zeevin\Libiocm\Devgroup\UpdateClient
 查询设备组详情 Zeevin\Libiocm\Devgroup\QueryClient 文档中返回值:queryDevGroups实际不存在,返回的是list
 查询指定设备组 Zeevin\Libiocm\Devgroup\SpecificQueryClient
 查询指定设备组成员 Zeevin\Libiocm\Dm\SpecificMemberQueryClient
 增加设备组成员 Zeevin\Libiocm\Dm\SpecificMemberAppendClient  返回值中的deviceIds实际都是返回空,与文档不一致
 删除设备组成员 Zeevin\Libiocm\Dm\SpecificMemberDeleteClient 
 
 
2.10 设备升级 :适配中

使用方式请参考tests文件夹内的测试用例,使用前复制config.php.sample.php 为config.php,并根据自己情况修改配置参数。

主要完成如下内容:

  • 1、使用JMS包装请求参数。以定义类变量的方式设置请求参数,便于参数的设置和参数提示。
  • 2、使用JMS包装返回的json数据,默认会把请求数据映射为对应的RequestAttribute类,便于进一步使用。
  • 3、使用doctrine/cache 缓存ouath token结果。目前适配了memcached、Redis、file三类。

注意事项:

  • 1、Guzzle 库只支持pem格式的证书,因此需要将默认的p12格式证书转换成pem格式,比如:
openssl pkcs12 -in outgoing.CertwithKey.pkcs12 -out key.pem -nodes -clcerts

目前测试平台的证书密码是:IoM@1234,如果后期电信有更新需要同步更新。

  • 2、电信编写的api文档看起来并不十分完善,有些返回信息是从头信息中查看,比如1.2.2.4 删除直连设备接口, 此接口在删除成功时返回结果需要查看头信息的statusCode和reasonPhrase内容,body中并没有json信息,为解决这种问题, 我在所有的请求结果中都加入了"statusCode"和"reasonPhrase"属性。

  • 3、接口调用方式请查看tests文件夹下的示例。