Skip to content

Commit 29ac1cf

Browse files
Default timeout 0.9 seconds, optional type
1 parent 9cd36a5 commit 29ac1cf

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/labthings_picamera2/thing.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ def snap_image(self) -> ArrayModel:
528528
def capture_array(
529529
self,
530530
stream_name: Literal["main", "lores", "raw"] = "main",
531-
wait: float = None,
531+
wait: Optional[float] = 0.9,
532532
) -> ArrayModel:
533533
"""Acquire one image from the camera and return as an array
534534
@@ -537,7 +537,9 @@ def capture_array(
537537
binary image formats will be added in due course.
538538
539539
stream_name: (Optional) The PiCamera2 stream to use, should be one of ["main", "lores", "raw"]. Default = "main"
540-
wait: (Optional, float) Set a timeout in seconds. A TimeoutError is raised if this time is exceeded during capture. Default = None
540+
wait: (Optional, float) Set a timeout in seconds.
541+
A TimeoutError is raised if this time is exceeded during capture.
542+
Default = 0.9s, lower than the 1s timeout default in picamera yaml settings
541543
"""
542544
with self.picamera() as cam:
543545
return cam.capture_array(stream_name, wait = wait)
@@ -548,15 +550,17 @@ def capture_raw(
548550
states_getter: GetThingStates,
549551
get_states: bool=True,
550552
get_processing_inputs: bool=True,
551-
wait: float=None,
553+
wait: Optional[float] = 0.9,
552554
) -> RawImageModel:
553555
"""Capture a raw image
554556
555557
This function is intended to be as fast as possible, and will return
556558
as soon as an image has been captured. The output format is not intended
557559
to be useful, except as input to `raw_to_png`.
558560
559-
wait: (Optional, float) Set a timeout in seconds. A TimeoutError is raised if this time is exceeded during capture. Default = None
561+
wait: (Optional, float) Set a timeout in seconds.
562+
A TimeoutError is raised if this time is exceeded during capture.
563+
Default = 0.9s, lower than the 1s timeout default in picamera yaml settings
560564
561565
When used via the HTTP interface, this function returns the data as a
562566
`Blob` object, meaning it can be passed to another action without
@@ -705,7 +709,7 @@ def capture_jpeg(
705709
self,
706710
metadata_getter: GetThingStates,
707711
resolution: Literal["lores", "main", "full"] = "main",
708-
wait: float = None,
712+
wait: Optional[float] = 0.9,
709713
) -> JPEGBlob:
710714
"""Acquire one image from the camera as a JPEG
711715
@@ -720,7 +724,8 @@ def capture_jpeg(
720724
resolution image.
721725
722726
wait: (Optional, float) Set a timeout in seconds.
723-
A TimeoutError is raised if this time is exceeded during capture. Default = None
727+
A TimeoutError is raised if this time is exceeded during capture.
728+
Default = 0.9s, lower than the 1s timeout default in picamera yaml settings
724729
725730
Note that this always uses the image processing pipeline - to
726731
bypass this, you must use a raw capture.

0 commit comments

Comments
 (0)