Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

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

Method

PUT

Description

Sets the cabinet is demo mode: turning light on or off. When in demo, it lights a random light on the front and when that is pushed, its back counterpart goes on. After that, another random front light goes on.

Request

Code Block
languagejson
{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

Code Block
languagejson
{
  "message": «human readable error»
}

Status

Status
colourYellow
titlepending

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

Code Block
languagejson
{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

Code Block
languagejson
{
  "message": «human readable error»
}

Status

Status
colourGreen
titleimplemented

URL

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

Method

PUT

Description

Sets the cabinet in or out of teach mode.

Request

Code Block
languagejson
{ 
  "mode": "on" | "off"
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

Code Block
languagejson
{
  "message": «human readable error»
}

Status

Status
colourYellowRed
titlependingnot in prototype

URL

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

Method

GET

Description

Get current state of teach mode

Responses

HTTP204 when not in teach mode

HTTP200 when in teach mode, with following body:

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

Status

Status
colourYellowRed
titlependingnot in prototype

Section

Plank and section numbering is 1-based. So if 4 planks are available, they are numbered 1 to 4.

URL

http://<<ip address>>/rest/plank/«plankno»/section/«sectionno»[/side/«side»]

Method

GET

Description

Receives information of section.

plankno and sectionno are numbers

side can be front or back and is optional; when not supplied, this defaults to front.

Response

Code Block
languagejson
{
  "value": «lastdisplayedvalue»,
  "state": «state»
}

Possible Error

HTTP404 with no body when section does not exist.

Status

StatuscolourGreentitle

implemented

URL

http://<<ip address>>/rest/plank/«plankno»/section/«sectionno»[/side/«side»]

Method

PUT

Description

Sets value on display.

plankno and sectionno are numbers

side can be front or back and is optional; when not supplied, this defaults to front.

Request

Code Block
languagejson
{
  "value": «valuetodisplay»
}

Response

HTTP204 when successful

Possible Errors

HTTP400 when request was invalid

Code Block
languagejson
{
  "message": «human readable error»
}

HTTP404 with no body when section does not exist

Status

StatuscolourGreentitleimplemented