Display GET

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,
  "status": [
    "authRequired"
  ]
}

Notes

(v1.2+) status can have the following values:

• authRequired
  • When POSTing to this endpoint, authentication is required.
• isClock
  • The display is currently acting as a clock.
    The endpoint still accepts POST requests, but will not apply any changes made to tube and indicators.

Addendum

Starting with version 1.1, this endpoint now also allows to only access specific data:

• /api/display/tubes
  • Only return the tubes property.
• /api/display/indicators
  • Only return the indicators property.
• /api/display/leds
  • Only return the LED properties (leds, onboardLed).

Starting with version 1.2, the authRequired property has been replaced by the status array. Old behavior: If set to true, the auth URI parameter must be set.