nuciotsdk

Golang SDK

说明

提供了注册设备、上传设备运行信息、上传设备状态的接，内部封装实现了获取注册设备资源占用情况的功能。并支持设备上传文件，接收平台下发指令功能等，便于开发者二次开发。

SDK 获取

• 最新版本：1.1.1

环境要求

操作系统：win7,win10,Ubuntu,Centos

Golang SDK目录结构

|--cert mqtt连接所需证书
|--client 主程序
|--utils 工具帮助类,包括数据加密工具类、格式化工具类、时间转换工具类
|--models 项目依赖实体类,包括设备运行信息类、设备状态类、设备注册类、文件信息类、基础信息类
|--demo.go 示例程序，模拟开发者基于SDK进行开发。示例包括设备注册、设备发送状态、设备发送运行信息、设备上传文件以及对应回调函数的使用

SDK 功能列表

SDK API 列表

SDK 方法调用&数据类

NewIotClient

• 描述：新建IoT客户端实例，并初始化
• 输入参数

• 返回值

DeviceRegistrationReq

• 描述：设备注册请求

MqttBrokerInfo

• 描述：Mqtt信息

DeviceStorage

• 描述：设备存储信息

SendRegistration

• 描述：注册设备
• 返回值

SendDeviceStat

• 描述：上传设备状态
• 输入参数

UploadFile2S3

• 描述：上传文件到S3
• 输入参数

SendFileInfo

• 描述：上传成功后上报文件信息，可通过订阅上传成功回调获取上传成功的文件属性
• 输入参数

方法事件

ErrorEvent

• 描述：IoT 客户端调用任意接口发生错误事件
• 回调参数

IotErrorInfo

• 描述：错误信息

UploadCompleteEvent

• 描述：IoT 客户端调用上传文件接口上传完成事件
• 回调参数

IotFileInfo

• 描述：文件信息，上传成功时应有对应的文件信息

UploadRequestEvent

• 描述：IoT 客户端收到文件上传请求事件
• 回调参数

UploadReq

• 描述：文件信息，上传成功时应有对应的文件信息

错误码

封装库内所包含的数据结构 EnumErrorType 所对应的内容，用于枚举错误码。

文件类型

封装库内所包含的数据结构 EnumFileType 所对应的内容，用于枚举错误码。

代码示例

package main

import (
	"fmt"
	"time"

	"gitee.com/magicyu90/nuciotsdk/client"
	"gitee.com/magicyu90/nuciotsdk/models"
	"gitee.com/magicyu90/nuciotsdk/utils"
)

// 错误回调
func OnError(args ...interface{}) {
	e := args[0].(*models.IotErrorInfo)
	fmt.Printf("OnError,code:%d,message:%s\n", e.Code, e.Message)
}

// 完成上传回调
func OnUploadComplete(args ...interface{}) {
	fmt.Println("OnUploadComplete...")
	// 发送文件信息
	ok := args[0].(bool)
	iotFileInfo := args[1].(*models.IotFileInfo)
	if ok {
		fmt.Printf("文件:%s上传1成功,上传文件信息...\n", iotFileInfo.FileName)
		n.SendFileInfo(iotFileInfo.DeviceId, iotFileInfo.FileName, iotFileInfo.Url, iotFileInfo.FileSize, iotFileInfo.FileType, iotFileInfo.UserData)
	} else {
		fmt.Printf("文件:%s上传失败...\n", iotFileInfo.FileName)
	}

}

var deviceId = "xxxx"

// 设备信息
var deviceInfo = models.DeviceRegistrationReq{
	DeveloperId:     "xxx", //开发者ID
	ProtocolVersion: "1.1.1",
	DeviceId:        deviceId, //设备编号
	DeviceType:      "xxx", //设备型号
	ProductKey:      "xxx",    //产品类型
	DeviceIp:        "192.168.1.1",
}

// mqtt信息
var mqttInfo = models.MqttBrokerInfo{
	BrokerUrl: "********", //mqtt地址
	Port:         10884,           //mqtt端口
	MqttUsername: "****",            //mqtt用户名
	MqttPass:     "****", //mqtt密码
	IsCert:       false,           //是否开启证书
}

// 存储信息
var storageInfo = models.DeviceStorage{
	S3Bucket:             "xxxx",                                   //s3 bucket
	S3AccessId:           "******",                     //s3 accessId
	S3AccessSecret:       "********", //s3 accesstoken
	LocalStoragePath:     "xxxx",              //共享目录
	LocalStorageUserName: "xxx",                                     //共享目录用户名
	LocalStoragePass:     "xxxx",                               //共享目录密码
}

// 初始化客户端
var n = client.NewIotClient(deviceInfo, storageInfo, mqttInfo)

// 主函数
func main() {
	// 初始化配置
	n.Configure()
	// 注册错误事件
	n.RegisterEvent(models.ErrorEvent, OnError)
	// 注册上传完成事件
	n.RegisterEvent(models.UploadCompleteEvent, OnUploadComplete)

	retryTimes := 1
	// 设备注册
	for {
		fmt.Printf("开始进行第%d次注册...\n", retryTimes)
		result := n.SendRegistration()
		fmt.Printf("注册结果:%d\n", result)
		if result == 0 {
			break
		}
		retryTimes += 1
		time.Sleep(time.Duration(2) * time.Second)
	}
	fmt.Println("上报设备状态")
	go func() {
		for {
			// 发送设备状态
			n.SendDeviceStat(deviceId, 1)
			time.Sleep(time.Duration(2) * time.Second)
		}
	}()

	fmt.Println("上报设备运行信息")
	go func() {
		for {
			// 发送设备状态
			n.SendDeviceStat(deviceId, 1)
			dataItems := [2]models.DataItem{
				{DataKey: "k1", DataValue: "10", Clock: utils.GetCurrentTimestamp()},
				{DataKey: "k2", DataValue: "20", Clock: utils.GetCurrentTimestamp()}}
			n.SendDeviceData(deviceId, dataItems[:])
			time.Sleep(time.Duration(2) * time.Second)
		}
	}()

	fmt.Println("上传图片至s3")
	n.UploadFile2S3(deviceId, "C:/xxxx/lake.jpg", models.Img, "")

	select {} // 阻塞
}