|
|
本帖最后由 894540228 于 2017-7-12 14:06 编辑
近期OneNET上线了TCP透传功能，该功能旨在尽量弱化终端测软件为了适配协议而做的修改，将协议的解析功能放在了平台测，为的是更加方便用户的终端（特别是DTU）的接入。下面我们将以网络助手为例，做一个简单的接入示例，该示例内容如下：
1、模拟终端（TCP网络助手）能够连接上平台；
2、使用脚本实现周期性下发数据；
3、使用脚本实现，平台接收到模拟终端上传数据，即刻回复消息；
4、使用脚本实现，平台将接收到的二进制数据以字符串的形式保存，并能够在平台数据流中查看；
本示例中用到的脚本如下：文件下载：
sample-save-str.rar
(3.21 KB, 下载次数: 18)
(3.21 KB)
- -----------------------------------------------------------------------
- -- 使用说明： --
- -- V1.3 --
- -- 用户需要自行完成一下2个函数的实现 --
- -- 1、定时下发数据任务初始化函数：device_timer_init(dev)【可选】 --
- -- 2、对设备上传数据进行解析（包括心跳等）：device_data_analyze(dev) --
- -----------------------------------------------------------------------
- -------------------------------------------------------------------------------
- -- 注册C函数 --
- -- u2f 将32位整型内存数据转换为浮点数（不同于值转换） --
- -- 类似C代码 *(float*)(&u) --
- -- function u2f(u) --
- -- @param u number 整数值 --
- -- @return 成功返回浮点数值，否则返回nil --
- -- @example local u = 123 --
- -- local f = u2f( 123 ) --
- -- --
- -- time 获取时间戳，距离（00:00:00 UTC, January 1, 1970）的毫秒数 --
- -- function time() --
- -- @return 返回当前时间戳 --
- -- @example local t = time() --
- -- --
- -- year 获取年（year-1900） --
- -- function year(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回年 --
- -- @example local y = year( t ) --
- -- --
- -- month 获取月（0-11） --
- -- function month(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回月 --
- -- @example local m = month( t ) --
- -- --
- -- day 获取日（1-31） --
- -- function day(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回月 --
- -- @example local d = day( t ) --
- -- --
- -- hour 获取时（0-23） --
- -- function hour(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回时 --
- -- @example local h = hour( t ) --
- -- --
- -- minute 获取分（0-59） --
- -- function minute(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回分 --
- -- @example local m = minute( t ) --
- -- --
- -- second 获取秒（0-59） --
- -- function second(t) --
- -- @param t number 时间戳，距离（00:00:00 UTC, January 1, 1970）的秒数 --
- -- @return 返回秒 --
- -- @example local m = second( t ) --
- -------------------------------------------------------------------------------
- --------------------------------------------------------
- -- 将bytes string转换hex string --
- -- @param s string bytes string --
- -- @return 返回hex string，类似"0A0B0C0D..." --
- -- @example local hex = to_hex("\2\2\0\150\0\37\206") --
- --------------------------------------------------------
- function to_hex(s)
- local i
- local t
- t={s:byte(1,s:len())}
- for i=1,#t do
- t=string.format('%02X',t)
- end
- return table.concat(t)
- end
- -----------------------------------------------
- -- 将object序列化成字符串 --
- -- @param o boolean|number|string|table --
- -- @return 返回序列化string --
- -- @example local str = to_str({x=100}) --
- -----------------------------------------------
- function to_str(o)
- local i=1
- local t={}
- local f
- f=function(x)
- local y=type(x)
- if y=="number" then
- t=x
- i=i+1
- elseif y=="boolean" then
- t=tostring(x)
- i=i+1
- elseif y=="string" then
- t="\""
- t[i+1]=x
- t[i+2]="\""
- i=i+3
- elseif y=="table" then
- t="{"
- i=i+1
- local z=true
- for k,v in pairs(x) do
- if z then
- z=false
- t="\""
- t[i+1]=k
- t[i+2]="\""
- t[i+3]=":"
- i=i+4
- f(v)
- else
- t=","
- t[i+1]="\""
- t[i+2]=k
- t[i+3]="\""
- t[i+4]=":"
- i=i+5
- f(v)
- end
- end
- t="}"
- i=i+1
- else
- t="nil"
- i=i+1
- end
- end
- f(o)
- return table.concat(t)
- end
- ----------------------------------------------------------------------------------------------------------
- -- 添加值数据点到table中 --
- -- @param t table --
- -- i string 数据流或数据流模板名称 --
- -- a number 毫秒级时间戳，距离（00:00:00 UTC, January 1, 1970）的毫秒； --
- -- 如果值为0，表示使用当前时间 --
- -- v boolean|number|string|table 布尔值、数值、字符串、json --
- -- c string 用于标识数据点归属(设备AuthCode,可选) --
- -- 如果值为“”或nil，表示数据点归属建立TCP连接的设备 --
- -- @return 成功返回true，否则返回false --
- -- @example local ok = add_val(t,"dsname",0,100) --
- ----------------------------------------------------------------------------------------------------------
- function add_val(t, i, a, v, c)
- if type(t)~="table" then
- return false
- elseif type(i)~="string" then
- return false
- elseif type(a)~="number" then
- return false
- else
- local o = type(v)
- if o~="boolean" and o~="number" and o~="string" and o~="table" then
- return false
- end
- local n = {i=i,v=to_hex(v)}
- -- n.v = n.v .. "("..o..")"
- if a~=0 and a~=nil then
- n["a"]=a
- end
- if c~=nil then
- n["c"]=c
- end
- -- list push_back --
- if t.h==nil then
- t.h={nil,n}
- t.t=t.h
- else
- t.t[1]={nil,n}
- t.t=t.t[1]
- end
- end
- return true
- end
- --------------------------------------------------------------
- -- 将table序列化成json字符串 --
- -- @param t table 通过add_val、add_bin构建起来的table --
- -- @return 返回序列化json字符串 --
- -- @example local json = to_json(t) --
- --------------------------------------------------------------
- function to_json(t)
- local i=1
- local o={}
- local n
- o="["
- i=i+1
- n=t.h
- while n~=nil do
- if n[2]~=nil then
- o=to_str(n[2])
- i=i+1
- end
- n=n[1]
- if n~=nil then
- o=","
- i=i+1
- end
- end
- o="]"
- return table.concat(o)
- end
- ------------------------------------
- -- begin-添加用户自定义值或函数等 --
- -- end-添加用户自定义值或函数等 --
- ------------------------------------
- ------------------------------------------------------------------------------------------
- -- 设置定时下发设备的数据（可选） --
- -- @param dev user_data 设备管理器 --
- -- @return 无 --
- -- @notice 此函数为回调函数，不可在脚本内调用 --
- -- @readme dev提供一下几个函数： --
- -- dev:add(interval,name,data)添加定时下发数据 --
- -- @param interval number 数据下发的时间间隔（秒） --
- -- name string 名称（须保证唯一性） --
- -- data string 数据（二进制数据），使用lua转义字符串 --
- -- @return 成功返回true，否则返回false --
- -- @notice 定时数据下发的平均频率不超过1，及1/interval_1+...+1/interval_n<=1 --
- -- @example local ok = dev:add(10,"test","\1\1\0\150\0\37\253\29") --
- -- dev:timeout(sec)设置下发数据的设备响应超时时间（秒） --
- -- @param sec int 响应超时时间（秒） --
- -- 如果值为0，表示不检测设备响应超时 --
- -- @return 无 --
- -- @example dev:timeout(3) --
- -- dev:response()设备响应成功 --
- -- @param 无 --
- -- @return 无 --
- -- @example dev:response() --
- -- dev:send(data)下发数据到设备 --
- -- @param data string 数据（二进制数据），使用lua转义字符串 --
- -- @return 无 --
- -- @example dev:send("\2\2\0\150\0\37\206\89") --
- ------------------------------------------------------------------------------------------
- function device_timer_init(dev)
- -- 添加用户自定义代码 --
- -- 例如： --
- dev:timeout(3)
- dev:add(10,"dev1","hello") --每10秒下发一包数据，内容为hello
- end
- -----------------------------------------------------------------------------------------------------------
- -- 解析设备上传数据 --
- -- @param dev user_data 设备管理器 --
- -- @return size表示已解析设备上传数据的字节数，json表示解析后的数据点集合，格式如下： --
- -- [ --
- -- { --
- -- "i" : "dsname1", // 数据流或数据流模板名称1 --
- -- "a" : 1234567890, // 毫秒级时间戳，距离（00:00:00 UTC, January 1, 1970）的毫秒 --
- -- // 如果值为0，表示使用当前时间 --
- -- "v" : 123 | "123" | {...} // 布尔值、数值、字符串、json --
- -- "b" : "0A0B0C0D..." // 二进制数据（16进制字符串），与v互斥，不同时存在 --
- -- "d" : xxx | "xxx" | {...} // 用于描述b（可选）；布尔值、数值、字符串、json --
- -- "c" : "authcode1" // 用于标识数据点归属(设备AuthCode,可选) --
- -- // 如果为“”或不存在，表示数据点归属建立TCP连接的设备 --
- -- } --
- -- ... --
- -- { --
- -- "i" : "dsnamen", // 数据流或数据流模板名称1 --
- -- "a" : 1234567890, // 毫秒级时间戳，距离（00:00:00 UTC, January 1, 1970）的毫秒 --
- -- // 如果值为0，表示使用当前时间 --
- -- "v" : 123 | "123" | {...} // 布尔值、数值、字符串、json --
- -- "b" : "0A0B0C0D..." // 二进制数据（16进制字符串），与v互斥，不同时存在 --
- -- "d" : xxx | "xxx" | {...} // 用于描述b（可选）；布尔值、数值、字符串、json --
- -- "c" : "authcoden" // 用于标识数据点归属(设备AuthCode,可选) --
- -- // 如果为“”或不存在，表示数据点归属建立TCP连接的设备 --
- -- } --
- -- ] --
- -- @notice 此函数为回调函数，不可在脚本内调用 --
- -- @readme dev提供一下几个函数： --
- -- dev:add(interval,name,data)添加定时下发数据 --
- -- @param interval number 数据下发的时间间隔（秒） --
- -- name string 名称（须保证唯一性） --
- -- data string 数据（二进制数据），使用lua转义字符串 --
- -- @return 成功返回true，否则返回false --
- -- @notice 定时数据下发的平均频率不超过1，及1/interval_1+...+1/interval_n<=1 --
- -- @example local ok = dev:add(10,"test","\1\1\0\150\0\37\253\29") --
- -- dev:timeout(sec)设置下发数据的设备响应超时时间（秒） --
- -- @param sec int 响应超时时间（秒） --
- -- 如果值为0，表示不检测设备响应超时 --
- -- @return 无 --
- -- @example dev:timeout(3) --
- -- dev:response()设备响应成功 --
- -- @param 无 --
- -- @return 无 --
- -- @example dev:response() --
- -- dev:send(data)下发数据到设备 --
- -- @param data string 数据（二进制数据），使用lua转义字符串 --
- -- @return 无 --
- -- @example dev:send("\2\2\0\150\0\37\206\89") --
- -- dev:size()获取设备数据大小（字节数） --
- -- @param 无 --
- -- @return 返回设备数据大小（字节数） --
- -- @example local sz = dev:size() --
- -- dev:byte(pos)获取pos对应位置的设备数据（字节） --
- -- @param pos number 指定的获取位置，取值范围[1,dev:size()+1) --
- -- @return 成功返回设备数据（int），否则返回nil --
- -- @example local data = dev:byte(1) --
- -- dev:bytes(pos,count)获取从pos开始，count个设备数据 --
- -- @param pos number 指定的获取起始位置，取值范围[1,dev:size()+1) --
- -- count number 指定的获取数据总数，取值范围[0,dev:size()+1-pos] --
- -- @return 成功返回设备数据（string），否则返回nil --
- -- @example local datas = dev:bytes(1,dev:size()) --
- -----------------------------------------------------------------------------------------------------------
- function device_data_analyze(dev)
- local t = {}
- local a = 0
- -- 添加用户自定义代码 --
- -- 例如： --
- local s = dev:size() --获取上行数据长度
- add_val(t,"ds_test",0,dev:bytes(1,s))
- dev:response()
- dev:send("received") --发送应答
- -- return $1,$2 --
- -- 例如： --
- return s,to_json(t) --保存该数据
- end
[color=rgb(85, 85, 85) !important]复制代码
其中：
device_data_analyze(dev) 为终端上行数据解析函数，每一包数据都会经过其处理；
device_timer_init(dev) 为定时器初始化函数，用于指定周期性的数据下发操作；
STEP 1
创建产品，创建设备（略）
STEP 2
上传Lua脚本
这里需要注意的是，脚本名称很重要，在设备登陆的时候需要用做参数
STEP 3
设备登陆
设备登陆报文是在建立TCP连接之后，用于告知OneNET平台，该终端/DTU对应的是平台上的哪一个设备，数据用何种方式进行解析；
格式为 *PID#AuthCode#ParserName*
其中：
PID 为 产品ID
AuthCode 为 鉴权信息（创建设备的时候所指定）
ParserName 为 脚本名称（上传Lua脚本的时候所指定）
本例中
PID为83901
AuthCode为0001
脚本名称为sample（见STEP 2）
故登陆报文为
*83901#0001#sample*
建立TCP连接（地址为 183.230.40.40 ：1811），并发送登陆报文，可以查看到设备的在线状态：
STEP 4 观察平台周期性下发数据
在本例中，脚本中的device_timer_init(dev)函数如下：
- function device_timer_init(dev)
- -- 添加用户自定义代码 --
- -- 例如： --
- dev:timeout(3)
- dev:add(10,"dev1","hello") --每10秒下发一包数据，内容为hello
- end
[color=rgb(85, 85, 85) !important]复制代码
其中 dev:add(10,"dev1","hello") 定义了每10秒下发一包数据，内容为hello
所以在发送连接报文之后，每10秒中会收到平台下发的消息，hello
STEP 5 上传16进制数据，观察平台应答以及平台数据
在本例中，脚本中的device_timer_init(dev)函数如下：
- function device_data_analyze(dev)
- local t = {}
- local a = 0
- -- 添加用户自定义代码 --
- -- 例如： --
- local s = dev:size() --获取上行数据长度
- add_val(t,"ds_test",0,dev:bytes(1,s)) --ds_test 为自定义数据流名称
- dev:response()
- dev:send("received") --发送应答
- -- return $1,$2 --
- -- 例如： --
- return s,to_json(t) --保存该数据
- end
[color=rgb(85, 85, 85) !important]复制代码
其中 dev:send("received") 决定了，每收到一包上行数据，平台会响应一包应答，received
所以在发送连接报文之后，每发送一包数据，会收到平台的received作为应答
另外，模拟终端上传16进制的 0xa1 0xb2 0xc3 0xd4 ，被脚本转化为字符串形式的"A1B2C3D4"存储在ds_test 数据流中
使用有人DTU，利用TCP透传协议连接OneNET并上传数据的实例：https://open.iot.10086.cn/bbs/thread-2204-1-1.html
（完）
|
|
发表于 2017-7-12 13:58