Cabinet

http://<<ip address>>/rest/cabinet

GET

Receives information on the cabinet.

{
  "planks": «numberofplanks», 
  "sections": «numberofsections»,
  "name": «nameofcabinet»,
  "status": [«listofhumanreadablestatusmessages»],
  "demo": "barcode|off",
  "mode": "section|tag",
  "sides": "frontonly|frontandback"
}

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.

IMPLEMENTED

http://<<ip address>>/rest/cabinet

PUT

Stores information on the cabinet.

mode can be tag or section:

• section mode will use planks, sections and sides to to control the lights. The websocket will return a plank-section-side combo when button pushed.

• tag mode will use direct tags and controller numbers. The websocket will return a controller-tag combo when button pushed.

When the section call is done, and the cabinet is in mode tag (or the other way round), this will result in a HTTP409 Conflict.

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.

HTTP204 when successful

HTTP400 when request was invalid

{
  "message": «human readable error»
}

IMPLEMENTED

http://<<ip address>>/rest/cabinet/lighttest

PUT

Sets the cabinet is lighttest mode: turning light on or off. The light test shows the tag’s address.

HTTP204 when successful

HTTP400 when request was invalid

{
  "message": «human readable error»
}

IMPLEMENTED

http://<<ip address>>/rest/cabinet/teach

PUT

Sets the cabinet in or out of teach mode.

HTTP204 when successful

HTTP400 when request was invalid

{
  "message": «human readable error»
}

NOT IN PROTOTYPE

http://<<ip address>>/rest/cabinet/teach

GET

Get current state of teach mode

HTTP204 when not in teach mode

HTTP200 when in teach mode, with following body:

{
  "tag": [«list of tags found»]
}

NOT IN PROTOTYPE