一、电子标签标签注册
通过手动触发电子标签注册到系统,注册成功就可以进行功能测试。
1、仓储13代注册
用磁铁靠近标签右上角(灯珠上侧)
注册成功显示rssi:-xxdB如下:
绝对值越小信号越差,一般0 ~ -75dB都可以正常通讯
二、查询电子标签信息接口
1、接口描述
查询注册到系统的电子标签的信息。
2、接口信息
接口地址:192.168.1.200/wms/associate/queryTagsInRouterId
请求类型:application/json
请求方式:post
接口备注:根据基站id查询电子标签信息
调试工具:ApiPost
请求体参数说明:
参数名称 |
示例值 |
类型 |
参数说明 |
---|---|---|---|
基站id的集合,传空则查全部 |
请求示例:
[1] |
---|
返回参数说明:(200)成功
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
datalist |
Object |
标签信息的集合 |
|
datalist.hardwareVersion |
4.5 |
String |
硬件版本号 |
datalist.height |
128 |
Number |
分辨率(高) |
datalist.mac |
99.26.17.85 |
String |
标签id号 |
datalist.manufacture |
CoreWind31 |
String |
型号标识 |
datalist.power |
100 |
Number |
标签电量 |
datalist.productionBatch |
20-08-29 |
String |
生产批次 |
datalist.routerId |
1 |
Number |
绑定基站ID |
datalist.rssi |
-21 |
Number |
信号强度 |
datalist.screenType |
1 |
Number |
屏幕类型 |
datalist.serialNumber |
CNSHZH1000 |
String |
序列号 |
datalist.shopNumber |
A0015 |
String |
所属店铺 |
datalist.showStyle |
拣货模板单列 |
String |
使用模板名称 |
datalist.softwareVersion |
7.0 |
String |
软件版本号 |
datalist.state |
true |
String |
在线状态 |
datalist.status |
4 |
Number |
更新状态 |
datalist.tagRegisterEN |
1 |
Number |
允许标签注册开关 |
datalist.width |
296 |
Number |
分辨率(宽) |
resultCode |
10 |
Number |
返回码 |
resultMsg |
success |
String |
接口响应信息 |
返回示例:(200)成功
{"datalist": [{"hardwareVersion": "4.5","height": 128,"mac": "99.26.17.85","manufacture": "CoreWind31","power": 100,"productionBatch": "20-08-29","routerId": 1,"rssi": -21,"screenType": 1,"serialNumber": "CNSHZH1000","shopNumber": "A0015","showStyle": "拣货模板单列","softwareVersion": "7.0","state": true,"status": 4,"tagRegisterEN": 1,"width": 296},{"hardwareVersion": "4.5","height": 128,"mac": "99.26.18.21","manufacture": "CoreWind31","power": 87,"productionBatch": "20-08-29","routerId": 1,"rssi": -19,"screenType": 1,"serialNumber": "CNSHZH1000","shopNumber": "A0015","showStyle": "拣货模板单列","softwareVersion": "7.0","state": true,"status": 4,"tagRegisterEN": 1,"width": 296},{"hardwareVersion": "4.5","height": 128,"mac": "99.26.18.36","manufacture": "CoreWind31","power": 100,"productionBatch": "20-08-29","routerId": 1,"rssi": -25,"screenType": 1,"serialNumber": "CNSHZH1000","shopNumber": "A0015","showStyle": "拣货模板单列","softwareVersion": "7.0","state": true,"status": 4,"tagRegisterEN": 0,"width": 296}],"resultCode": 10,"resultMsg": "success"} |
---|
返回参数说明:(201)失败
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
无请求参数 KEY/VALUE 类型 |
三、根据模板刷新屏幕接口
1、接口描述
墨水屏管理系统配置模板,然后根据设计的模板调用接口
2、接口信息
接口地址:
http://192.168.1.200/wms/associate/updateScreen
请求类型:application/json
请求方式:post
接口备注:暂无描述
调试工具:ApiPost
请求体参数说明:
参数名 |
示例值 |
参数类型 |
是否必填 |
参数描述 |
---|---|---|---|---|
mac |
99.26.17.85 |
String |
是 |
标签id号 |
mappingtype |
694 |
Number |
否 |
映射类型,可不传 |
styleid |
30 |
Number |
是 |
模板id |
ledrgb |
0 |
String |
是 |
亮灯颜色red,ledrgb =“ff0000”;green,ledrgb=“ff00”;blue,ledrgb=“ff”;yellow,ledrgb=“ffff00”;white,ledrgb=“ffffff”;purple,ledrgb= “ff00ff”;light blue,ledrgb= “ffff”;no color, ledrgb=“0”不需要亮灯传0 |
ledstate |
0 |
String |
是 |
亮灯模式:0,常亮;1,快闪;2,慢闪;3,灭灯; |
outtime |
0 |
String |
是 |
亮灯自动超时时间,0: 一直亮;n: n秒后自动熄灭; |
startMachine |
PE1-01 |
String |
否 |
自定义添加,起点工序台 |
endMachine |
PE2-05 |
String |
否 |
自定义添加,终点工序台 |
taskStartTime |
2022-11-11 9:00 |
String |
否 |
自定义添加,任务开始时间 |
basketsQuantity |
20 |
number |
否 |
自定义添加,花篮数量 |
arrow |
空 |
字符串 |
是 |
箭头图标,不传值即可 |
power |
空 |
number |
否 |
自动显示可不传 |
rssi |
空 |
number |
否 |
自动显示可不传 |
请求示例:
[{"mac":"99.29.3.22","mappingtype":791,"styleid":44,"ledrgb":"0","ledstate":"0","outtime":"0""startMachine":"PE1-01","endMachine":"PE2-05","taskStartTime":"2022-11-18 9:00","basketsQuantity":"99","arrow":"","rssi":"","power":"",},{"mac":"99.29.3.22","mappingtype":791,"styleid":44,"ledrgb":"0","ledstate":"0","outtime":"0""startMachine":"PE1-01","endMachine":"PE2-05","taskStartTime":"2022-11-18 9:00","basketsQuantity":"99","arrow":"","rssi":"","power":"",}] |
---|
返回参数说明:(200)成功
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
无请求参数 KEY/VALUE 类型 |
返回示例:(200)成功
true |
---|
返回参数说明:(201)失败
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
无请求参数 KEY/VALUE 类型 |
四、更新屏幕结果回调
1、接口描述
更新屏幕的结果反馈,异步
2、接口信息
回调请求类型:application/json
回调请求方式:post
回调请求备注:墨水服务器为调用方,客户软件接收回调
回调请求参数示例:
{"cmdtoken":"cmdtoken","lednum":0,"mac":"99.88.29.82","message":"数据成功","power":100,"result":true} |
---|
回调请求参数说明:
参数名称 |
示例值 |
类型 |
参数说明 |
---|---|---|---|
mac |
99.89.40.57 |
string |
触发按键的标签ID号 |
result |
true |
int |
true,更新成功false,更新失败 |
power |
100 |
int |
墨水屏当前电量 |
message |
数据成功 |
string |
提示信息 |
lednum |
0 |
int |
不处理 |
cmdtoken |
string |
不处理 |
3、回调接口设置
描述 |
url地址 |
---|---|
updateTagResult |
客户自己的回调接口地址文章来源地址https://www.toymoban.com/news/detail-632899.html |
五、单独点灯接口
1、接口描述
单独点灯接口
2、接口信息
接口地址:
http://192.168.1.200/wms/associate/lightTagsLed
请求类型:application/json
请求方式:post
接口备注:暂无描述
调试工具:ApiPost
请求体参数说明:
参数名 |
示例值 |
参数类型 |
是否必填 |
参数描述 |
---|---|---|---|---|
mac |
99.26.17.85 |
string |
是 |
指示灯所在标签的mac地址 |
lednum |
694 |
int |
否 |
只有一个灯默认传0或者255 |
timeout |
30 |
int |
是 |
对应时间多少秒后标签自动熄灭;默认传0不自动熄灭 |
ledrgb |
0 |
string |
是 |
亮灯颜色red,ledrgb =“ff0000”;green,ledrgb=“ff00”;blue,ledrgb=“ff”;yellow,ledrgb=“ffff00”;white,ledrgb=“ffffff”;purple,ledrgb= “ff00ff”;light blue,ledrgb= “ffff”;no color, ledrgb=“0”不需要亮灯传0 |
ledmode |
0 |
int |
是 |
0:标签指示灯常亮;1:标签指示灯快闪;2:标签指示灯慢闪;3:灭灯;4:全灭; |
cmdtoken |
0 |
string |
是 |
扩展参数,可不传 |
reserve |
PE1-01 |
string |
否 |
预留 |
请求示例:
[{"mac": "99.88.64.65","lednum": 2,"timeout": 0,"ledrgb": "ff00","ledmode": 0,"reserve": "reserve","cmdtoken": "Inve123ntec"},{"mac": "99.88.64.65","lednum": 2,"timeout": 0,"ledrgb": "ff00","ledmode": 0,"reserve": "reserve","cmdtoken": "Inve123ntec"}] |
---|
返回参数说明:(200)成功
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
无请求参数 KEY/VALUE 类型 |
返回示例:(200)成功
true |
---|
返回参数说明:(201)失败
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
无请求参数 KEY/VALUE 类型 |
六、单独点灯接口结果回调
1、接口描述:
仓储13代电子标签点灯结果回调接口介绍;
2、接口信息
点灯结果回调接口
回调请求类型:application/json
回调请求方式:post
回调参数格式:json object
回调请求备注:墨水服务器为调用方,客户软件接收回调
回调请求参数示例:
{"mac":"99.99.08.51","result":true,"power":100,"lednum":1,"cmdtoken":"55555","message":"数据成功"} |
---|
参数名 |
示例值 |
参数类型 |
参数描述 |
---|---|---|---|
mac |
99.99.08.51 |
string |
触发按键的标签ID号 |
power |
100 |
int |
标签剩余电量(0~100) |
result |
true |
bool |
true:点亮成功false:点亮失败 |
lednum |
1 |
int |
亮灯编号 |
cmdtoken |
string |
返回调用请求传入的cmdtoken,可不使用 |
|
message |
数据成功 |
string |
数据成功;数据失败;数据发送超时;唤醒失败;基站不在线;数据异常;数据格式不正确,解析失败;参数格式不正确或参数不全,无法执行标签不存在; |
3、回调接口设置
描述 |
url地址 |
---|---|
ctrlShelfIndicatorResult |
客户自己的回调接口地址 |
七、按键事件回调
1、接口描述:
仓储13代电子标签按键事件回调接口介绍
2、接口信息
按键事件回调接口
回调请求类型:application/json
回调请求方式:post
回调参数格式:json object
回调请求备注:墨水服务器为调用方,客户软件接收回调
回调请求参数示例:
{"mac":"92.91.34.99","result":0} |
---|
参数名称 |
示例值 |
类型 |
参数说明 |
---|---|---|---|
mac |
92.91.34.99 |
string |
触发按键的标签ID号 |
result |
0 |
int |
result=0,右下按键; |
3、回调接口设置
描述 |
url地址 |
---|---|
enterKey |
客户自己的回调接口地址 |
八、基站状态上报回调
1、接口描述:
基站状态上报回调接口介绍;
2、接口信息
基站状态上报回调接口
回调请求类型:application/json
回调请求方式:post
回调参数格式:json object
回调请求备注:墨水服务器为调用方,客户软件接收回调
回调请求参数示例:
{ "frequency": 460, //频率 "hardVersion": "8.1.2", //硬件版本 "id": 1844, //基站地址 "ip": "192.168.1.244", //IP地址 "longPeriod": 1, //长周期 "masterRouterMac": 0, "productBatch": "2021-11-01", "serialNumber": "CNSHZH1844", "shortPeriod": 0.5, //短周期 "softVersion": "8.3.3", //软件版本 "state": 1, // 1在线 , 0 离线 "tagRegisterEN": 1 //注册开关,1开启,0关闭} |
---|
请求体参数说明:
参数名 |
示例值 |
参数类型 |
是否必填 |
参数描述 |
---|---|---|---|---|
id |
1820 |
int |
基站ID编号 |
|
ip |
"192.168.1.244" |
string |
基站IP地址 |
|
frequency |
460 |
int |
基站通讯频率(显示的频率比实际频率小435) |
|
hardVersion |
"8.1.2" |
string |
硬件版本号 |
|
masterRouterMac |
0 |
int |
||
productBatch |
"2021-11-01" |
string |
生产批次 |
|
serialNumber |
"CNSHZH1844" |
string |
序列号 |
|
shortPeriod |
0.5 |
float |
短周期 |
|
softVersion |
"8.3.3" |
string |
软件版本号 |
|
state |
1 |
int |
基站状态 |
|
tagRegisterEN |
1 |
int |
允许标签注册开关1:开启0:关闭 |
3、回调接口设置
描述 |
url地址 |
---|---|
routerLoginAck |
客户自己的回调接口地址 |
九、标签注册事件回调
1、接口描述:
仓储13代电子标签注册事件回调接口介绍;
2、接口信息
按键事件回调接口
回调请求类型:application/json
回调请求方式:post
回调参数格式:json object
回调请求备注:墨水服务器为调用方,客户软件接收回调
回调请求参数示例:
{ "hardwareVersion": "4.7", //硬件版本 "height": 300, //高度 "mac": "99.88.29.86", //标签地址 "manufacture": "CoreWind24", "power": 100, //电量 "productionBatch": "20-11-05", "routerId": 1844, //基站地址 "rssi": -24, //信号强度 "screenType": 1, //屏幕类型 "serialNumber": "CNSHZH1000", "shopNumber": "A0001", "showStyle": "默认模板46", //样式名称 "softwareVersion": "7.2", //软件版本 "state": true, "status": 4, "tagRegisterEN": 1, //注册开关 "width": 400 //宽度} |
---|
请求体参数说明:
参数名 |
示例值 |
参数类型 |
是否必填 |
参数描述 |
---|---|---|---|---|
mac |
"99.88.29.86" |
int |
电子标签ID编号 |
|
power |
100 |
int |
标签剩余电量 |
|
routerId |
460 |
int |
所属基站的ID |
|
rssi |
"8.1.2" |
string |
信号强度 |
|
screenType |
1 |
int |
屏幕类型 |
|
height |
300 |
string |
屏幕高度 |
|
width |
400 |
string |
屏幕宽度 |
|
status |
4 |
int |
更新状态 |
|
state |
true |
int |
基站状态 |
|
showStyle |
"默认模板46" |
string |
使用的模板名称 |
|
softwareVersion |
"7.2" |
string |
软件版本号 |
|
hardwareVersion |
"4.7" |
string |
硬件版本号 |
|
serialNumber |
"CNSHZH1000" |
string |
序列号 |
|
shopNumber |
"A0001" |
string |
店铺编号 |
|
productionBatch |
"20-11-05" |
string |
生产批次 |
|
manufacture |
"CoreWind24" |
string |
供应商 |
|
tagRegisterEN |
1 |
int |
允许标签注册开关1:开启0:关闭 |
3、回调接口设置
描述 |
url地址 |
---|---|
tagRegisterAck文章来源:https://www.toymoban.com/news/detail-632899.html |
客户自己的回调接口地址 |
到了这里,关于仓储13代电子标签接口文档的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!