huaweicloud-iot-device-sdk-go提供设备接入华为云IoT物联网平台的Go版本的SDK，提供设备和平台之间通讯能力，以及设备服务、网关服务、OTA等高级服务。IoT设备开发者使用SDK可以大大简化开发复杂度，快速的接入平台。
支持如下功能：
当前稳定版本：v1.0.1
安装和构建的过程取决于你是使用go的 modules(推荐) 还是还是GOPATH
如果你使用 modules 只需要导入包"github.com/ctlove0523/huaweicloud-iot-device-sdk-go"即可使用。当你使用go build命令构建项目时，依赖的包会自动被下载。注意使用go build命令构建时会自动下载最新版本，最新版本还没有达到release的标准可能存在一些尚未修复的bug。如果想使用稳定的发布版本可以从release 获取最新稳定的版本号，并在go.mod文件中指定版本号。
module example
go 1.15
require github.com/ctlove0523/huaweicloud-iot-device-sdk-go v0.0.1-alpha如果你使用GOPATH，下面的一条命令即可实现安装
go get github.com/ctlove0523/huaweicloud-iot-device-sdk-goSDK提供了异步client，下面所有的方法都有对应的异步方法。
1、首先，在华为云IoT平台创建一个设备，设备的信息如下：
设备ID：5fdb75cccbfe2f02ce81d4bf_go-mqtt
设备密钥：123456789
2、使用SDK创建一个Device对象，并初始化Device。
import (
"fmt"
"github.com/ctlove0523/huaweicloud-iot-device-sdk-go"
"time"
)
func main() {
// 创建一个设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
if device.IsConnected() {
fmt.Println("device connect huawei iot platform success")
} else {
fmt.Println("device connect huawei iot platform failed")
}
}iot-mqtts.cn-north-4.myhuaweicloud.com为华为IoT平台（基础班）在华为云北京四的访问端点，如果你购买了标准版或企业版，请将iot-mqtts.cn-north-4.myhuaweicloud.com更换为对应的MQTT协议接入端点。
1、根据华为云文档创建证书并注册设备
2、使用SDK创建一个使用x.509证书鉴权的设备并初始化
使用x.509证书鉴权需要获取平台的ca证书，并已经创建获取了设备的证书，具体可以参考上面的华为云文档。
caPath := "your ca path"
certFilePath := "your cert path"
certKeyFilePath := "your key path"
config := iot.DeviceConfig{
Id: "your device id",
Servers: "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883",
AuthType: iot.AUTH_TYPE_X509,
ServerCaPath: caPath,
CertFilePath: certFilePath,
CertKeyFilePath: certKeyFilePath,
}
device := iot.CreateIotDeviceWitConfig(config)
res := device.Init()
fmt.Println(res)使用x.509证书鉴权必须设置AuthType的值为1（iot.AUTH_TYPE_X509），否则默认使用密码进行鉴权
1、首先，在华为云IoT平台创建一个设备，设备的信息如下：
设备ID：5fdb75cccbfe2f02ce81d4bf_go-mqtt
设备密钥：123456789
2、使用SDK创建一个Device对象，并初始化Device。
// 创建一个设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
if device.IsConnected() {
fmt.Println("device connect huawei iot platform success")
} else {
fmt.Println("device connect huawei iot platform failed")
}3、注册命令处理handler，支持注册多个handler并且按照注册的顺序回调
// 添加用于处理平台下发命令的callback
device.AddCommandHandler(func(command iot.Command) bool {
fmt.Println("First command handler begin to process command.")
return true
})
device.AddCommandHandler(func(command iot.Command) bool {
fmt.Println("Second command handler begin to process command.")
return true
})4、通过应用侧API向设备下发一个命令，可以看到程序输出如下：
device connect huawei iot platform success
First command handler begin to process command.
Second command handler begin to process command.
import (
"fmt"
"github.com/ctlove0523/huaweicloud-iot-device-sdk-go"
"time"
)
// 处理平台下发的同步命令
func main() {
// 创建一个设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
if device.IsConnected() {
fmt.Println("device connect huawei iot platform success")
} else {
fmt.Println("device connect huawei iot platform failed")
}
// 添加用于处理平台下发命令的callback
device.AddCommandHandler(func(command iot.Command) bool {
fmt.Println("First command handler begin to process command.")
return true
})
device.AddCommandHandler(func(command iot.Command) bool {
fmt.Println("Second command handler begin to process command.")
return true
})
time.Sleep(1 * time.Minute)
}设备支持的命令定义在产品中
1、首先，在华为云IoT平台创建一个设备，设备的信息如下：
设备ID：5fdb75cccbfe2f02ce81d4bf_go-mqtt
设备密钥：123456789
2、使用SDK创建一个Device对象，并初始化Device。
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()message := iot.Message{
ObjectDeviceId: uuid.NewV4().String(),
Name: "Fist send message to platform",
Id: uuid.NewV4().String(),
Content: "Hello Huawei IoT Platform",
}
device.SendMessage(message)接收平台下发的消息，只需注册消息处理handler，支持注册多个handler并按照注册顺序回调。
// 注册平台下发消息的callback，当收到平台下发的消息时，调用此callback.
// 支持注册多个callback，并且按照注册顺序调用
device.AddMessageHandler(func(message iot.Message) bool {
fmt.Println("first handler called" + iot.Interface2JsonString(message))
return true
})
device.AddMessageHandler(func(message iot.Message) bool {
fmt.Println("second handler called" + iot.Interface2JsonString(message))
return true
})import (
"fmt"
iot "github.com/ctlove0523/huaweicloud-iot-device-sdk-go"
uuid "github.com/satori/go.uuid"
"time"
)
func main() {
// 创建一个设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
// 注册平台下发消息的callback，当收到平台下发的消息时，调用此callback.
// 支持注册多个callback，并且按照注册顺序调用
device.AddMessageHandler(func(message iot.Message) bool {
fmt.Println("first handler called" + iot.Interface2JsonString(message))
return true
})
device.AddMessageHandler(func(message iot.Message) bool {
fmt.Println("second handler called" + iot.Interface2JsonString(message))
return true
})
//向平台发送消息
message := iot.Message{
ObjectDeviceId: uuid.NewV4().String(),
Name: "Fist send message to platform",
Id: uuid.NewV4().String(),
Content: "Hello Huawei IoT Platform",
}
device.SendMessage(message)
time.Sleep(2 * time.Minute)
}1、首先，在华为云IoT平台创建一个设备，并在该设备下创建3个子设备，设备及子设备的信息如下：
设备ID：5fdb75cccbfe2f02ce81d4bf_go-mqtt
设备密钥：123456789
子设备ID：5fdb75cccbfe2f02ce81d4bf_sub-device-1
子设备ID：5fdb75cccbfe2f02ce81d4bf_sub-device-2
子设备ID：5fdb75cccbfe2f02ce81d4bf_sub-device-3
2、使用SDK创建一个Device对象，并初始化Device。
// 创建设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
fmt.Printf("device connected: %v\n", device.IsConnected())使用ReportProperties(properties ServiceProperty) bool 上报设备属性
// 设备上报属性
props := iot.ServicePropertyEntry{
ServiceId: "value",
EventTime: iot.DataCollectionTime(),
Properties: DemoProperties{
Value: "chen tong",
MsgType: "23",
},
}
var content []iot.ServicePropertyEntry
content = append(content, props)
services := iot.ServiceProperty{
Services: content,
}
device.ReportProperties(services)使用BatchReportSubDevicesProperties(service DevicesService) 实现网关批量设备属性上报
// 批量上报子设备属性
subDevice1 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-1",
Services: content,
}
subDevice2 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-2",
Services: content,
}
subDevice3 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-3",
Services: content,
}
var devices []iot.DeviceService
devices = append(devices, subDevice1, subDevice2, subDevice3)
device.BatchReportSubDevicesProperties(iot.DevicesService{
Devices: devices,
})使用AddPropertiesSetHandler(handler DevicePropertiesSetHandler) 注册平台设置设备属性handler，当接收到平台的命令时SDK回调。
// 注册平台设置属性callback,当应用通过API设置设备属性时，会调用此callback，支持注册多个callback
device.AddPropertiesSetHandler(func(propertiesSetRequest iot.DevicePropertyDownRequest) bool {
fmt.Println("I get property set command")
fmt.Printf("request is %s", iot.Interface2JsonString(propertiesSetRequest))
return true
})使用SetPropertyQueryHandler(handler DevicePropertyQueryHandler)注册平台查询设备属性handler，当接收到平台的查询请求时SDK回调。
// 注册平台查询设备属性callback，当平台查询设备属性时此callback被调用，仅支持设置一个callback
device.SetPropertyQueryHandler(func(query iot.DevicePropertyQueryRequest) iot.ServicePropertyEntry {
return iot.ServicePropertyEntry{
ServiceId: "value",
Properties: DemoProperties{
Value: "QUERY RESPONSE",
MsgType: "query property",
},
EventTime: "2020-12-19 02:23:24",
}
})使用QueryDeviceShadow(query DevicePropertyQueryRequest, handler DevicePropertyQueryResponseHandler)
可以查询平台的设备影子数据，当接收到平台的响应后SDK自动回调DevicePropertyQueryResponseHandler。
// 设备查询设备影子数据
device.QueryDeviceShadow(iot.DevicePropertyQueryRequest{
ServiceId: "value",
}, func(response iot.DevicePropertyQueryResponse) {
fmt.Printf("query device shadow success.\n,device shadow data is %s\n", iot.Interface2JsonString(response))
})import (
"fmt"
iot "github.com/ctlove0523/huaweicloud-iot-device-sdk-go"
"time"
)
func main() {
// 创建设备并初始化
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "123456789", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
fmt.Printf("device connected: %v\n", device.IsConnected())
// 注册平台设置属性callback,当应用通过API设置设备属性时，会调用此callback，支持注册多个callback
device.AddPropertiesSetHandler(func(propertiesSetRequest iot.DevicePropertyDownRequest) bool {
fmt.Println("I get property set command")
fmt.Printf("request is %s", iot.Interface2JsonString(propertiesSetRequest))
return true
})
// 注册平台查询设备属性callback，当平台查询设备属性时此callback被调用，仅支持设置一个callback
device.SetPropertyQueryHandler(func(query iot.DevicePropertyQueryRequest) iot.ServicePropertyEntry {
return iot.ServicePropertyEntry{
ServiceId: "value",
Properties: DemoProperties{
Value: "QUERY RESPONSE",
MsgType: "query property",
},
EventTime: "2020-12-19 02:23:24",
}
})
// 设备上报属性
props := iot.ServicePropertyEntry{
ServiceId: "value",
EventTime: iot.DataCollectionTime(),
Properties: DemoProperties{
Value: "chen tong",
MsgType: "23",
},
}
var content []iot.ServicePropertyEntry
content = append(content, props)
services := iot.ServiceProperty{
Services: content,
}
device.ReportProperties(services)
// 设备查询设备影子数据
device.QueryDeviceShadow(iot.DevicePropertyQueryRequest{
ServiceId: "value",
}, func(response iot.DevicePropertyQueryResponse) {
fmt.Printf("query device shadow success.\n,device shadow data is %s\n", iot.Interface2JsonString(response))
})
// 批量上报子设备属性
subDevice1 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-1",
Services: content,
}
subDevice2 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-2",
Services: content,
}
subDevice3 := iot.DeviceService{
DeviceId: "5fdb75cccbfe2f02ce81d4bf_sub-device-3",
Services: content,
}
var devices []iot.DeviceService
devices = append(devices, subDevice1, subDevice2, subDevice3)
device.BatchReportSubDevicesProperties(iot.DevicesService{
Devices: devices,
})
time.Sleep(1 * time.Minute)
}
type DemoProperties struct {
Value string `json:"value"`
MsgType string `json:"msgType"`
}device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
device.UploadFile("D/software/mqttfx/chentong.txt")当前SDK没有内置mqtt broker模块，对mqtt broker的支持正在开发中
网关如果要处理子设备新增和删除，需要注册对应的handler让SDK调用。
device := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
// 处理子设备添加
device.SetSubDevicesAddHandler(func(devices iot.SubDeviceInfo) {
for _, info := range devices.Devices {
fmt.Println("handle device add")
fmt.Println(iot.Interface2JsonString(info))
}
})
// 处理子设备删除
device.SetSubDevicesDeleteHandler(func(devices iot.SubDeviceInfo) {
for _, info := range devices.Devices {
fmt.Println("handle device delete")
fmt.Println(iot.Interface2JsonString(info))
}
})
device.Init()-
同步所有版本的子设备
device := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883") device.Init() device.SyncAllVersionSubDevices()
-
同步指定版本的子设备
device := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883") device.Init() device.SyncSubDevices(version int)
device := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
result:= device.AddSubDevices(deviceInfos) // deviceInfos 的类型为[]DeviceInfodevice := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
result:= device.DeleteSubDevices(deviceIds) // deviceIds的类型为[]stringdevice := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
result:= device.UpdateSubDeviceState(subDevicesStatus) //subDevicesStatus的类型SubDevicesStatus设备可以向平台上报SDK版本、软固件版本信息，其中SDK的版本信息SDK自动填充
device := iot.CreateIotDevice("xxx", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883")
device.Init()
device.ReportDeviceInfo("1.0", "2.0")设备日志功能主要包括：平台下发日志收集命令，设备上报平台指定时间段内的日志；设备调用接口主动上报日志。
-
设备响应平台日志收集命令
设备响应日志收集功能需要实现日志收集函数，函数的定义如下：
// 设备状态日志收集器 type DeviceStatusLogCollector func(endTime string) []DeviceLogEntry // 设备属性日志收集器 type DevicePropertyLogCollector func(endTime string) []DeviceLogEntry // 设备消息日志收集器 type DeviceMessageLogCollector func(endTime string) []DeviceLogEntry // 设备命令日志收集器 type DeviceCommandLogCollector func(endTime string) []DeviceLogEntry
函数需要返回endTime之前的所有日志，DeviceLogEntry包括日志记录时间、日志类型以及日志内容。当设备收到平台下发日志收集请求后，SDK会自动的上报日志直到平台关闭日志收集或endTime范围内没有任何日志内容。
日志收集函数的设置如下：
device := iot.CreateIotDevice("5fdb75cccbfe2f02ce81d4bf_go-mqtt", "xxx", "tls://iot-mqtts.cn-north-4.myhuaweicloud.com:8883") // 设置设备状态日志收集器 device.SetDeviceStatusLogCollector(func(endTime string) []iot.DeviceLogEntry { return []iot.DeviceLogEntry{} }) device.Init()
-
设备主动上报日志
设备可以调用
ReportLogs(logs []DeviceLogEntry) bool函数主动上报日志。
华为云IoT物联网平台支持使用HTTP协议上报消息和属性（该功能目前处于α阶段，尚未对外开放，具体开放时间参考华为云IoT物联网平台公告）。使用HTTP协议上报消息和属性非常简单方便，SDK对接口进行了封装，接口使用的对象和MQTT协议一致。使用HTTP协议的设备接口定义如下：
type HttpDevice interface {
SendMessage(message Message) bool
ReportProperties(properties DeviceProperties) bool
}使用样例参考：http_device_samples.go
有两种方法可以使用设备发放服务动态获取设备连接平台的地址
方法1：通过设备发放服务获取设备连接平台的地址，然后创建设备
id := "device_id"
pwd := "your device password"
bootstrapClient, err := iot.NewBootstrapClient(id, pwd)
if err != nil {
fmt.Printf("create bs client failed")
return
}
server := bootstrapClient.Boot()
if len(server) == 0 {
fmt.Println("get server address failed")
return
}
device := iot.CreateIotDevice(id, pwd, server)
device.Init()方法2：在创建设备时启动设备发放服务
id := "device_id"
pwd := "your device password"
config := iot.DeviceConfig{
Id: id,
Password: pwd,
UseBootstrap: true,
}
device := iot.CreateIotDeviceWitConfig(config)
initRes := device.Init()
fmt.Println(initRes)
time.Sleep(1 * time.Minute)如果你在使用过程中遇到任何问题或bugs，请通过issue的方式上报问题或bug，我们将会在第一时间内答复。上报问题或bugs时请尽量提供以下内容：
- 使用的版本
- 使用场景
- 重现问题或bug的样例代码
- 错误信息
- ······
该项目欢迎来自所有人的pull request。
