https://github.com/iot-thingscloud/luatos-thingscloud-sdk
基于合宙模组 LuatOS 快速接入 ThingsCloud 物联网平台的 SDK ，帮你 10 分钟完成模组到云平台的双向通信。
https://github.com/iot-thingscloud/luatos-thingscloud-sdk
air780e air780eg luatos mqtt thingscloud
Last synced: about 1 month ago
JSON representation
基于合宙模组 LuatOS 快速接入 ThingsCloud 物联网平台的 SDK ，帮你 10 分钟完成模组到云平台的双向通信。
- Host: GitHub
- URL: https://github.com/iot-thingscloud/luatos-thingscloud-sdk
- Owner: IoT-ThingsCloud
- License: mit
- Created: 2023-03-08T13:50:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T12:41:50.000Z (about 1 year ago)
- Last Synced: 2024-03-18T13:47:46.464Z (about 1 year ago)
- Topics: air780e, air780eg, luatos, mqtt, thingscloud
- Language: Lua
- Homepage: https://www.thingscloud.xyz/
- Size: 4.12 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# luatos-thingscloud-sdk
这里是基于合宙模组 [LuatOS](https://wiki.luatos.com/) 快速接入 [ThingsCloud](https://www.thingscloud.xyz) 物联网平台的 SDK ，帮你 10 分钟完成模组到云平台的双向通信，一键生成物联网 SaaS 后台，以及用户 App，快速落地物联网项目和产品。
## 特点
- 简单，简单，简单，填写几个参数就可以烧录运行。
- 可实现传感器数据上报和控制下发，利用各种外设发挥你的想象空间。
- 封装了 ThingsCloud 接入协议，只需调用函数和绑定事件，就可以实现设备和云平台双向通信。
- 支持自定义Topic，通过云平台设备类型的自定义数据流。
- 支持一型一密/自动注册设备，用于量产设备。
- 享受 ThingsCloud 云平台所有特性，一键生成物联网 SaaS 后台，以及用户 App，快速落地物联网项目和产品。
## 支持模组
- Air780E
- Air780EG
- Air700E
- Air600E
对于 Air724/820 系列模组，请移步到 [luat-thingscloud-libs](https://github.com/IoT-ThingsCloud/luat-thingscloud-libs)
## ThingsCloud 准备工作
- [快速上手控制台](https://www.thingscloud.xyz/docs/guide/quickstart/signin-console.html)
- [如何获得设备证书？](https://www.thingscloud.xyz/docs/guide/connect-device/device-certificate.html)
- [ThingsCloud MQTT 接入文档](https://docs.thingscloud.xyz/guide/connect-device/mqtt.html)
## 使用方法
### 引用库文件
在主程序中引入库文件：
```lua
local ThingsCloud = require "ThingsCloud"
```
然后将 `libs/` 下的库文件添加到项目的脚本列表中。
### 定义设备证书和连接参数
- 进入 ThingsCloud 控制台：https://www.thingscloud.xyz
- 创建项目，可选择免费版。
- 创建设备，进入设备详情页的【连接】页面，复制设备证书和MQTT接入点地址。请勿泄露你的设备证书。
```lua
-- 一机一密方式
-- ProjectKey
local projectKey = ""
-- AccessToken
local accessToken = ""
-- MQTT 接入点，只需主机名部分
local host = ""
```
### 连接 ThingsCloud
```lua
-- 设备接入云平台的初始化逻辑，在独立协程中完成
sys.taskInit(function()
-- 连接云平台，支持判断网络可用性、MQTT自动重连
-- 这里采用了设备一机一密方式，需要为每个设备固件单独写入证书。另外也支持一型一密，相同设备类型下的所有设备使用相同固件。
ThingsCloud.connect({
host = host,
projectKey = projectKey,
accessToken = accessToken,
})
end)
```
### 烧录固件
使用 Luatools 烧录底层固件和脚本，底层固件在 core/ 目录下。
## 示例项目
[点此进入示例目录](https://github.com/IoT-ThingsCloud/luatos-thingscloud-sdk/tree/main/examples)
### 连接云平台
#### 普通连接（一机一密）
[01.ThingsCloud_Connect/basic_connect](examples/01.ThingsCloud_Connect/basic_connect)
#### 动态获取证书（一型一密）
[01.ThingsCloud_Connect/fetch_certificate](examples/01.ThingsCloud_Connect/fetch_certificate)
#### 自动创建设备+动态获取证书（一型一密）
[01.ThingsCloud_Connect/fetch_certificate_auto_create](examples/01.ThingsCloud_Connect/fetch_certificate_auto_create)
### 和云平台双向通信
#### 属性上报
[02.ThingsCloud_Communicate/attributes_report](examples/02.ThingsCloud_Communicate/attributes_report)
#### 接收下发属性
[02.ThingsCloud_Communicate/attributes_push](examples/02.ThingsCloud_Communicate/attributes_push)
#### 获取云端属性
[02.ThingsCloud_Communicate/attributes_get](examples/02.ThingsCloud_Communicate/attributes_get)
#### 事件上报
[02.ThingsCloud_Communicate/event_report](examples/02.ThingsCloud_Communicate/event_report)
#### 接收下发命令
[02.ThingsCloud_Communicate/command_send](examples/02.ThingsCloud_Communicate/command_send)
#### 自定义数据流
[02.ThingsCloud_Communicate/custom_data](examples/02.ThingsCloud_Communicate/custom_data)
### 综合示例
#### 透传 DTU（支持二进制通信，也可用于 RS485 透传）
[10.IoT_Tutorials/uart_dtu](examples/10.IoT_Tutorials/uart_dtu)
#### 透传 DTU（JSON 透传）
[10.IoT_Tutorials/uart_json](examples/10.IoT_Tutorials/uart_json)
#### 透传 DTU（支持 GPS 模块）
[10.IoT_Tutorials/air780eg_dtu_json](examples/10.IoT_Tutorials/air780eg_dtu_json)
#### GPS 上报
[10.IoT_Tutorials/air780eg_gps_tracker](examples/10.IoT_Tutorials/air780eg_gps_tracker)
#### 云平台控制 GPIO 输出 —— 网络继电器
[10.IoT_Tutorials/gpio_out](examples/10.IoT_Tutorials/gpio_out)
#### SHT30 传感器上报
[10.IoT_Tutorials/sht30_sensor](examples/10.IoT_Tutorials/sht30_sensor)
#### 云平台控制 PWM 输出 —— 电机调速
[10.IoT_Tutorials/pwm_out](examples/10.IoT_Tutorials/pwm_out)
#### ADC 模拟量采集
[10.IoT_Tutorials/adc_sensor](examples/10.IoT_Tutorials/adc_sensor)
#### OTA 升级 - 云平台主动推送模式
[10.IoT_Tutorials/ota_push](examples/10.IoT_Tutorials/ota_push)
#### OTA 升级 - 设备检查新版本
[10.IoT_Tutorials/ota_check](examples/10.IoT_Tutorials/ota_check)
#### OTA 升级 - 主控 MCU 通过 Air780E 检查新版本并下载固件
[10.IoT_Tutorials/ota_check_uart_mcu](examples/10.IoT_Tutorials/ota_check_uart_mcu)
更多示例代码完善中，欢迎你的建议，也欢迎提交贡献。
## 关于 ThingsCloud
ThingsCloud 是物联网设备统一接入平台和低代码应用开发平台。可以帮助任何需要数字化改造的行业客户，在极短的时间内搭建物联网应用，并适应不断变化的发展需求。ThingsCloud 支持智能传感器、执行器、控制器、智能硬件等设备接入，支持 MQTT/HTTP/TCP/Modbus/LoRa/Zigbee/WiFi/BLE 等通信协议，实现数据采集、分析、监控，还可以灵活配置各种规则，生成项目应用 SaaS 和用户应用 App，这一切无需任何云端代码开发。
- 官网：https://www.thingscloud.xyz/
- 控制台：https://console.thingscloud.xyz/
- 教程：https://docs.thingscloud.xyz/tutorials/
- 使用文档：https://docs.thingscloud.xyz
- 设备接入：https://docs.thingscloud.xyz/guide/connect-device/
- 博客：https://www.thingscloud.xyz/blog/
- B站：https://space.bilibili.com/1953347444
### 技术支持
联系 ThingsCloud 技术支持
