海萤物联网教程：Go SDK

文章目录海萤物联网教程Go SDK简介特点开源安装背景知识API默认参数绑定管道注册服务调用目的节点服务请求和应答数据格式完整示例ntp服务器开源地址ntp服务介绍读取时间服务1读取时间服务2.返回的是结构体开放服务示例读取时间服务1读取时间服务2海萤物联网教程Go SDK本文博客链接:http://blog.csdn.net/jdh99,作者:jdh,转载请注明.在线文档地址简介此SDK适用于Go 1.12.5版本及以上版本。使用此SDK可以让节点连接海萤物联网与其他节点通信。节点可以是终端设备也可以是个人电脑上的程序可以使用此SDK与其他节点通信并可以以服务的形式开放自己的能力。Go SDK是海萤物联网的SDK之一主要有如下功能连接海萤物联网与其他节点通信以服务的形式开放节点自身的能力特点基于此SDK可以极大降低物联网的开发门槛可以实现一行代码连接网络一行代码开放服务一行代码通信开源github上的项目地址gitee上的项目地址安装推荐使用go modgithub.com/jdhxyy/dcom安装好后在项目中即可导入使用importhttps://github.com/jdhxyy/tziot导入其他相关的包importhttps://github.com/jdhxyy/dcom背景知识海萤物联网教程IA地址格式及地址申请方法海萤物联网教程物联网RPC框架Go DCOMAPI// BindPipeNet 绑定网络管道.绑定成功后返回管道号funcBindPipeNet(iauint64,pwdstring,ipstring,portint)(pipeuint64,errerror)// BindPipe 绑定管道.绑定成功后返回管道号funcBindPipe(iauint64,send SendFunc,isAllowSend IsAllowSendFunc)(pipeuint64)// PipeReceive 管道接收.pipe是发送方的管道号// 如果是用户自己绑定管道,则在管道中接收到数据需回调本函数funcPipeReceive(pipeuint64,data[]uint8)// IsConn 是否连接核心网funcIsConn()bool// Call RPC同步调用// timeout是超时时间,单位:ms.为0表示不需要应答// 返回值是应答字节流和错误码.错误码非0表示调用失败funcCall(pipeuint64,dstIAuint64,ridint,timeoutint,req[]uint8)([]uint8,int)// Register 注册服务回调函数funcRegister(ridint,callback dcom.CallbackFunc)// ConfigCoreParam 配置核心网参数funcConfigCoreParam(iauint64,ipstring,portint)// ConfigDComParam 配置dcom参数// retryNum: 重发次数// retryInterval: 重发间隔.单位:msfuncConfigDComParam(retryNum,retryIntervalint)数据结构// SendFunc 发送函数.dstPipe:目标管道号typeSendFuncfunc(dstPipeuint64,data[]uint8)// IsAllowSendFunc 是否允许发送typeIsAllowSendFuncfunc()bool// dcom中定义// CallbackFunc 注册DCOM服务回调函数// 返回值是应答和错误码.错误码为0表示回调成功,否则是错误码typeCallbackFuncfunc(pipeuint64,srcIAuint64,req[]uint8)([]uint8,int)默认参数当前默认的参数参数值DCOM重发次数5DCOM重发间隔500ms调用ConfigDComParam函数可以修改DCOM参数。ConfigCoreParam函数可以修改海萤物联网平台默认地址使用默认值即可不需要调用函数修改。绑定管道tziot包中封装了dcom包在绑定管道时会初始化DCOM。tziot中调用BindPipe函数可以绑定自定义管道如果使用自定义管道则需应用中调用PipeReceive函数将接收到的数据发送给tziot包。绑定网络管道是绑定管道的一个特例如果节点可以直接连接互联网比如使用以太网或者wifi则调用BindPipeNet函数即可不需要使用BindPipe函数和PipeReceive函数。示例绑定网络管道节点地址是0x2140000000000101本地端口号是12021pipe,err:BindPipeNet(0x2140000000000101,pwd,0.0.0.0,12021)返回的是管道号pipe。后续使用Call函数与其他节点通信需要使用此管道号。绑定管道后sdk会自动连接海萤物联网可以调用IsConn函数查看连接是否成功。注册服务节点可以通过注册服务开放自身的能力。// Register 注册服务回调函数funcRegister(ridint,callback dcom.CallbackFunc)注册函数中每个服务号rid都可以绑定一个服务。示例假设节点2140::101是智能插座提供控制和读取开关状态两个服务tziot.Register(1,controlService)tziot.Register(2,getStateService)// controlService 控制开关服务// 返回值是应答和错误码.错误码为0表示回调成功,否则是错误码funccontrolService(pipeuint64,srcIAuint64,req[]uint8)([]uint8,int){ifreq[0]0{off()}else{on()}returnnil,dcom.SystemOK}// getStateService 读取开关状态服务// 返回值是应答和错误码.错误码为0表示回调成功,否则是错误码funcgetStateService(pipeuint64,srcIAuint64,req[]uint8)([]uint8,int){return[]uint8{state()},dcom.SystemOK}调用目的节点服务// Call RPC同步调用// timeout是超时时间,单位:ms.为0表示不需要应答// 返回值是应答字节流和错误码.错误码非0表示调用失败funcCall(pipeuint64,dstIAuint64,ridint,timeoutint,req[]uint8)([]uint8,int)同步调用会在获取到结果之前阻塞。节点可以通过同步调用调用目标节点的函数或者服务。timeout字段是超时时间单位是毫秒。如果目标节点超时未回复则会调用失败。如果超时时间填0则表示不需要目标节点回复。示例2141::102节点控制智能插座2141::101开关状态为开resp,errCode:tziot.Call(1,0x2140000000000101,3000,[]uint8{1})示例2141::102节点读取智能插座2141::101开关状态resp,errCode:tziot.Call(2,0x2140000000000101,3000,nil)iferrCodedcom.SystemOK{fmt.println(开关状态:,resp[0])}请求和应答数据格式建议使用结构体来通信。详情可参考 海萤物联网教程物联网RPC框架Go DCOM 中的数据格式章节。完整示例示例以与海萤物联网中的ntp服务通信为例。ntp服务器开源地址github上的ntp服务项目地址gitee上的ntp服务项目地址ntp服务介绍海萤物联网ntp服务上线ntp服务器地址0x2141000000000404当前提供两个服务服务号服务1读取时间12读取时间2.返回的是结构体读取时间服务1CON请求空或者带符号的1个字节。当CON请求为空时则默认为读取的是北京时间时区8。也可以带1个字节表示时区号。这个字节是有符号的int8。小技巧可以使用0x100减去正值即负值。比如8对应的无符号数是0x100-8248。ACK应答当前时间的字符串当前时间字符串的格式2006-01-02 15:04:05 -0700 MST读取时间服务2.返回的是结构体CON请求格式与读取时间服务1一致ACK应答struct{// 时区uint8 TimeZone uint16 Year uint8 Month uint8 Day uint8 Hour uint8 Minute uint8 Second// 星期uint8 Weekday}开放服务示例// Copyright 2021-2021 The jdh99 Authors. All rights reserved.// 网络校时服务// Authors: jdh99 jdh821163.compackagemainimport(github.com/jdhxyy/dcomgithub.com/jdhxyy/lagangithub.com/jdhxyy/tziotntp/configtime)consttagntp// 应用错误码const(// 内部错误errorCodeInternalError0x40// 接收格式错误errorCodeRxFormat0x41)// rid号const(// 读取时间.返回的是字符串ridGetTime11// 读取时间.返回的是结构体ridGetTime22)// ACK格式typeAckRidGetTime2struct{// 时区TimeZoneuint8Yearuint16Monthuint8Dayuint8Houruint8Minuteuint8Seconduint8// 星期Weekdayuint8}funcmain(){err:lagan.Load(0)iferr!nil{panic(err)}lagan.EnableColor(true)lagan.SetFilterLevel(lagan.LevelInfo)_,errtziot.BindPipeNet(config.LocalIA,config.LocalPwd,config.LocalIP,config.LocalPort)iferr!nil{panic(err)return}tziot.Register(ridGetTime1,ntpService1)tziot.Register(ridGetTime2,ntpService2)select{}}// ntpService1 校时服务// 返回值是应答和错误码.错误码为0表示回调成功,否则是错误码funcntpService1(pipeuint64,srcIAuint64,req[]uint8)([]uint8,int){addr:dcom.PipeToAddr(pipe)vartimeZoneintiflen(req)0{timeZone8}elseiflen(req)1{timeZoneint(int8(req[0]))}else{lagan.Warn(tag,addr:%v ia:0x%x ntp failed.len is wrong:%d,addr,srcIA,len(req))returnnil,errorCodeRxFormat}t:getTime(timeZone)lagan.Info(tag,addr:%v ia:0x%x ntp time:%v,addr,srcIA,t)return[]uint8(t.Format(2006-01-02 15:04:05 -0700 MST)),0}funcgetTime(timeZoneint)time.Time{t:time.Now().UTC()secondsEastOfUTC:int((time.Duration(timeZone)*time.Hour).Seconds())loc:time.FixedZone(CST,secondsEastOfUTC)tt.In(loc)returnt}// ntpService2 校时服务// 返回值是应答和错误码.错误码为0表示回调成功,否则是错误码funcntpService2(pipeuint64,srcIAuint64,req[]uint8)([]uint8,int){addr:dcom.PipeToAddr(pipe)vartimeZoneintiflen(req)0{timeZone8}elseiflen(req)1{timeZoneint(int8(req[0]))}else{lagan.Warn(tag,addr:%v ia:0x%x ntp failed.len is wrong:%d,addr,srcIA,len(req))returnnil,errorCodeRxFormat}t:getTime(timeZone)lagan.Info(tag,addr:%v ia:0x%x ntp time:%v,addr,srcIA,t)varack AckRidGetTime2 ack.TimeZoneuint8(timeZone)ack.Yearuint16(t.Year())ack.Monthuint8(t.Month())ack.Dayuint8(t.Day())ack.Houruint8(t.Hour())ack.Minuteuint8(t.Minute())ack.Seconduint8(t.Second())ack.Weekdayuint8(t.Weekday())data,err:dcom.StructToBytes(ack)iferr!nil{lagan.Error(tag,addr:%v ia:0x%x ntp failed.struct to bytes error:%v,addr,srcIA,err)returnnil,errorCodeInternalError}returndata,0}读取时间服务1节点2141::401读取ntp服务器的服务1并打印时间字符串。packagemainimport(fmtgithub.com/jdhxyy/tziot)funcmain(){pipe,_:tziot.BindPipeNet(0x2141000000000401,abc123,192.168.1.119,12021)fortziot.IsConn()false{}resp,err:tziot.Call(pipe,0x2141000000000004,1,3000,[]uint8{8})fmt.Println(err:,err,time:,string(resp))}输出结果err: 0 time: 2021-04-01 09:05:33 0800 CST读取时间服务2ntp服务器的2号是结构体形式的时间。packagemainimport(fmtgithub.com/jdhxyy/dcomgithub.com/jdhxyy/tziot)// ACK格式typeAckRidGetTimestruct{// 时区TimeZoneuint8Yearuint16Monthuint8Dayuint8Houruint8Minuteuint8Seconduint8// 星期Weekdayuint8}funcmain(){pipe,_:tziot.BindPipeNet(0x2141000000000401,abc123,192.168.1.119,12021)fortziot.IsConn()false{}resp,_:tziot.Call(pipe,0x2141000000000004,2,3000,[]uint8{8})varack AckRidGetTime_dcom.BytesToStruct(resp,ack)fmt.Println(ack)}输出结果{8 2021 4 1 9 7 20 4}