The camera can be commanded to take a capture by either a GET or POST request to this URL. Both actions have the same effect. The command can take several arguments, provided as parameters in the URL or as a JSON body.

When using the preview option, the a new JPEG preview image will be generated based on the preview_band option in the configuration settings. This preview is the image displayed on the web server user interface.

The cache_jpg and cache_raw parameters allow the user to create and cache images in camera RAM, for temporary access without impacting SD card data throughput. The images saved to the SD card for any given capture are still controlled by the main configuration settings. This allows, for example, a user to cache jpegs from two bands to be retrieved quickly during flight, while still saving RAW images to the SD card for later retrieval. Note that cached image files are only available temporarily. Cached files are kept only for the last two capture commands which had non-zero cache_raw or cache_jpeg arguments, so it is important if you are downloading these cached files that you finish downloading the file before issuing more than one subsequent capture command (only captures with caching enabled count here).

This route can be called to poll the status of a previously commanded capture. Only those paths that are valid for the capture will be shown. For example, if no cached files were requested for this capture, then the jpeg_cache_path and raw_cache_path fields will not be present.

/captures.kmz will return a kmz file with the contents of all captures currently on the SD card. This is especially useful when flying multiple flights across one or more areas to ensure continuous coverage across those areas.

Note: The KML file provided by the /captures.kml route is still accessable by downloading the KMZ, and extracting the kml file from it.

The camera exposure object controls the camera's exposure mode, and sets manual exposure values. Manual exposure values are only used when the enable_man_exposure field in the config object is set to true. The exposure settings are not persistent and the camera will revert to the default behavior of automatic exposure control when it is powered off.

Note: Automatic exposure mode is recommended during normal operation. The camera has automatic gain and exposure control (AGC) rules which are designed for aerial data collection. The AGC rules will prevent blurring in most cases by first increasing imager gain, and will prevent over-exposure of bright subjects.

The exposure properties are expressed in miliseconds. The gain properties must be integers with a value of 1, 2, 4 or 8.

This route reports the current state of the panel detection algorithm. You can also send it an abort command, in which case any currently running panel detection will complete its capture regardless of whether a panel was successfully found

This command can be used to retrieve the active location, velocity, and time, or to provide these values to the camera.

This command can be used in lieu of an external GPS attached to the camera to provide the camera with a position (for example, from the aircraft GPS). Anytime this value has been written in the last 5 seconds, it will take priority over a camera attached GPS and will be used instead of the attached GPS when writing image metadata.

See /capture_state for an additional option for injecting image metadata.

This command retrieves or sets the current camera orientation.

This command can be used to provide the orientation of the camera measured by an external source by POST'ing the orientation angles. Anytime this value has been written in the preceding 5 seconds, it will be considered valid and will be written to image metadata.

Two rotations can be specified: An aircraft orientation and a camera orientation. The aircraft orientation gives the orientation of the aircraft relative to the earth frame, and the camera orientation gives the orientation of the fixed or gimbaled camera relative to the aircraft. If desired, the aircraft orientation can be set to zero, and in the case the camera orientation becomes relative to the earth. Alternatively, if the camera is fixed mounted, the camera orientation can be set to the appropriate static value and only the aircraft orientation is updated.

The aircraft orientation is specified in the standard aeronautical coordinate frame, where the Z-axis points down, the Y-axis points to the right, and X-axis points to the front of the vehicle. The default orientation, when the vehicle angles are all zero, is defined such that the Z-axis points directly towards the center of the earth, and the X-axis points towards true north. Rotations about the Z, Y, and X axes correspond to the angles psi, theta, and phi, respectively. For the vehicle, this means that psi corresponds to yaw, theta corresponds to pitch, and phi corresponds to roll. Rotation order is about the Z, Y, then X axis, or yaw, then pitch, then roll.

The camera orientation represents the orientation of the camera relative to the aircraft. The axes used are referenced to the camera, not the vehicle. The camera’s Z-axis points towards the bottom of the camera, the Y-axis points to the right of the camera, and the X-axis points in the direction the camera is facing, along the camera focal axis. The default orientation, when the camera angles are all zero, is defined such that the camera’s Z-axis is aligned with the aircraft’s negative X-axis, the camera’s Y-axis is aligned with the aircraft’s Y-axis, and the camera’s X-axis is aligned with the aircraft’s Z-axis. This corresponds to the camera looking at nadir, with the top of the camera pointing towards the front of the vehicle. Rotations about the Z, Y, and X axes of the camera correspond to the angles psi, theta, and phi, respectively. For the camera, this means that psi corresponds to pan, theta corresponds to tilt, and phi corresponds to roll. The rotation order is about the Z, Y, then X axis, or pan, then tilt, then roll.

For a fixed camera pointed straight down relative to the aircraft, and with the top of the camera toward the front of the aircraft, the value of 0 can be used for all angles.

If the 'use_post_capture_state' argument is set to 'true' when a /capture command is made, then sending POST data to this route within 1 second of the top of frame will result in the provided data being written to the image metadata, instead of any other potential sources of these data, such as a directly connected GPS.

Data provided to this route is accepted in logical groups, where all parameters in the group must be present, or else all parameters in that group will be ignored, and any valid value the camera has from other sources will be used instead. For instance, providing a latitude and logitude, but no altitude will result in all of those parameters being collectively ignored, and the image will instead get a latitude, longitude, and altitude from an alternate data source.

The groups are as follows:

• aircraft_attitude: aircraft_phi, aircraft_theta, aircraft_psi
• camera_attitude: camera_phi, camera_theta, camera_psi
• gps: latitude, longitude, altitude
• accuracy: p_acc, v_acc
• utc_time: utc_time

The response to a successful POST is a list of these groups, and whether they were 'set' or 'ignored' by the POST

If a POST is sent outside of the window for acceptance, or two POSTs are sent for a single capture, a 409 status is returned, indicating a conflict between the POST supplied data and what was actually written to the file metadata, along with an error string indicating why the data were rejected.

The config object contains camera configuration options. These options are persistent between camera power cycles, except where exceptions are noted.

Update (POST) requests may provide any subset of the config properties as parameters and only those properties that are provided will be modified.

This read-only object returns information regarding configurable pins and their available functions.

See pin_modes in the /config route for details on how to use these values

This read-only object returns the current camera status information.

The network status API provides information about the MicaSense network, including all RedEdge cameras and DLS's. The devices are presented as an array called "network_map".

This read-only object contains information about what time source the camera is using, and provides an estimated delay value between the various time sources and the time used by the camera.

This read-only object contains the software version and the device serial number.

The file access API provides a method to get the contents of the SD card currently inserted in the camera. GET can return one of three alternatives:

1. If the provided path describes a regular file, the file is returned.
2. If the provided path describes a directory, a json object is returned that provides a directory listing as an array of descriptors for sub-directories and files at that path.
3. If the provided path does not exist, a 404 with JSON error message is returned

The delete file API provides a method to delete files on the SD card currently inserted in the camera. GET can return one of three alternatives:

1. If the provided path describes a regular file, the file is deleted
2. If the provided path describes a directory that is empty, the directory is deleted
3. If the provided path does not exist, or the path is a directory that is not empty, a 503 code is returned with a JSON message stating the error

NOTE: Disabling wifi from the wifi interface may not return a response. WiFi will be re-enabled when the camera is power-cycled

This route allows you to completely erase everything on the SD card at once. All images will be deleted, along with any other files you may have on your SD card at the time of the command.

You cannot undo the card wipe performed by this command.

This endpoint provides information physical information about the camera, including nominal lens parameters and information about the nominal filters installed for each band.

Used to retrieve the lens distortion calibration parameters for all five cameras. See the "RedEdge File Format ICD" document for more information regarding the lens calibration parameters.

Used to retrieve the lens vignette calibration parameters. One set of parameters is returned for each of the five cameras.

Used to retrieve the relative rotations between lenses. Calibration is returned as an array for each band, where the first element of the array is the X-rotation, the second is the Y-rotation, and the third is the Z-rotation, all in radians. Rotations should be applied to the image first as Z, then Y, then X. In matrix form, it should look like v_cal = Rx*Ry*Rz*v . When you rotate all images from a capture by their respective rotation values, they should all align, assuming the target is effectively at infinity. See our Image Processing Tutorial for more details on using these values.

This route reports the readiness of the camera for power down. It can also be used to request the camera to prepare for power down.

NOTE: This route will not actually power down the camera. It places the camera in a "safe" state for power down, meaning that the storage media is unmounted after ensuring that any pending data has been written out. This prevents the possiblility of the storage media becoming corrupted. This is an alternative to holding the button of the camera down for five seconds.

This route returns information regarding temperature change in Kelvin and number of seconds since the last non-uniform calibration (NUC) of the thermal imager.

NOTE: This route only works with cameras that have a thermal imager, such as the Altum.

If the property "nuc_now" is present in the POST request and set to true then this route commands the camera to NUC the thermal imager. If a NUC is commanded then auto-NUCing will be disabled. Auto-NUCing cannot be re-enabled unless the camera is rebooted, so regular commands must be sent to this route in order to maintain high quality thermal data. We have found that NUCing once every five minutes or a change of 2 Kelvin maintains good thermal image quality.

/captures.kml will return a kmz file with the contents of all captures currently on the SD card. This is especially useful when flying multiple flights across one or more areas to ensure continuous coverage across those areas.