Download OpenAPI specification:Download
Controlling the blinKNlights backend
A previously claimed slot can be emptied or purged (a purged slot can be claimed again)
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| purge | string Example: "yes" If set to "yes", the slot is purged, not emptied |
successful operation returns "OK"
If the slot is free, claim it. The method then returns a token string
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| type | string Type of the slot, "static" or "interaction" |
successful operation
Return the contents of the time slot (optionally including the actual data)
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| data | string If "yes" also return the actual data of static slots |
successful operation
Approve a time slot, this is only required for custom time slots
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| approve | boolean |
successful operation
Add an animation to the slot
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| limit | number <integer> Time limit for animated gifs in seconds |
| name | string Name of the gif, blm or bml animation |
successful operation returns "OK"
Add a single frame with an optional delay to the slot. This implies a custom time slot which needs to be approved.
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| delay | number <integer> Delay in ms, defaults to 0 |
Succeccful operation
Add a video sequence to the slot. This implies a custom time slot which needs to be approved.
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| limit | number <integer> Time limit for animated gifs in seconds |
Successful operation
Add a text sequence to the slot. This implies a custom time slot which needs to be approved.
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| content | Array of string Array of text lines |
| lines | number <integer> Number of lines visible |
| scrolling | number <integer> 0 means no scrolling (all text on one frame), 1 means left-to-right |
| delay | number <integer> Delay between frames in ms |
| font | string Font face name, some fonts that are available: hellovetica, cubicfive{10,11,12,18}, Liberation{Mono,Sans,SansNarrow,Serif}-{Regular,Bold,BoldItalic,Italic}, pixelsix00, squaredance{00,01,03,10} |
| color | Array of number <integer> r,g,b byte values (0-255) for the text color |
| background | Array of number <integer> r,g,b byte values (0-255) for the background |
Successful operation
Add a text sequence to the slot which show tweets for the set search terms (at the time of submitting). This implies a custom time slot which needs to be approved.
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| hashtags | Array of string Array of search terms |
| delay | number <integer> Delay between frames in ms |
| font | string Font face name, some fonts that are available: hellovetica, cubicfive{10,11,12,18}, Liberation{Mono,Sans,SansNarrow,Serif}-{Regular,Bold,BoldItalic,Italic}, pixelsix00, squaredance{00,01,03,10} |
| color | Array of number <integer> r,g,b byte values (0-255) for the text color |
| background | Array of number <integer> r,g,b byte values (0-255) for the background |
| language | string Preferred language, only de or en. |
Successful operation
Define the type of the interaction by name. Currently, the following interactions are supported: "pong", "tetris", "pacman", "spectrum", and, requiring godmode, "doodle" and "tweet"
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
| name | string Name of the interaction to be used |
successful operation returns a player token
This request will be upgraded to a websocket connection
| interactionName required | string The name of the interaction |
| start required | string <date-time> (SlotStart) Timeslot start. Will be truncated to the time slot interval. |
Connection is upgraded to a websocket connection