2 Star 0 Fork 6

geekhekr / iotos-soft-gateway-demo

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

iotos-soft-gateway-demo

本项目依赖 iotos-soft-gateway,是一个基于 IotOS 平台的软网关驱动示例。

介绍

详细设计参考 软网关驱动说明

开发

参考 软网关开发说明

pom 需要依赖

<dependency>
  <groupId>me.hekr.iotos.softgateway</groupId>
  <artifactId>framework-core</artifactId>
  <version>${version}</version>
</dependency>

tcp 和 udp 按需依赖。

如果 sdk 不能满足,可以 fork sdk 项目,提交 pr,或者自行 fork 之后按照项目发布说明发布到自己的仓库,然后依赖地址改为自己的 git 地址即可。

基本使用

本软网关封装功能依赖于IoTOS 平台的网关的远程配置功能。

使用者操作流程如下(黄色部分是与软件网关相关的步骤):

第一步:注册登录 IoTOS 因 IoTOS 以私有化部署为主,绝大部分情况下开发者可以 superadmin(即超级管理员)登录内网里部署的 IoTOS,本文以 IoTOS 体验站点为例。

第二步:创建软件网关产品及设备 进入产品中心-产品开发,点击“创建产品”,建立软件网关,“产品信息”栏目根据实际需求而定,“节点类型”和“联网与数据”栏目配置图如下:

进入产品中心-设备管理,点击“创建设备”,其中设备 ID 后续会在软件网关代码里使用,取名方法根据实际需求而定。

第三步:创建子设备产品及设备 进入产品中心-产品开发,点击“创建产品”,“产品信息”栏目根据实际需求而定,“节点类型”和“联网与数据”栏目配置图如下:

若使用者要求规范设备 ID,建议进入产品中心-设备管理,点击“批量添加”,使用表格模板实现批量导入。

注:此时软件网关的数据转码环节中子设备 ID 和表格应一一对应。

第四步:查看并记录网关以及子设备信息 进入产品中心-设备管理,点击软件网关的右侧“查看”按钮。

获取到软件网关 PK、设备 ID 和 devSecret。

然后以相同的方式获取到子设备的产品 PK、设备 ID。

第五步:获取并配置网关设备信息 进入 IoTOS -产品中心-产品开发,点击上一步创建的软件网关产品,可以获取到 MQTT 接入方式信息,以此为 HOST 值。

进入项目路径 src/main/resources,打开配置文件 application.yml 进行参数配置。

配置文件可以参考 application.yml 以下配置项为软件网关配置的必填信息

注意替换 pk,devId,devSecret 为自己创建的网关设备信息

# mqtt配置(必填)
# 进入产品中心-产品开发-软件网关,"MQTT接入方式"栏目即可查询
connect.mqtt.endpoint: 106.75.50.110:1883
# 软件网关的产品pk,进入产品中心-设备管理-软件网关,"产品pk"栏目即可查询
gateway.pk: xx
# 软件网关的设备id,进入产品中心-设备管理-软件网关,"设备id"栏目即可查询
gateway.devId: xx
# 软件网关的设备密钥,进入产品中心-设备管理-软件网关,"devSecret"栏目点击"复制"按钮即可查询
gateway.devSecret: xx

第六步:程序运行

进入项目路径并打开入口程序 IoTGatewayApplication

运行成功后,打开 IoTOS 平台,查看这个网关设备,可以看到设备已经在线,查看 上下行数据,可以查看网关设备发送的数据。

第六步:添加子设备

打开网关产品的 远程配置 标签,选择该网关设备,然后添加如下内容,其中 子设备 pk 内容改为上面自己创建的子设备的产品 pk。

{"pk":"37743d2ebbe44fb7997a6050fa549411","devId":"demo_subsystem_001", "deviceType":"A","radioDevId":"radio_id_2","devName":"demo子系统终端001"}
{"pk":"37743d2ebbe44fb7997a6050fa549411","devId":"demo_subsystem_002","radioDevId":"radio_id_2","devName":"demo子系统终端002"}
{"pk":"37743d2ebbe44fb7997a6050fa549411","devId":"demo_subsystem_003","radioDevId":"radio_id_3","devName":"demo子系统终端003"}

添加成功后刷新 IoTOS 平台设备列表,可以看到添加了3个新的子设备。

业务开发

上面演示中之所以子设备能够自动生成,是因为网关的远程配置功能。配置内容每行是一个 json 对象。其中 pkdevIddevName 分别是 IoTOS 平台上的子设备的 pk,devId 和设备名称,动态注册的时候会根据这3个属性进行注册。 其他的属性根据子系统进行配置,比如子系统中唯一标识设备的属性叫做 radioDevId(上述远程配置中的参数) ,则可以使用 radioDevId 做映射;如果有其他也需要的属性可以一并添加。

子设备登录、登出

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

发送业务数据

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

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

  • public void devSend(String pk, String devId, String cmd) 可以只发送命令
  • public void devSend(String pk, String devId, String cmd, Map<String, Object> params) 发送命令和参数

设备映射

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) 根据属性名字获取设备属性值,注意远程配置中数据类型

下发命令处理

框架封装了下发命令处理过程,只需要实现 SubsystemCommandService 接口并根据要求定义成 Spring 的 bean 即可,Bean要求:

实现类要加 @Service("{CMD}" + Constants.CMD_BEAN_SUFFIX),其中 {CMD} 为 IoTOS 物模型命令。

实现方法 void handle(DeviceRemoteConfig deviceRemoteConfig, ModelData data);参数 deviceRemoteConfig 是控制的设备, data 是物模型信息,实际需要参考子产品定义的物模型。

其他开发接口

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

打包

开发完成后,将网关和子设备产品导出,(如果有其他文件也可以)放到 docs 文件夹下, 执行命令 mvn clean package -Dmaven.test.skip=true 会打包 jar 并将 README,docs 文件夹下的文件一并打包成 zip,生产的文件在 target 目录下。

项目示例说明

本项目模拟了一个简单广播系统,(因为需要广播系统的服务端,所以项目启动了一个udp server)。驱动(客户端)定时发送查询帧查询设备状态,然后上报给 IoT 平台。

配置切换

在 resources 文件夹下创建 application-xx.yml,重新定义配置覆盖 application.yml 的默认值即可。

启动命令行中增加 --spring.profiles.active=xx 其中 xx 就是对应的配置文件中的名字。

木兰宽松许可证, 第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) [Year] [name of copyright holder] [Software Name] 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) [Year] [name of copyright holder] [Software Name] 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-soft-gateway 开发的驱动 demo 展开 收起
Java 等 3 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助