CK-Label-V16 System Developer‘s Manual

Query PTL Tags Information

Introduction to the API：

Query all PTL tags information

Basic Information：

Attributes	Interface information
Status	Finished
URL	http://localhost/wms/associate/getTagsMsg
Request Method	GET/POST
Content-Type	multipart/form-data

Request parameters：

Parameter Description：

Attributes	Value	Required	Comment

Response parameters：

Attributes	Value	Types	Comment
lastOpreateTime	"2021-10-13 03:32:30"	string	Last opreate TIme
mac	"99.97.36.55"	string	Tag mac/Tag ID
power	100	string	Battery power(0~100)
routerid	CWR000001	string	ID of BindRouter
rssi	-26	int	Signal strength (-100 ~ 0)
showStyle	"Picking Template"	string	Using template name

Response example：

[{"lastOpreateTime": "2021-10-13 03:32:29","mac": "99.97.36.55","power": 100,"routerid": "CWR000001","rssi": -30,"showStyle": "Picking Template"},{"lastOpreateTime": "2021-10-13 03:32:30","mac": "99.97.36.53","power": 100,"routerid": "CWR000001","rssi": -26,"showStyle": "Picking Template"},{"lastOpreateTime": "2021-10-13 03:32:33","mac": "99.97.36.48","power": 88,"routerid": "CWR000001","rssi": -39,"showStyle": "Picking Template"}]

Update Led display

Introduction to the API：

API for Update Led display

Basic Information：

Attributes	Interface information
Status	Finished
URL	http://localhost/wms/associate/updateLedScreen
Request Method	POST
Content-Type	application/json

Request parameters：

Parameter Description：

Attributes	Types	Required	Comment
mac	string	yes	Tag mac / Tag ID
styleid	int	yes	Template ID
outtime	int	Yes	Lighting timeout time(s);0 : never turn offn : turn off autoAutomatically after n seconds
number	string	optional	Filed created in template
progressBar	string	optional	Filed created in template

Raw example：

[{"mac": "99.29.04.00", "styleId": 45, "number": "123456", "outtime": "0", "progressBar": 80 }]

Response parameters：

Attributes	Value	Types	Comment

Response example：

{"datalist": [{"mac": "99.29.04.00","reslut": false}],"resultCode": 10,"resultMsg": "success"}

Note: The fields parameters are according the according to the template you used. This API does not support lighting Leds of Multi-led PTL(External power supply version) , only refreshing the screen

Callback of UpdateScreen result

Introduction to the API：

Notification the update result of PTL

Basic Information：

Attributes	Interface information
Status	Finished
URL	URL of user's callback API
Request Method	POST
Content-Type	application/json

Request parameters：

Parameter Description：

Attributes	Types	Required	Comment
mac	string	yes	Tag mac / Tag ID
power	int	yes	Battery power(0~100)
result	bool	Yes	True ：ok；False: failed；
cmdtoken	string	optional	Return the cmdtoken passed in the call request
lednum	string	optional	No use
message	int	Yes	Data success; (send ok)Data failure; (send failed)Data transmission timeout; (send timeout)Wake-up failure; (wake up failed)The base station is not online; (router offline)Data anomalies; (Abnormal data)The data format is incorrect, and the parsing fails; (incorrect data format)Incorrect or incomplete parameters; (Missing required parameters)Unable to execute;() could not be executedThe label does not exist; (Tag does not exist)

Parameters example：

{"cmdtoken":" 1634826092022","lednum":0,"mac":99.26.99.36","message": "data success","power":100,"result":false}

Response parameters：

Attributes	Value	Types	Comment

Response example：

true

Callback of button event

Introduction to the API：

Notification of button event.

Basic Information：

Attributes	Interface information
Status	Finished
URL	URL of user's callback API
Request Method	POST
Content-Type	application/json

Request parameters：

Parameter Description：

Attributes	Types	Required	Comment
mac	string	yes	Tag mac / Tag ID
power	int	yes	Battery power(0~100)
result	bool	Yes	True ：ok；False: failed；
cmdtoken	string	optional	Return the cmdtoken passed in the call request
lednum	string	optional	No use
message	int	Yes	Data success; (send ok)Data failure; (send failed)Data transmission timeout; (send timeout)Wake-up failure; (wake up failed)The base station is not online; (router offline)Data anomalies; (Abnormal data)The data format is incorrect, and the parsing fails; (incorrect data format)Incorrect or incomplete parameters; (Missing required parameters)Unable to execute;() could not be executedThe label does not exist; (Tag does not exist)

Parameters example：

{"cmdtoken":" 1634826092022","lednum":0,"mac":99.26.99.36","message": "data success","power":100,"result":false}

Response parameters：

Attributes	Value	Types	Comment

Response example：

true

Parameter format: json object

parameter	data type	function	description
mac	string	Label mac address	Indicates the mac address of the label where the light is located
result	int	Keys feedback results	result=1, right 1 button; result=2, left 1 button; result=3, left 2 buttons; result=4, left 3 buttons;

Light Leds of Tag(External power supply)

Introduction to the API：

Query all PTL tags information

Basic Information：

Attributes	Interface information
Status	Finished
URL	http://localhost/wms/associate/ctrlTagLed
Request Method	POST
Content-Type	application/json

Request parameters：

Parameter Description：

Attributes	Types	Required	Comment
mac	string	yes	Tag mac / Tag ID
styleid	int	yes	Template ID
outtime	int	Yes	Lighting timeout time(s);0 : never turn offn : turn off autoAutomatically after n seconds
ledstate	int	Yes	lightint mode;0, always on1, quick flash2, slow flash
ledrgb	string	Yes	led color: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"
cmdtoken	string	optional	Extended parameters, it can use as token or taskid
LGPLA	string	optional	Filed created in template
MATNR	string	optional	Filed created in template
STOCK	string	optional	Filed created in template
QUANTITY	string	optional	Filed created in template
QRCODE	string	optional	Filed created in template

Raw example：

[{"mac":"99.96.19.66","styleid":35,"ledrgb":"ff00","ledstate":0,"outtime":0,"LGPLA":"***","MATNR":"***","KNMAT":"***","STOCK":"***","BATCH":"***","QUANTITY":"***","QRCODE":"***","Inventec":"***"},{"mac":"99.96.19.65","styleid":35,"ledrgb":"ff00","ledstate":0,"outtime":0,"LGPLA":"***","MATNR":"***","KNMAT":"***","STOCK":"***","BATCH":"***","QUANTITY":"***","QRCODE":"***","Inventec":"***"}]

Response parameters：

Attributes	Value	Types	Comment

Response example：

true

parameter	data type	function	description
mac	string	Label mac address	Indicates the mac address of the label where the light is located
lednum	int	Indicates the number of the lamp	Which indicator light (number: 1~4) needs to be controlled
timeout	int	The light timeout period	The label automatically extinguishes after the corresponding time for how many seconds; The default pass 0 does not automatically turn off
ledrgb	string	Light color	Rgb color value:Red, ledrgb = "ff0000"; green, ledrgb="ff00"; Blue, ledrgb="ff"; Yellow, ledrgb="ffff00"; White, ledrgb="ffffff"; Purple, ledrgb= "ff00ff"; 淡蓝，ledrgb= “ffff”;
ledmode	int	Light mode	0: The label indicator light is always on; 1: Label indicator light flashing; 2: Label indicates that the light flashes slowly; 3: Extinguish the lights; 4: Total annihilation;
cmdtoken	string	Outgoing in the corresponding feedback	Extended parameters can be passed away
reserve	string	obligate	obligate

Introduction to response response parameters:

parameter	function	description
bool	Invoke the interface response	false: The call failed; true: The call was successful;

Note: Display parameters can be modified

Multiple light labels are individually lit result feedback

Interface type: POST, parameter format: json object

Code form:

{

requestMethed:POST,

requestParameter:{

{

"mac":"99.99.08.51",

"result":true,

"power":100,

"lednum":1,

"cmdtoken":"55555",

"message": "Data succeeded"

}

},

response:{

}

}

Introduction to response parameters:

Parameter type: json

parameter	data type	function	description
mac	string	Label mac address	Indicates the mac address of the label where the light is located
power	int	Not processed	Not processed
result	bool	Illuminate the completion feedback result	false, failed to light up; true, light up successfully;
lednum	int	LED ID	LED 1, lednum=1LED 2, lednum=2LED 3, lednum=3LED 4, lednum=4
cmdtoken	string	Returns the cmdtoken passed in by the call request
message	string	Update the result information description	Data success;Data failure;Data transmission timeout;Wake-up failure;The base station is not online; Data anomalies;The data format is incorrect, and the parsing fails;The parameter format is incorrect or incomplete and cannot be executedThe label does not exist;

Roadway light control

Interface type: POST, parameter format: json array

http://localhost/wms/associate/ctrlShelfIndicator  

Code form:

{

url :http://localhost/wms/associate/ctrlShelfIndicator

requestMethed : POST,

requestParameter:{

[

{

"mac":"99.99.08.51",

"timeout":60,

"ledrgb":"ff00",

"ledmode":0,

"buzzer":1,

"reserve":"reserve"

},

{

"mac":"99.96.19.64",

"timeout":60,

"ledrgb":"ff00",

"ledmode":0,

"buzzer":1,

"reserve":"reserve"

}

]

response:{

true

}

}

(This link contains the special characters "[" "]") Request parameter description:

The local server uses localhost, and the non-local server changes localhost to the IP address of the host where the server is located

Description of request parameters: json array

The local server uses localhost, and the non-local server changes localhost to the IP address of the host where the server is located

parameter	data type	function	description
mac	string	Highlight the label ID	Label device ID number
timeout	int	The light timeout period	The label automatically extinguishes after the corresponding time and after several seconds
ledrgb	string	Light color	(Abnormal alarm) red: ff0000, (out of the warehouse) green: ff00; Yellow: ffff00,
ledmode	int	Light mode	0: Solid; 1: Flash mob; 2: Slow flash; 3 Turn off the lights
buzzer	int	Buzzer status	1: Ring, 2: Do not ring
reserve		obligate	obligate

Introduction to response parameters:

parameter	data type	function	description
bool	Illuminates the data sending instructions	Illuminates the data sending instructions	true: Sent successfully; false: Send failed;

Note: Display parameters can be modified

Roadway light result feedback

Interface type: POST, parameter format: json object

Code form:

{

requestMethed:POST,

requestParameter:{

{"mac":"99.99.08.51","result":true}

},

response:{

}

}

Introduction to response parameters:

Parameter type: json object

parameter	data type	function	description
mac	string	Highlight the LED ID	The LED is available with an ID number
result	bool	Feedback results	true, light up successfully; false, failed to light up;

Feedback callback address settings

The Admin user logs in to the wms system and enters the "System Management - > Third-Party Configuration Interface", which can configure the callback address of the feedback interface

Feedback type	description	address
Ink screen update result feedback	updateTagResult	Callback the full URL
Pick completion confirmation key feedback	enterKey	Callback the full URL
Tri-color shelf indicator result feedback/individual light result feedback	ctrlShelfIndicatorResult	Callback the full URL

Refresh the CK_Label_V16（7-color LED screen） interface

Introduction to the API：

Query all PTL tags information

Basic Information：

Attributes	Interface information
Status	Finished
URL	http://localhost/wms/associate/updateLedScreen
Request Method	POST
Content-Type	application/json

Request parameters：

Parameter Description：

Attributes	Types	Required	Comment
mac	string	yes	Tag mac / Tag ID
styleId	int	yes	Template ID
outtime	int	Yes	Lighting timeout time(s);0 : never turn offn : turn off autoAutomatically after n seconds
progressBar	string	optional	Filed created in template
text	string	optional	Filed created in template

Raw example：

[{"mac": "99.29.04.00","styleId": 45,Text: "Miao Miao","outtime": "0","progressBar":80}]

Response parameters：

Attributes	Value	Types	Comment
message	string	Update the result information description	Data success;Data failure;Data transmission timeout;Wake-up failure;The base station is not online; Data anomalies;The data format is incorrect, and the parsing fails;The parameter format is incorrect or incomplete and cannot be executedThe label does not exist;
result	boolean	result	True,False

Response example：

{"datalist": [{"mac": "99.29.04.00","reslut": false}],"resultCode": 10,"resultMsg": "success"}

Note: The fields parameters are according the according to the template you used. This API does not support lighting Leds of Multi-led PTL(External power supply version) , only refreshing the screen