Skip to main content

REST/HTTP and Websocket APIs

REST/HTTP (PORT 5807) API Summary:

Note: e.g. http://(limelight-ip-address):5807/results

MethodRouteDescription
GET/resultsRetrieve full JSON dump of current targeting results
GET/statusRetrieve JSON status object with temperature, fps, device name, pipeline index, cpu usage, ram usage
GET/capturesnapshotCapture a snapshot. Include a "snapname" string header to name the snapshot
POST/uploadsnapshotUpload a named snapshot. Include a "snapname" header. Include an image in the body of the request
GET/snapshotmanifestReturns a list of snapshot file names
GET/deletesnapshotsDeletes all snapshots
POST/uploadnnUpload a neural network. Include a "type" header set to "detector" or "classifier"
POST/uploadlabelsUpload a neural network labels file. Include a "type" header set to "detector" or "classifier"
GET/hwreportReturns a JSON array of full hardware reports. A hardware report contains human-readable info such as FOV, principal offset, etc.
GET/cal-defaultReturns default calibration result
GET/cal-fileReturns custom calibration result (file system)
GET/cal-eepromReturns custom calibration result (eeprom)
GET/cal-latestReturns latest custom calibration result. This result is not used unless it is saved to the file system or the eeprom
POST/cal-eepromUpdate the eeprom calibration result
POST/cal-fileUpdate the filesystem calibration result
DEL/cal-latestDelete latest calibration result
DEL/cal-eepromDelete eeprom calibration result
DEL/cal-fileDelete filesystem calibration result

Websocket Results Server:

EndpointDescription
ws://(IPADDRESS):5806Websocket server streaming full JSON dump of current targeting results at full framerate

JSON Dump Specification for more information.