Cabinet

URL	`http://<<ip address>>/rest/cabinet`
Method	GET
Description	Receives information on the cabinet.
Response	`{ "planks": «numberofplanks», "sections": «numberofsections», "name": «nameofcabinet», "status": [«listofhumanreadablestatusmessages»], "demo": "random-pick\|barcode\|off", "sides": "frontonly\|frontandback", "orders": «number of open orders», "tagmode": "pick\|zeropick\|confirm\|info\|locked" }` Status message can be: `Missing tag at plank P, section S (Tag ID N)` `No connection to controller` When list of messages is empty (`[]`), cabinet is “OK”. De `demo` mode tells in which (stateful) demo mode the cabinet is, of `off` when not in demo mode. Use the calls in Demo to manipulate these modes.
Remarks	v2.0: `mode` was removed v2.1: `orders` and `tagmode` added

URL	`http://<<ip address>>/rest/cabinet`
Method	PUT
Description	Stores information on the cabinet. `sides` can be `frontonly` or `frontandback`: `frontonly` is used when only the front controller is physically available. This suppresses any missing tags on the back, a missing connection of the back controller and will generate a HTTP404 when trying to write to a back tag, or to controller 2 when in `tag` mode. `frontandback` should be used if two controllers are connected, which is only valid for the PTLCabinet. `name` is the name of the cabinet, this will be shown on the screen, scaled to fit, when the PTLControl is idle. When `name` is an HTML snippet surrounded by `<div>`the HTML will be rendered where the name is, centered on screen. The client is responsible for styling, scaling and layout.
Request	`{ "planks": «numberofplanks», "sections": «numberofsections», "name": «nameofcabinet», "sides": "frontonly\|frontandback", "demo": "random-pick\|barcode\|off", "tagmode": "pick\|zeropick\|confirm\|info\|locked" }` `tagmode`s: `pick`: (default) Tag can be used for picking, confirm button will send a WebSocket confirm message and amount can be adjusted down. `zeropick`: Tag can be used for picking, confirm button will send a WebSocket confirm message. Button down will send a confirm message with amount 0. `confirm`: Tag can be used for picking, confirm button will send aWebSocket confirm message. No adjustments can be made. `info`: Tag is used for info. Buttons will send WebSocket messages, but tag will not turn off when confirm is pushed. `locked`: Tag is read-only. Buttons have no effect, no messages are sent.
Response	HTTP204 when successful
Possible Errors	HTTP400 when request was invalid `{ "message": «human readable error» }`
Remarks	v2.0 `mode`was removed v2.1 HTML support for `name` added `tagmode` added

URL	`http://<<ip address>>/rest/cabinet/lighttest`
Method	PUT
Description	Sets the cabinet is lighttest mode: turning light on or off. The light test shows the tag’s address.
Request
Response	HTTP204 when successful
Possible Errors	HTTP400 when request was invalid

TBWB Smart Products Public

Cabinet

Analytics

Related content