CK_Label_V9 System Developer‘s Manual
Roadway Lights Registration
Place the magnet near the area of the barcode to trigger the Roadway Lights register to the system
Registration success: red light to green light, and then turn off.
Query Roadway Lights Information
Introduction to the API：
Query Roadway Lightss information
Basic Information：
| Attributes |
接口信息 |
|---|---|
| Status |
Finished |
| URL |
http://localhost/wms/associate/queryIndicates |
| Request Method |
GET/POST |
| Content-Type |
multipart/form-data |
Request parameters：
Parameter Description：
| Attributes |
Value |
Required |
Comment |
|---|---|---|---|
| Body transmits the collection of router ids [1828,1829], and query all if you sendd the blank [] |
Request example
| [1828] |
|---|
Response parameters：
| Attributes |
Value |
Types |
Comment |
|---|---|---|---|
| mac |
"99.97.36.55" |
string |
Tag mac/Tag ID |
| hardwareVersion |
"5.1" |
string |
Hardware version |
| manufacture |
CWR000001 |
string |
ID of BindRouter |
| productionBatch |
22-05-06 |
int |
Signal strength (-100 ~ 0) |
| routerId |
1828 |
int |
ID of BindRouter |
| rssi |
-14 |
int |
Signal strength (-100 ~ 0) |
| screenType |
0 |
int |
No use |
| serialNumber |
"CNSHZH23125" |
string |
No use |
| softwareVersion |
"1.5" |
string |
Software version |
| state |
true |
bool |
No use |
| status |
1 |
int |
Status of Tags |
Response example：
| { "datalist": [ { "hardwareVersion": "5.1", "mac": "99.88.06.83", "manufacture": "CoreWind1", "productionBatch": "22-05-06", "routerId": 1828, "rssi": -14, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.5", "state": true, "status": 1 }, { "hardwareVersion": "5.1", "mac": "99.89.19.44", "manufacture": "CoreWind0", "productionBatch": "20-09-09", "routerId": 1828, "rssi": -15, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.4", "state": true, "status": 1 }, { "hardwareVersion": "5.1", "mac": "99.88.06.86", "manufacture": "CoreWind1", "productionBatch": "22-05-06", "routerId": 1828, "rssi": -14, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.5", "state": true, "status": 1 } ], "resultCode": 10, "resultMsg": "success"} |
|---|
| { "datalist": [ { "hardwareVersion": "5.1", "mac": "99.88.06.83", "manufacture": "CoreWind1", "productionBatch": "22-05-06", "routerId": 1828, "rssi": -14, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.5", "state": true, "status": 1 }, { "hardwareVersion": "5.1", "mac": "99.89.19.44", "manufacture": "CoreWind0", "productionBatch": "20-09-09", "routerId": 1828, "rssi": -15, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.4", "state": true, "status": 1 }, { "hardwareVersion": "5.1", "mac": "99.88.06.86", "manufacture": "CoreWind1", "productionBatch": "22-05-06", "routerId": 1828, "rssi": -14, "screenType": 0, "serialNumber": "CNSHZH23125", "softwareVersion": "1.5", "state": true, "status": 1 } ], "resultCode": 10, "resultMsg": "success"} |
Light Roadway Lights
Introduction to the API：
Light Roadway Lights all PTL tags information
Basic Information：
| Attributes |
接口信息 |
|---|---|
| Status |
Finished |
| URL |
http://localhost/wms/associate/ctrlShelfIndicator |
| Request Method |
POST |
| Content-Type |
application/json |
Request parameters：
Parameter Description：
| Attributes |
Types |
Required |
Comment |
|---|---|---|---|
| mac |
string |
yes |
Tag mac / Tag ID |
| timeout |
int |
yes |
Lighting timeout time(s);0 : never turn offn : turn off autoAutomatically after n seconds |
| ledrgb |
string |
yes |
red：ff0000; red Led Ongreen：ff00；green Led Onyellow：ffff00; yellow Led On |
| ledmode |
int |
Yes |
lightint mode;0, always on1, quick flash2, slow flash3, turn of the light according ledrgb4. turn off the lights all |
| buzzer |
int |
yes |
0：Buzzer off，1：Buzzer on |
| reserve |
string |
optional |
reserve |
Raw example：
| [{"mac":"99.29.03.13","timeout":0,"ledrgb":"ffff00","ledmode":0,"buzzer":0,"cmdtoken":"123456","reserve":"reserve"},{"mac":"99.29.05.33","timeout":0,"ledrgb":"ff00ff","ledmode":0,"buzzer":0,"cmdtoken":"123456","reserve":"reserve"}] |
|---|
Response example：
| true |
|---|
Callback of Light Roadway Lights Result
Introduction to the API：
Notification the result of Light Roadway Lights
Basic Information：
| Attributes |
接口信息 |
|---|---|
| Status |
Finished |
| URL |
URL of user's callback API |
| Request Method |
POST |
| Content-Type |
application/json |
Request parameters：
Parameter Description：
| parameter name |
example value |
Type |
Parameter Description |
|---|---|---|---|
| mac |
99.99.08.51 |
string |
Tag ID |
| power |
100 |
int |
surplus power（0~100） |
| result |
true |
bool |
true: Light onfalse:Light failed |
| lednum |
1 |
int |
Led num |
| cmdtoken |
string |
||
| message |
数据成功 |
string |
数据成功；(send ok)数据失败；(send failed)数据发送超时；(send timeout)唤醒失败；(wake up failed)基站不在线；(router offline)数据异常；(Abnormal data)数据格式不正确，解析失败；(incorrect data format)参数格式不正确或参数不全;(Missing required parameters)无法执行;(Unable to execute)标签不存在；(Tag does not exist) |
Parameters example：
| {"mac":"99.99.08.51","result":true,"power":100,"lednum":1,"cmdtoken":"55555","message":"数据成功"} |
|---|
Setting URL of user's callback API
Login wms system with admin user，go to “System Information”->“Third-party configuration”，you can config the Callback URL here:
| 反馈类型 |
描述 |
地址 |
|---|---|---|
| Callback of Light Leds Result |
ctrlShelfIndicatorResult |
URL of user's callback API(CK_Label_V9) |