Skip to content

Commands Basic

captncode edited this page Jan 6, 2021 · 3 revisions

The following commands have no parameters. They each perform a basic function and are executed using an HTTP Get.

Get Screen

URL: /api/IoTDisplay
Returns the current screen as a png image.
HTTP Responses: OK (200), BadRequest (400) or InternalServerError (500)

LastUpdated

/api/IoTDisplay/LastUpdated
Returns the last date and time the screen was updated in "yyyy-MM-ddTHH:mm:ss.FFFFFFFZ" (GMT) format.
HTTP Responses: OK (200), BadRequest (400) or InternalServerError (500)

Refresh

/api/IoTDisplay/Refresh
Refreshes the screen by clearing the canvas and reloading from the state files.
HTTP Responses: Accepted (202), BadRequest (400) or InternalServerError (500)

Clear

/api/IoTDisplay/Clear
Clears the screen of everything but clocks. Screen state files are also deleted.
HTTP Responses: Accepted (202), BadRequest (400) or InternalServerError (500)

ClockClear

/api/IoTDisplay/ClockClear
Clears the screen of all clocks. Clock state files are also deleted.
HTTP Responses: Accepted (202), BadRequest (400) or InternalServerError (500)