This library enables access to any camera sensor supported by the library, including OV5640 and OV2640.
Available on these boards
- class espcamera.GrabMode¶
Controls when a new frame is grabbed.
- WHEN_EMPTY: GrabMode¶
Fills buffers when they are empty. Less resources but first
fb_countframes might be old
- class espcamera.PixelFormat¶
Format of data in the captured frames
- class espcamera.FrameSize¶
The pixel size of the captured frames
- class espcamera.GainCeiling¶
The maximum amount of gain applied to raw sensor data.
Higher values are useful in darker conditions, but increase image noise.
- class espcamera.Camera(*, data_pins: List[microcontroller.Pin], pixel_clock_pin: microcontroller.Pin, vsync_pin: microcontroller.Pin, href_pin: microcontroller.Pin, i2c: busio.I2C, external_clock_pin: microcontroller.Pin | None = None, external_clock_frequency: int = 20000000, powerdown_pin: microcontroller.Pin | None = None, reset_pin: microcontroller.Pin | None = None, pixel_format: PixelFormat = PixelFormat.RGB565, frame_size: FrameSize = FrameSize.QQVGA, jpeg_quality: int = 15, framebuffer_count: int = 1, grab_mode: GrabMode = GrabMode.WHEN_EMPTY)¶
Configure and initialize a camera with the given properties
This driver requires that the
settings.tomlbe large enough to hold the camera framebuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError or an IDFError, this probably indicates the setting is too small and should be increased.
Not all supported sensors have all of the properties listed below. For instance, the OV5640 supports
denoise, but the OV2640 does not. The underlying esp32-camera library does not provide a reliable API to check which settings are supported. CircuitPython makes a best effort to determine when an unsupported property is set and will raise an exception in that case.
data_pins – The 8 data data_pins used for image data transfer from the camera module, least significant bit first
pixel_clock_pin – The pixel clock output from the camera module
vsync_pin – The vertical sync pulse output from the camera module
href_pin – The horizontal reference output from the camera module
i2c – The I2C bus connected to the camera module
external_clock_pin – The pin on which to generate the external clock
external_clock_frequency – The frequency generated on the external clock pin
powerdown_pin – The powerdown input to the camera module
reset_pin – The reset input to the camera module
pixel_format – The pixel format of the captured image
frame_size – The size of captured image
jpeg_quality – For
PixelFormat.JPEG, the quality. Higher numbers increase quality. If the quality is too high, the JPEG data will be larger than the available buffer size and the image will be unusable or truncated. The exact range of appropriate values depends on the sensor and must be determined empirically.
framebuffer_count – The number of framebuffers (1 for single-buffered and 2 for double-buffered)
grab_mode – When to grab a new frame
- contrast: int¶
The sensor contrast. Positive values increase contrast, negative values lower it. The total range is device-specific but is often from -2 to +2 inclusive.
- brightness: int¶
The sensor brightness. Positive values increase brightness, negative values lower it. The total range is device-specific but is often from -2 to +2 inclusive.
- saturation: int¶
The sensor saturation. Positive values increase saturation (more vibrant colors), negative values lower it (more muted colors). The total range is device-specific but the value is often from -2 to +2 inclusive.
- sharpness: int¶
The sensor sharpness. Positive values increase sharpness (more defined edges), negative values lower it (softer edges). The total range is device-specific but the value is often from -2 to +2 inclusive.
- denoise: int¶
The sensor ‘denoise’ setting. Any camera sensor has inherent ‘noise’, especially in low brightness environments. Software algorithms can decrease noise at the expense of fine detail. A larger value increases the amount of software noise removal. The total range is device-specific but the value is often from 0 to 10.
- gain_ceiling: GainCeiling¶
The sensor ‘gain ceiling’ setting. “Gain” is an analog multiplier applied to the raw sensor data. The ‘ceiling’ is the maximum gain value that the sensor will use. A higher gain means that the sensor has a greater response to light, but also makes sensor noise more visible.
- quality: int¶
The ‘quality’ setting when capturing JPEG images. This is similar to the quality setting when exporting a jpeg image from photo editing software. Typical values range from 5 to 40, with higher numbers leading to larger image sizes and better overall image quality. However, when the quality is set to a high number, the total size of the JPEG data can exceed the size of an internal buffer, causing image capture to fail.
- whitebal: bool¶
- gain_ctrl: bool¶
- exposure_ctrl: bool¶
- aec2: bool¶
Truethe sensor’s “night mode” is enabled, extending the range of automatic gain control.
- agc_gain: int¶
Access the gain level of the sensor. Higher values produce brighter images. Typical settings range from 0 to 30.
- aec_value: int¶
Access the exposure value of the camera. Higher values produce brighter images. Typical settings range from 0 to 1200.
- special_effect: int¶
Enable a “special effect”. Zero is no special effect. On OV5640, special effects range from 0 to 6 inclusive and select various color modes.
- wb_mode: int¶
The white balance mode. 0 is automatic white balance. Typical values range from 0 to 4 inclusive.
- bpc: bool¶
True, “black point compensation” is enabled. This can make black parts of the image darker.
- wpc: bool¶
True, “white point compensation” is enabled. This can make white parts of the image whiter.
- lenc: bool¶
Enable “lens correction”. This can help compensate for light fall-off at the edge of the sensor area.
- __exit__() None ¶
Automatically deinitializes the hardware when exiting a context. See Lifetime and ContextManagers for more info.
- take(timeout: float | None = 0.25) displayio.Bitmap | circuitpython_typing.ReadableBuffer | None ¶
Record a frame. Wait up to ‘timeout’ seconds for a frame to be captured.
- reconfigure(frame_size: FrameSize | None = None, pixel_format: PixelFormat | None = None, grab_mode: GrabMode | None = None, framebuffer_count: int | None = None) None ¶
Change multiple related camera settings simultaneously
Because these settings interact in complex ways, and take longer than the other properties to set, they are set together in a single function call.
If an argument is unspecified or None, then the setting is unchanged.