adding error code table to camera controller documentation

discosat · Mar 27, 2024 · 959c252 · 959c252
1 parent cd8008c
commit 959c252
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/doc/disco-2/software/camera-controller.md b/doc/disco-2/software/camera-controller.md
@@ -58,4 +58,21 @@ The possible values that can be set are the following.
 | INTERVAL    | int         | 0              | Delay between images in microseconds (not including exposure) | False           | 0                                      |
 
 ## Building
-The Camera controller is built with the Meson build system. A build script is included in the [github repository](https://github.com/ivaroli/DiscoCameraController). Simply call `./configure.sh` and the controller will be built.
+The Camera controller is built with the Meson build system. A build script is included in the [github repository](https://github.com/ivaroli/DiscoCameraController). Simply call `./configure.sh` and the controller will be built.
+
+## Error log
+The camera controller provides an integer parameter via the CSP parameter named error_log, denoting the latest cause of failure encountered during image capture. Refer to the table below for the list of potential error codes along with their respective explanations.
+
+| Error Code | Description                                               |
+|------------|-----------------------------------------------------------|
+| 0          | Success                                                   |
+| 100        | General error in parsing of capture instructions          |
+| 101        | Invalid camera type or camera type implementation missing |
+| 102        | CAMERA_ID is missing from capture instructions            |
+| 103        | NUM_IMAGES to capture is 0                                |
+| 200        | General error during image capture                        |
+| 201        | No cameras connected or found                             |
+| 202        | Camera with id CAMERA_ID not found                        |
+| 300        | General error in message queue                            |
+| 301        | Unable to create shared memory space                      |
+| 302        | Unable to insert data into memory space                   |