vei-iot-sdk-go

d := arenal.CreateDeviceWithConfig(arenal.DeviceOption{
  Name:       "xxx",
  ProductKey: "xxxxxxxxx",
  Region:     arenal.RegionBoe,
  VerifyMode: arenal.VerifyModeDynamicNoPreRegistered,
  FilePath: "",
  ModuleConfig: map[string]arenal.ModuleInfo{
      "default":arenal.ModuleInfo{
          ModuleKey: "default",
          Version: "1.0",
      },
  },
  UserDefineTopicQosMap: map[string]byte{
      "sys/topic/demo":1,
  },
})
if ok := d.Init(); !ok {
  log.Error("device init failed")
}

另一种方式是使用yaml文件配置，文件结构详见sample下的config_template.yaml；使用arenal.InitOptionWithConfigFile方法，传递yaml文件所在路径即可生成对应的DeviceOption：

deviceOption,err := arenal.InitOptionWithConfigFile("config/config.yaml")
if err != nil{
  fmt.Printf("error is : %s",err.Error())
  return
}
d := arenal.CreateDeviceWithConfig(*deviceOption)
if ok := d.Init(); !ok {
  log.Error("device init failed")
}

配置升级通知接收器（可选）调用设备提供的SetOTANotifyHandler方法，传递固定结构的function即可。每当通知消息到来时，就会进入该function。默认情况下，会直接发起升级请求，对目标模块进行升级：

// 配置OTA升级通知Handler，设备支持OTA功能必须进行实现
d.SetOTANotifyHandler(func(message arenal.OTANotifyPayload) {
 // 此处实现接收到升级通知时，需要进行的操作 
 messageStr, _ := json.Marshal(message)
 fmt.Println(fmt.Sprintf("Receive Message Success!message = %v", string(messageStr)))
 // 进行某项OTA升级前，需要先调用OTAUpgradeRequest申请更新包url，平台返回会直接进入OTAReplyPayload进行处理
 // 需要主动填写需要更新的module，如果有可用更新，则会通过Reply返回更新信息；若OTAUpgradeRequest参数otaJobID为空，表示请求最新的升级任务，建议不指定 
 code := d.OTAUpgradeRequest(message.Data.Module, "", message.DeviceIdentification)
 if code != arenal.SuccessCode {
     // 错误处理
     log.Error("upgrade Request failed")
 }
})

配置差分还原算法（可选，如果存在差分包必须进行配置），调用设备提供的SetDiffAlgorithm方法，传递固定结构的function：

// 如果存在差分包的情况，必须准备好对应的反差分算法，否则可能会导致安装失败
var diffAlgorithm arenal.DiffAlgorithm
diffAlgorithm = func(diffFileName string) arenal.DiffAlgorithmResult {
//具体的生成整包流程
 return arenal.DiffAlgorithmResult{
     IsSuccess:      true,
     ResDesc:        "",
     TargetFilePath: diffFileName,
 }
}
d.SetDiffAlgorithm(diffAlgorithm)

配置安装包安装流程（支持OTA升级的设备，必须配置），调用设备提供的SetInstallAlgorithm方法，传递固定结构的function：

// 需要提前准备好安装包烧写流程
var InstallAlgorithm arenal.InstallAlgorithm
InstallAlgorithm = func(module, filename string) arenal.InstallAlgorithmResult {
 // 这里传递的参数为最终的整包路径，如果不是差分，则为下载路径，是差分则为反差分算法形成的整包路径
 log.Infof("installing：filename:%s", filename)
 time.Sleep(10 * time.Second)
 return arenal.InstallAlgorithmResult{
     IsSuccess:     true,
     ResDesc:       "",
     DeviceVersion: tmpVersion,
     NeedReboot:    false,
 }
}
d.SetInstallAlgorithm(InstallAlgorithm)

配置OTA升级请求应答消息接收器（可选）调用设备提供的SetOTAReplyHandler方法，传递固定结构的function，平台下发的升级任务信息将在这一接收器中进行处理。默认情况下，会直接触发设备升级，根据传递的模块信息、安装包信息等内容进行OTA升级：

// 建议初始化升级任务->下载->安装，也可以自定义升级流程，例如稍后下载/达到某个外界条件时安装，但初始化升级任务是必要步骤
d.SetOTAReplyHandler(func(message arenal.OTAReplyPayload) {
 messageStr, _ := json.Marshal(message)
 fmt.Println(fmt.Sprintf("receive message success!message = %v", string(messageStr)))
 tmpVersion = message.Data.DestVersion
 // 5.1 升级任务初始化
 code, otaMetadata := d.InitOTAJob(message.DeviceIdentification, message.Data)
 if code != arenal.SuccessCode {
     // 错误处理
     log.Infof("no available OTA job was found for the OTA reply message,code:%d,otaMetadata:%v", code, otaMetadata)
     return
 }

 // 5.2 下载流程
 code = d.OTADownload(otaMetadata.OTAModuleName)
 if code != arenal.SuccessCode {
     // 错误处理
     log.Errorf("OTA download failed,code:%d,otaMetadata:%v", code, otaMetadata)
 }

 // 5.3 安装流程
 code = d.OTAInstall(otaMetadata.OTAModuleName)
 if code != arenal.SuccessCode {
     // 错误处理
     log.Errorf("OTA install failed,code:%d,otaMetadata:%v", code, otaMetadata)
 }
})

主动请求升级包信息，调用设备提供的OTAUpgradeRequest方法：

code := d.OTAUpgradeRequest("default", "")
if code != arenal.SuccessCode {
 // 错误处理
 log.Error("upgrade Request failed")
}

完整的Sample详见samples/ota/ota.go。

Webshell

详细Sample请见samples/webshell/webshell.go。

许可证

Apache-2.0 License.