Merge pull request #26 from JohemianKnapsody/timeout-capture-array

Optional wait parameter for capture_array()

Author: julianstirling

src/labthings_picamera2/thing.py

@@ -527,16 +527,21 @@ def snap_image(self) -> ArrayModel:
 
     @thing_action
     def capture_array(
-        self, stream_name: Literal["main", "lores", "raw"] = "main"
+        self,
+        stream_name: Literal["main", "lores", "raw"] = "main",
+        wait: Optional[float] = None,
     ) -> ArrayModel:
         """Acquire one image from the camera and return as an array
 
         This function will produce a nested list containing an uncompressed RGB image.
         It's likely to be highly inefficient - raw and/or uncompressed captures using
         binary image formats will be added in due course.
+
+        stream_name: (Optional) The PiCamera2 stream to use, should be one of ["main", "lores", "raw"]. Default = "main"
+        wait: (Optional, float) Set a timeout in seconds. A TimeoutError is raised if this time is exceeded during capture. Default = None
         """
         with self.picamera() as cam:
-            return cam.capture_array(stream_name)
+            return cam.capture_array(stream_name, wait = wait)
 
     @thing_action
     def capture_raw(