Cabinet
...
URL
...
http://<<ip address>>/rest/cabinet
...
Method
...
GET
...
Description
...
Receives information on the cabinet.
...
Response
...
| Code Block | ||
|---|---|---|
| ||
{
"planks": «numberofplanks»,
"sections": «numberofsections»
} |
...
Status
...
| Status | ||||
|---|---|---|---|---|
|
...
URL
The API enables any programmer to directly control the PTL Control using a REST interface and a websocket.
The base address for the REST interface is http://<<ip address>>:5000/rest
...
Method
...
PUT
...
Description
...
Stores information on the cabinet.
...
Request
...
| Code Block | ||
|---|---|---|
| ||
{
"planks": «numberofplanks»,
"sections": «numberofsections»
} |
...
Response
...
HTTP204 when successful
...
Possible Errors
...
HTTP400 when request was invalid
| Code Block | ||
|---|---|---|
| ||
{
"message": «human readable error»
} |
...
Status
...
| Status | ||||
|---|---|---|---|---|
|
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»
...
Method
...
GET
...
Description
...
Receives information of section.
...
Response
...
| Code Block | ||
|---|---|---|
| ||
{
"value": «lastdisplayedvalue»,
"state": «state»
} |
...
Possible Error
...
HTTP404 with no body when section does not exist.
...
Status
...
| Status | ||||
|---|---|---|---|---|
|
...
URL
...
http://<<ip address>>/rest/plank/«plankno»/section/«sectionno»
...
Method
...
PUT
...
Description
...
Sets value on display.
...
Request
...
| Code Block | ||
|---|---|---|
| ||
{
"value": «valuetodisplay»
} |
...
Response
...
HTTP204 when successful
...
Possible Errors
HTTP400 when request was invalid
| Code Block | ||
|---|---|---|
| ||
{
"message": «human readable error»
} |
...
.
The address for the websocket is ws://<<ip address>>:5000/ws.
The API has the following actions available:
| Child pages (Children Display) |
|---|