Skip to content
firepick1 (localhost) edited this page Jan 31, 2016 · 3 revisions

HTTP REST firesight image processing service

The /firesight REST service processes saved/current images by location. It uses the /image and /firestep REST services.

Supported Protocols

➡️ GET /firesight/default/image.jpg
➡️ GET /firesight/raspistill/image.jpg
➡️ GET /firesight/video0/image.jpg
➡️ GET /firesight/video1/image.jpg

Return most recently processed image output for designated camera at current location.

➡️ GET /images/default/X1.001Y-2.002Z3.003.jpg
➡️ GET /images/raspistill/X1.001Y-2.002Z3.003.jpg
➡️ GET /images/video0/X1.001Y-2.002Z3.003.jpg
➡️ GET /images/video1/X1.001Y-2.002Z3.003.jpg

Return most recent processed image of designated camera at designated location (1.001,-2.002,3.003).

➡️ GET /firesight/default/calc-offset
➡️ GET /firesight/raspistill/calc-offset
➡️ GET /firesight/video0/calc-offset
➡️ GET /firesight/video1/calc-offset

Capture and compare current designated camera image with the saved image for the current location. Return JSON object that defines the offset between two images.

Reserved Protocols

The following URLs are reserved for future use as REST protocols

  • (tbd)

Error handling

Image processing is not guaranteed to succeed. For example, comparing the offset between the image of a squirrel and the image of the sun will almost surely fail. These are expected errors. Expected errors are handled with HTTP200 and null values for result fields having no data.

Unexpected errors are handled by non HTTP200 status returns:

  • HTTP501 if resources are not implemented or unavailable (e.g.. FireSight is missing)
  • HTTP500 if an unexpected server error occurred

See Also