Skip to content

Optional wait parameter for capture_array() #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Optional wait parameter for capture_array() #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fba444e
Optional wait parameter which can timeout picamera
JohemianKnapsody Mar 11, 2025
e7d5e69
Docstring for capture_array()
JohemianKnapsody Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/labthings_picamera2/thing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down