Skip to content

Display GET

The Man edited this page Dec 31, 2021 · 6 revisions

Get Display

Gets information about the current displayController status

URL : /api/display/
Method : GET
Auth required : NO

Success Response

Code : 200 OK

Content example

{
  "indicators": {
    "1": true,
    "2": true
  },
  "tubes": {
    "1": {
      "val": 1,
      "pwm": 255
    },
    "2": {
      "val": 1,
      "pwm": 255
    },
    "3": {
      "val": 5,
      "pwm": 255
    },
    "4": {
      "val": 5,
      "pwm": 255
    }
  },
  "onboardLed": {
    "pwm": 255,
    "mode": 0,
    "blinkAmount": 0
  },
  "leds": 255,
  "authRequired": true
}

Notes

authRequired is initially set to false and indicates if POSTing to this endpoint requires the auth parameter.

Clone this wiki locally