20 Star 104 Fork 56

geekhekr / iotos-soft-gateway

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

说明

本项目是 氦氪 IoTOS 的配套专用软网关开发 Java SDK,用来进行二次开发对接 IoTOS 平台的一套工具集合。 需要配合 IoTOS 平台的网关(开启远程配置)使用。

本 SDK 托管在 gitee 以开源的方式提供给客户使用,使用 MulanPSL-2.0 方式授权。

背景

IoTOS 是一套先进的企业级物联网解决方案平台,提供了广泛的设备接入方式,但是因为设备的多样性,无法做到一一兼容,虽然提供了硬件 边缘网关 ,但是也无法满足多样的设备连接方式和多样复杂的协议的要求,所以IoTOS 平台提供了软网关的方式,方便用户自己快速接入设备。

目前有两类情况可能会导致设备或子系统无法连接至 IoTOS:

  • IoTOS 目前支持 MQTT、CoAP、LwM2M、HTTP 这四种协议,且认证方式要符合 IoTOS 的规定,但很多存量设备或者子系统使用了 TCP、UDP 和 WS 等协议,且认证方式多种多样,甚至连产品标识(对应 IoTOS 里的 PK)也有缺失;
  • IoTOS 作为物联网中台对南向设备只有 Server 的角色,没有 Client 的角色,但很多子系统往往提供的是 Server,因此在 IoTOS 和子系统之间必须有一个程序充当 Client 从子系统拉取数据并传到 IoTOS。

适用场景

本项目是一个快速开发软网关的SDK,作为 IoTOS 的配套组件,用户需要集成本 SDK 进行二次开发才能完成完整的设备接入流程。

软件网关可用于解决以下2类无法连接 IoTOS 的设备或子系统的情况:

  • 基于 TCP、UDP 和 HTTP 等私有协议的设备或子系统;
  • 自带上位机的软硬件一体系统,该类系统可能暴露如 HTTP、TCP、UDP、JDBC、ODBC 等各种接口对外提供数据。

环境要求

本项目所提供的 SDK 是基于 Java 开发,如果用户有其他语言要求,可以参考 IoTOS平台文档 自行实现

  • JDK 1.8及以上版本
  • Maven(或者 Gradle)

简要设计说明

下图是软件网关的基本工作原理,包含三个主要环节:

  1. 设备接入环节 软件网关中内置了 Server 能力,默认支持 TCP、UDP、HTTP 协议的接入。使用者需要自行实现上报数据的拆包/组包(当为 TCP 时)功能。

同时软件网关也内置了 Client 能力,默认支持向子系统发起 TCP、UDP、HTTP 请求,从而实现与子系统的交互。

开发者需要自行实现交互逻辑,还可以自行扩展实现更多协议的支持。

  1. 数据转码环节 此环节需实现设备原始数据格式(即设备或子系统认识的数据格式)和 KLink (IoTOS 内置的标准数据格式,采用 JSON 标准)的互相转换,使用者需要自行实现 encode(原始数据转 KLink) 和 decode(KLink 转原始数据)这两个 interface。

  2. 与 IoTOS 交互环节 软件网关使用 MQTT 协议实现与 IoTOS 的交互,使用者只需配置相关参数即可。

IoTOS 与软件网关交互的数据中一定包含 PK 和 devID,若存量设备本身不含 PK 等标识信息,开发者则需自行完成映射。

例如,子设备发送亮度状态值 light 为90,软件网关发送给 IoTOS 的数据格式如下:

{
  "action": "devSend",
  "msgId": 1,
  "pk": "3276aa89d25a46b789c7987421396e05",  // 子设备PK 
  "devId": "dev-001",//子设备ID
  "data": {
    "cmd": "report",
    "params": {
      "light": 90
    }
  }
}

更详细的设备通信协议参考 网关介绍Klink 协议

二次开发

项目结构

  • framework-core 和 IoTOS 平台交互的主要代码
  • framework-network-common 网络组件通用代码
  • framework-network-XX 网络组件具体实现,比如 TCP,UDP 服务端和客户端,随着优化,会丰富网络组件
  • example 示例代码,包含网络组件的使用方式使用的时候先启动对应的 server,再启动对应的 client

其中 core 是必须的, framework-network-XX 模块按需加载。

功能封装

框架(core 部分)封装了软网关设备和 IoTOS 平台的交互过程,包括:

  • 网关登录
  • 掉线自动重连
  • 子设备注册和添加拓扑
  • 命令发送和接收
  • 远程配置,自动更新本地映射关系
  • 集群模式

如果用户需要详细了解交互机制,可以查阅 framework-core 部分的代码,同时可以参考 IoTOS文档

功能开放

  • IoTOS 平台交互: KlinkService 类
  • mqtt 连接监听 MqttDisConnectListener 类
  • mqtt 断开连接监听 MqttDisConnectListener 类
  • server 消息回调,事件回调 *Listener
  • client 自动重连,异步、同步消息处理 *Listener

基本使用

子设备登录、登出

调用 KlinkService#devLogin 方法可以使子设备在线;devLogout 则可以使子设备离线。

发送业务数据

发送的业务数据的字段需要在产品的物模型中定义,并且定义相应的命令。

发送数据使用方法: KlinkService#devSend。该方法重载了几个方法:

  • public void devSend(String pk, String devId, String cmd) 可以只发送命令
  • public void devSend(String pk, String devId, String cmd, Map<String, Object> params) 发送命令和参数
  • public void devSend(DeviceMapper mapper, ModelData data) 直接使用 DeviceMapper 发送数据

设备映射

DeviceRemoteConfig 类做了设备映射关系;该关系是通过服务启动的时候自动获取远程配置或者主动更新远程配置来做映射的。

主要方法有:

  • public static Set<DeviceRemoteConfig> getAll() 获取所有设备信息
  • public static Optional<DeviceRemoteConfig> getByPkAndDevId(String pk, String devId) 根据 pk 和 devId 获取设备信息
  • public static Optional<DeviceRemoteConfig> getBySubSystemProperties(Props p) 根据子系统的设备属性获取设备信息
  • public static String getStatus() 获取状态信息
  • public String getPk() 获取设备的 pk
  • public String getDevId() 获取设备的 devId
  • public String getDevName() 获取设备的名字
  • public <T> T getProp(String prop) 根据属性名字获取设备属性值,注意远程配置中数据类型

你还可以实现 DeviceMapper 接口,直接将属性绑定到接口上,这样就可以用类似 devSend(DeviceMapper mapper, ModelData data) 的方法进行发送数据,而无需每次都要手动匹配设备。

下发命令处理

框架封装了下发命令处理过程,只需要实现 SubsystemCommandService 接口并添加注解 CloudSendCommand

cmd,type, gateway 是 与 的关系。

举例: @CloudSendCommand(cmd={"cmdA","cmdB"}, type={"typeA", "typeB"}) 可以匹配设备类型为 typeA或者typeB的,下发命令是 cmdA 或者 cmdB的数据。

其他开发接口

  • MqttDisConnectListener mqtt 连接监听,可以参考 CoreMqttConnectedListenerImpl 实现;如果需要在软网关连接建立或者重连的时候进行业务处理,可以实现这个接口
  • MqttDisConnectListener mqtt 断开连接监听,可以参考 CoreMqttDisConnectListenerImpl 实现;如果需要在软网关连接断开的时候进行业务处理,可以实现这个接口
  • TcpMessageListener tcp server 消息处理监听器
  • CommonMessageListener tcp client, udp client, udp server 消息处理监听器
  • EventListener 事件监听器

集群模式

默认是单机模式。如果要启用集群模式,需要配置mqtt.connect.cluster.mode ,可选的参数值有:

  • standalone 单机模式,不允许多个客户端登录
  • cluster 集群模式,允许多个客户端同时登录,但是下发的消息只有1个客户端可以收到
  • broadcast 广播模式,允许多个客户端同时登录,下发的消息所有客户端可以收到

开发

SDK 已经发布到 maven 仓库中,https://mvnrepository.com/artifact/me.hekr.iotos.softgateway

API 文档

添加必须依赖:

<dependency>
  <groupId>me.hekr.iotos.softgateway</groupId>
  <artifactId>${artifactId}</artifactId>
  <version>${version}</version>;
</dependency>

简化依赖配置,可以直接依赖parent 配置

<parent>
  <artifactId>iotos-soft-gateway</artifactId>
  <groupId>me.hekr.iotos.softgateway</groupId>
  <version>3.2.4</version>
</parent>

snapshot 版本 需要添加仓库:

<repositories>
  <repository>
    <id>hekr-iotos-soft-gateway-snapshot</id>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
  </repository>
</repositories>

最新版本请关注 发行版信息

示例 demo 可以参考 iotos-soft-gateway-demo 项目。

远程配置

远程配置只能用于网关设备,并且在创建产品的时候,开启远程配置功能。

远程配置内容为json数据,每行一个json对象,格式为:

{"pk":"","devId":"","devName":"","deviceType": ""}

其中 pk 是子设备在IoT平台的pk,devId 是子设备在IoT平台的devId,devName是设备在IoT平台的设备名字,deviceType 是自定义的设备类型,用于区分不同子设备类型,如果只有1种设备,可以不写。 其他的字段可以自行填写,比如子系统设备根据ip进行区分,则可以加配置,比如"ip":"10.1.1.2"

配置参数

参考 example/src/main/resources/application.yml 文件

默认发送队列大小为1000

设置常规发送消息队列大小,包括登录,devSend等,根据设备发送频率设置。 队列只是暂时缓冲,频率高的话,最终队列也会满,队列设置最好不要超过10000.

超过会报错

-Diot.queue.general=1000

设置注册消息队列大小,根据远程配置的设备数量配置,保险可设置为1.5-2倍

-Diot.queue.register=1000

设置注册消息队列大小,根据远程配置的设备数量配置,保险可设置为1.5-2倍

发布

修改deploy.sh 文件中的版本号,然后 执行

./deploy.sh install 安装到本地

./deploy.sh remote 发布到中央仓库(需要10分钟-2小时同步到中央仓库)(需要管理员执行)

中央仓库地址

然后提交到 gitee 上,打上 tag。

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [2020] [氦氪版权所有] [iotos-soft-gateway] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [2020] [氦氪版权所有] [iotos-soft-gateway] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

氦氪 IoTOS 的配套专用软网关开发 Java SDK,用来进行二次开发对接 IoTOS 平台的一套工具集合。 展开 收起
Java 等 2 种语言
MulanPSL-2.0
取消

发行版 (35)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/geekhekr/iotos-soft-gateway.git
git@gitee.com:geekhekr/iotos-soft-gateway.git
geekhekr
iotos-soft-gateway
iotos-soft-gateway
master

搜索帮助

14c37bed 8189591 565d56ea 8189591