logo
OpenMVSingTown AI
MicroPython Libraries

camera sensor

sensor — camera sensor

The sensor module is used for taking pictures.

Example usage:

import sensor

# Setup camera.
sensor.reset()
sensor.set_pixformat(sensor.RGB565)
sensor.set_framesize(sensor.QVGA)
sensor.skip_frames()

# Take pictures.
while(True):
    sensor.snapshot()

Functions

sensor.reset

sensor.reset() -> None

Initializes the camera sensor.

sensor.sleep

sensor.sleep(enable: bool) -> None

Puts the camera to sleep if enable is True. Otherwise, wakes it back up.

sensor.shutdown

sensor.shutdown(enable: bool) -> None

Puts the camera into a lower power mode than sleep (but the camera must be reset on being woken up).

sensor.flush

sensor.flush() -> None

Copies whatever was in the frame buffer to the IDE. You should call this method to display the last image your OpenMV Cam takes if it’s not running a script with an infinite loop. Note that you’ll need to add a delay time of about a second after your script finishes for the IDE to grab the image from your camera. Otherwise, this method will have no effect.

sensor.snapshot

sensor.snapshot() -> image.Image

Takes a picture using the camera and returns an image object.

The OpenMV Cam has two memory areas for images. The classical stack/heap area used for normal MicroPython processing can store small images within it’s heap. However, the MicroPython heap is only about ~100 KB which is not enough to store larger images. So, your OpenMV Cam has a secondary frame buffer memory area that stores images taken by sensor.snapshot(). Images are stored on the bottom of this memory area. Any memory that’s left over is then available for use by the frame buffer stack which your OpenMV Cam’s firmware uses to hold large temporary data structures for image processing algorithms.

If you need room to hold multiple frames you may “steal” frame buffer space by calling sensor.alloc_extra_fb().

If sensor.set_auto_rotation() is enabled this method will return a new already rotated image object.

Note

sensor.snapshot() may apply cropping parameters to fit the snapshot in the available RAM the pixformat, framesize, windowing, and framebuffers. The cropping parameters will be applied to maintain the aspect ratio and will stay until sensor.set_framesize() or sensor.set_windowing() are called.

sensor.skip_frames

sensor.skip_frames(n: int | None = None, time: int | None = None) -> None

Takes n number of snapshots to let the camera image stabilize after changing camera settings. n is passed as normal argument, e.g. skip_frames(10) to skip 10 frames. You should call this function after changing camera settings.

Alternatively, you can pass the keyword argument time to skip frames for some number of milliseconds, e.g. skip_frames(time = 2000) to skip frames for 2000 milliseconds.

If neither n nor time is specified this method skips frames for 300 milliseconds.

If both are specified this method skips n number of frames but will timeout after time milliseconds.

Note

sensor.snapshot() may apply cropping parameters to fit the snapshot in the available RAM given the pixformat, framesize, windowing, and framebuffers. The cropping parameters will be applied to maintain the aspect ratio and will stay until sensor.set_framesize() or sensor.set_windowing() are called.

sensor.width

sensor.width() -> int

Returns the sensor resolution width.

sensor.height

sensor.height() -> int

Returns the sensor resolution height.

sensor.get_fb

sensor.get_fb() -> image.Image | None

(Get Frame Buffer) Returns the image object returned by a previous call of sensor.snapshot(). If sensor.snapshot() had not been called before then None is returned.

sensor.get_id

sensor.get_id() -> int

Returns the camera module ID.

sensor.alloc_extra_fb

sensor.alloc_extra_fb(width: int, height: int, pixformat: int) -> image.Image

Allocates another frame buffer for image storage from the frame buffer stack and returns an image object of width, height, and pixformat.

You may call this function as many times as you like as long as there’s memory available to allocate any number of extra frame buffers.

If pixformat is a number >= 4 then this will allocate a JPEG image. You can then do Image.bytearray() to get byte level read/write access to the JPEG image.

Note

Creating secondary images normally requires creating them on the heap which has a limited amount of RAM… but, also gets fragmented making it hard to grab a large contiguous memory array to store an image in. With this method you are able to allocate a very large memory array for an image instantly by taking space away from our frame buffer stack memory which we use for computer vision algorithms. That said, this also means you’ll run out of memory more easily if you try to execute more memory intensive machine vision algorithms like Image.find_apriltags().

sensor.dealloc_extra_fb

sensor.dealloc_extra_fb() -> None

Deallocates the last previously allocated extra frame buffer. Extra frame buffers are stored in a stack like structure.

Note

Your OpenMV Cam has two memory areas. First, you have your classical .data/.bss/heap/stack memory area. The .data/.bss/heap regions are fixed by firmware. The stack then grows down until it hits the heap. Next, frame buffers are stored in a secondary memory region. Memory is liad out with the main frame buffer on the bottom and the frame buffer stack on the top. When sensor.snapshot() is called it fills the frame buffer from the bottom. The frame buffer stack is then able to use whatever is left over. This memory allocation method is extremely efficient for computer vision on microcontrollers.

sensor.set_pixformat

sensor.set_pixformat(pixformat: int) -> None

Sets the pixel format for the camera module.

If you are trying to take JPEG images with the OV2640 or OV5640 camera modules at high resolutions you should set the pixformat to sensor.JPEG. You can control the image quality then with sensor.set_quality().

sensor.get_pixformat

sensor.get_pixformat() -> int

Returns the pixformat for the camera module.

sensor.set_framesize

sensor.set_framesize(framesize: int) -> None

Sets the frame size for the camera module.

sensor.get_framesize

sensor.get_framesize() -> int

Returns the frame size for the camera module.

sensor.set_framerate

sensor.set_framerate(rate: int) -> None

Sets the frame rate in hz for the camera module.

Note

set_framerate works by dropping frames received by the camera module to keep the frame rate equal to (or below) the rate you specify. By default the camera will run at the maximum frame rate. If implemented for the particular camera sensor then set_framerate will also reduce the camera sensor frame rate internally to save power and improve image quality by increasing the sensor exposure. set_framerate may conflict with set_auto_exposure on some cameras.

sensor.get_framerate

sensor.get_framerate() -> int

Returns the frame rate in hz for the camera module.

sensor.set_windowing

sensor.set_windowing(roi: Tuple[int, int] | Tuple[int, int, int, int]) -> None

Sets the resolution of the camera to a sub resolution inside of the current resolution. For example, setting the resolution to sensor.VGA and then the windowing to (120, 140, 200, 200) sets sensor.snapshot() to capture the 200x200 center pixels of the VGA resolution outputted by the camera sensor. You can use windowing to get custom resolutions. Also, when using windowing on a larger resolution you effectively are digital zooming.

roi is a rect tuple (x, y, w, h). However, you may just pass (w, h) and the roi will be centered on the frame. You may also pass roi not in parens.

This function will automatically handle cropping the passed roi to the framesize.

sensor.get_windowing

sensor.get_windowing() -> Tuple[int, int, int, int]

Returns the roi tuple (x, y, w, h) previously set with sensor.set_windowing().

sensor.set_gainceiling

sensor.set_gainceiling(gainceiling: int) -> None

Set the camera image gainceiling. 2, 4, 8, 16, 32, 64, or 128.

sensor.set_contrast

sensor.set_contrast(contrast: int) -> None

Set the camera image contrast. -3 to +3.

sensor.set_brightness

sensor.set_brightness(brightness: int) -> None

Set the camera image brightness. -3 to +3.

sensor.set_saturation

sensor.set_saturation(saturation: int) -> None

Set the camera image saturation. -3 to +3.

sensor.set_quality

sensor.set_quality(quality: int) -> None

Set the camera image JPEG compression quality. 0 - 100.

Note

Only for the OV2640/OV5640 cameras.

sensor.set_colorbar

sensor.set_colorbar(enable: bool) -> None

Turns color bar mode on (True) or off (False). Defaults to off.

sensor.set_auto_gain

sensor.set_auto_gain(enable: bool, gain_db=-1, gain_db_ceiling: int | None = None) -> None

enable turns auto gain control on (True) or off (False). The camera will startup with auto gain control on.

If enable is False you may set a fixed gain in decibels with gain_db.

If enable is True you may set the maximum gain ceiling in decibels with gain_db_ceiling for the automatic gain control algorithm.

Note

You need to turn off white balance too if you want to track colors.

sensor.get_gain_db

sensor.get_gain_db() -> float

Returns the current camera gain value in decibels (float).

sensor.set_auto_exposure

sensor.set_auto_exposure(enable: bool, exposure_us: int | None = None) -> None

enable turns auto exposure control on (True) or off (False). The camera will startup with auto exposure control on.

If enable is False you may set a fixed exposure time in microseconds with exposure_us.

Note

Camera auto exposure algorithms are pretty conservative about how much they adjust the exposure value by and will generally avoid changing the exposure value by much. Instead, they change the gain value a lot to deal with changing lighting.

sensor.get_exposure_us

sensor.get_exposure_us() -> int

Returns the current camera exposure value in microseconds (int).

sensor.set_auto_whitebal

sensor.set_auto_whitebal(enable: bool, rgb_gain_db: Tuple[float, float, float] | None = None) -> None

enable turns auto white balance on (True) or off (False). The camera will startup with auto white balance on.

If enable is False you may set a fixed gain in decibels for the red, green, and blue channels respectively with rgb_gain_db.

Note

You need to turn off gain control too if you want to track colors.

sensor.get_rgb_gain_db

sensor.get_rgb_gain_db() -> Tuple[float, float, float]

Returns a tuple with the current camera red, green, and blue gain values in decibels ((float, float, float)).

sensor.set_auto_blc

sensor.set_auto_blc(enable: bool, regs: Any | None = None)

Sets the auto black line calibration (blc) control on the camera.

enable pass True or False to turn BLC on or off. You typically always want this on.

regs if disabled then you can manually set the blc register values via the values you got previously from get_blc_regs().

sensor.get_blc_regs

sensor.get_blc_regs() -> Any

Returns the sensor blc registers as an opaque tuple of integers. For use with set_auto_blc.

sensor.set_hmirror

sensor.set_hmirror(enable: bool) -> None

Turns horizontal mirror mode on (True) or off (False). Defaults to off.

sensor.get_hmirror

sensor.get_hmirror() -> bool

Returns if horizontal mirror mode is enabled.

sensor.set_vflip

sensor.set_vflip(enable: bool) -> None

Turns vertical flip mode on (True) or off (False). Defaults to off.

sensor.get_vflip

sensor.get_vflip() -> bool

Returns if vertical flip mode is enabled.

sensor.set_transpose

sensor.set_transpose(enable: bool) -> None

Turns transpose mode on (True) or off (False). Defaults to off.

  • vflip=False, hmirror=False, transpose=False -> 0 degree rotation
  • vflip=True, hmirror=False, transpose=True -> 90 degree rotation
  • vflip=True, hmirror=True, transpose=False -> 180 degree rotation
  • vflip=False, hmirror=True, transpose=True -> 270 degree rotation

sensor.get_transpose

sensor.get_transpose() -> bool

Returns if transpose mode is enabled.

sensor.set_auto_rotation

sensor.set_auto_rotation(enable: bool) -> None

Turns auto rotation mode on (True) or off (False). Defaults to off.

Note

This function only works when the OpenMV Cam has an imu installed and is enabled automatically.

sensor.get_auto_rotation

sensor.get_auto_rotation() -> bool

Returns if auto rotation mode is enabled.

Note

This function only works when the OpenMV Cam has an imu installed and is enabled automatically.

sensor.set_framebuffers

sensor.set_framebuffers(count: int) -> None

Sets the number of frame buffers used to receive image data. By default your OpenMV Cam will automatically try to allocate the maximum number of frame buffers it can possibly allocate without using more than 1/2 of the available frame buffer RAM at the time of allocation to ensure the best performance. Automatic reallocation of frame buffers occurs whenever you call sensor.set_pixformat(), sensor.set_framesize(), and sensor.set_windowing().

sensor.snapshot() will automatically handle switching active frame buffers in the background. From your code’s perspective there is only ever 1 active frame buffer even though there might be more than 1 frame buffer on the system and another frame buffer receiving data in the background.

If count is:

1 - Single Buffer Mode (you may also pass sensor.SINGLE_BUFFER)

In single buffer mode your OpenMV Cam will allocate one frame buffer for receiving images. When you call sensor.snapshot() that framebuffer will be used to receive the image and the camera driver will continue to run. In the advent you call sensor.snapshot() again before the first line of the next frame is received your code will execute at the frame rate of the camera. Otherwise, the image will be dropped.

2 - Double Buffer Mode (you may also pass sensor.DOUBLE_BUFFER)

In double buffer mode your OpenMV Cam will allocate two frame buffers for receiving images. When you call sensor.snapshot() one framebuffer will be used to receive the image and the camera driver will continue to run. When the next frame is received it will be stored in the other frame buffer. In the advent you call sensor.snapshot() again before the first line of the next frame after is received your code will execute at the frame rate of the camera. Otherwise, the image will be dropped.

3 - Triple Buffer Mode (you may also pass sensor.TRIPLE_BUFFER)

In triple buffer mode your OpenMV Cam will allocate three buffers for receiving images. In this mode there is always a frame buffer to store the received image to in the background resulting in the highest performance and lowest latency for reading the latest received frame. No frames are ever dropped in this mode. The next frame read by sensor.snapshot() is the last captured frame by the sensor driver (e.g. if you are reading slower than the camera frame rate then the older frame in the possible frames available is skipped).

Regarding the reallocation above, triple buffering is tried first, then double buffering, and if these both fail to fit in 1/2 of the available frame buffer RAM then single buffer mode is used.

You may pass a value of 4 or greater to put the sensor driver into video FIFO mode where received images are stored in a frame buffer FIFO with count buffers. This is useful for video recording to an SD card which may randomly block your code from writing data when the SD card is performing house-keeping tasks like pre-erasing blocks to write data to.

Note

On frame drop (no buffers available to receive the next frame) all frame buffers are automatically cleared except the active frame buffer. This is done to ensure sensor.snapshot() returns current frames and not frames from long ago.

Fun fact, you can pass a value of 100 or so on OpenMV Cam’s with SDRAM for a huge video fifo. If you then call snapshot slower than the camera frame rate (by adding machine.sleep()) you’ll get slow-mo effects in OpenMV IDE. However, you will also see the above policy effect of resetting the frame buffer on a frame drop to ensure that frames do not get too old. If you want to record slow-mo video just record video normally to the SD card and then play the video back on a desktop machine slower than it was recorded.

sensor.get_framebuffers

sensor.get_framebuffers() -> int

Returns the current number of frame buffers allocated.

sensor.disable_delays

sensor.disable_delays(disable: bool | None = None) -> bool

If disable is True then disable all settling time delays in the sensor module. Whenever you reset the camera module, change modes, etc. the sensor driver delays to prevent you can from calling snapshot to quickly afterwards and receiving corrupt frames from the camera module. By disabling delays you can quickly update the camera module settings in bulk via multiple function calls before delaying at the end and calling snapshot.

If this function is called with no arguments it returns if delays are disabled.

sensor.disable_full_flush

sensor.disable_full_flush(disable: bool | None = None) -> bool

If disable is True then automatic framebuffer flushing mentioned in set_framebuffers is disabled. This removes any time limit on frames in the frame buffer fifo. For example, if you set the number of frame buffers to 30 and set the frame rate to 30 you can now precisely record 1 second of video from the camera without risk of frame loss.

If this function is called with no arguments it returns if automatic flushing is disabled. By default automatic flushing on frame drop is enabled to clear out stale frames.

Note

snapshot starts the frame capture process which will continue to capture frames until there is no space to hold a frame at which point the frame capture process stops. The process always stops when there is no space to hold the next frame.

sensor.set_lens_correction

sensor.set_lens_correction(enable: bool, radi: int, coef: int) -> None

enable True to enable and False to disable (bool). radi integer radius of pixels to correct (int). coef power of correction (int).

sensor.set_vsync_callback

sensor.set_vsync_callback(cb) -> None

Registers callback cb to be executed (in interrupt context) whenever the camera module generates a new frame (but, before the frame is received).

cb takes one argument and is passed the current state of the vsync pin after changing.

sensor.set_frame_callback

sensor.set_frame_callback(cb) -> None

Registers callback cb to be executed (in interrupt context) whenever the camera module generates a new frame and the frame is ready to be read via sensor.snapshot().

cb takes no arguments.

Use this to get an interrupt to schedule reading a frame later with micropython.schedule().

sensor.get_frame_available

sensor.get_frame_available() -> bool

Returns True if a frame is available to read by calling sensor.snapshot().

sensor.ioctl

sensor.ioctl(*args, **kwargs) -> Any

Executes a sensor specific method:

sensor.set_color_palette

sensor.set_color_palette(palette: int) -> None

Sets the color palette to use for FLIR Lepton grayscale to RGB565 conversion.

sensor.get_color_palette

sensor.get_color_palette() -> int

Returns the current color palette setting. Defaults to image.PALETTE_RAINBOW.

sensor.__write_reg

sensor.__write_reg(address: int, value: int) -> None

Write value (int) to camera register at address (int).

Note

See the camera data sheet for register info.

sensor.__read_reg

sensor.__read_reg(address: int) -> int

Read camera register at address (int).

Note

See the camera data sheet for register info.

Constants

sensor.BINARY

sensor.BINARY: int

BINARY (bitmap) pixel format. Each pixel is 1-bit.

This format is usful for mask storage. Can be used with Image() and sensor.alloc_extra_fb().

sensor.GRAYSCALE

sensor.GRAYSCALE: int

GRAYSCALE pixel format (Y from YUV422). Each pixel is 8-bits, 1-byte.

All of our computer vision algorithms run faster on grayscale images than RGB565 images.

sensor.RGB565

sensor.RGB565: int

RGB565 pixel format. Each pixel is 16-bits, 2-bytes. 5-bits are used for red, 6-bits are used for green, and 5-bits are used for blue.

All of our computer vision algorithms run slower on RGB565 images than grayscale images.

sensor.BAYER

sensor.BAYER: int

RAW BAYER image pixel format. If you try to make the frame size too big to fit in the frame buffer your OpenMV Cam will set the pixel format to BAYER so that you can capture images but only some image processing methods will be operational.

sensor.YUV422

sensor.YUV422: int

A pixel format that is very easy to jpeg compress. Each pixel is stored as a grayscale 8-bit Y value followed by alternating 8-bit U/V color values that are shared between two Y values (8-bits Y1, 8-bits U, 8-bits Y2, 8-bits V, etc.). Only some image processing methods work with YUV422.

sensor.JPEG

sensor.JPEG: int

JPEG mode. The camera module outputs compressed jpeg images. Use sensor.set_quality() to control the jpeg quality. Only works for the OV2640/OV5640 cameras.

sensor.OV2640

sensor.OV2640: int

sensor.get_id() returns this for the OV2640 camera.

sensor.OV5640

sensor.OV5640: int

sensor.get_id() returns this for the OV5640 camera.

sensor.OV7690

sensor.OV7690: int

sensor.get_id() returns this for the OV7690 camera.

sensor.OV7725

sensor.OV7725: int

sensor.get_id() returns this for the OV7725 camera.

sensor.OV9650

sensor.OV9650: int

sensor.get_id() returns this for the OV9650 camera.

sensor.MT9V022

sensor.MT9V022: int

sensor.get_id() returns this for the MT9V022 camera.

sensor.MT9V024

sensor.MT9V024: int

sensor.get_id() returns this for the MT9V024 camera.

sensor.MT9V032

sensor.MT9V032: int

sensor.get_id() returns this for the MT9V032 camera.

sensor.MT9V034

sensor.MT9V034: int

sensor.get_id() returns this for the MT9V034 camera.

sensor.MT9M114

sensor.MT9M114: int

sensor.get_id() returns this for the MT9M114 camera.

sensor.LEPTON

sensor.LEPTON: int

sensor.get_id() returns this for the LEPTON1/2/3 cameras.

sensor.HM01B0

sensor.HM01B0: int

sensor.get_id() returns this for the HM01B0 camera.

sensor.HM0360

sensor.HM0360: int

sensor.get_id() returns this for the HM01B0 camera.

sensor.GC2145

sensor.GC2145: int

sensor.get_id() returns this for the GC2145 camera.

sensor.PAG7920

sensor.PAG7920: int

sensor.get_id() returns this for the PAG7920 camera.

sensor.PAJ6100

sensor.PAJ6100: int

sensor.get_id() returns this for the PAJ6100 camera.

sensor.FROGEYE2020

sensor.FROGEYE2020: int

sensor.get_id() returns this for the FROGEYE2020 camera.

sensor.QQCIF

sensor.QQCIF: int

88x72 resolution for the camera sensor.

sensor.QCIF

sensor.QCIF: int

176x144 resolution for the camera sensor.

sensor.CIF

sensor.CIF: int

352x288 resolution for the camera sensor.

sensor.QQSIF

sensor.QQSIF: int

88x60 resolution for the camera sensor.

sensor.QSIF

sensor.QSIF: int

176x120 resolution for the camera sensor.

sensor.SIF

sensor.SIF: int

352x240 resolution for the camera sensor.

sensor.QQQQVGA

sensor.QQQQVGA: int

40x30 resolution for the camera sensor.

sensor.QQQVGA

sensor.QQQVGA: int

80x60 resolution for the camera sensor.

sensor.QQVGA

sensor.QQVGA: int

160x120 resolution for the camera sensor.

sensor.QVGA

sensor.QVGA: int

320x240 resolution for the camera sensor.

sensor.VGA

sensor.VGA: int

640x480 resolution for the camera sensor.

sensor.HQQQQVGA

sensor.HQQQQVGA: int

30x20 resolution for the camera sensor.

sensor.HQQQVGA

sensor.HQQQVGA: int

60x40 resolution for the camera sensor.

sensor.HQQVGA

sensor.HQQVGA: int

120x80 resolution for the camera sensor.

sensor.HQVGA

sensor.HQVGA: int

240x160 resolution for the camera sensor.

sensor.HVGA

sensor.HVGA: int

480x320 resolution for the camera sensor.

sensor.B64X32

sensor.B64X32: int

64x32 resolution for the camera sensor.

For use with Image.find_displacement() and any other FFT based algorithm.

sensor.B64X64

sensor.B64X64: int

64x64 resolution for the camera sensor.

For use with Image.find_displacement() and any other FFT based algorithm.

sensor.B128X64

sensor.B128X64: int

128x64 resolution for the camera sensor.

For use with Image.find_displacement() and any other FFT based algorithm.

sensor.B128X128

sensor.B128X128: int

128x128 resolution for the camera sensor.

For use with Image.find_displacement() and any other FFT based algorithm.

sensor.B160X160

sensor.B160X160: int

160x160 resolution for the HM01B0 camera sensor.

sensor.B320X320

sensor.B320X320: int

320x320 resolution for the HM01B0 camera sensor.

sensor.LCD

sensor.LCD: int

128x160 resolution for the camera sensor (for use with the lcd shield).

sensor.QQVGA2

sensor.QQVGA2: int

128x160 resolution for the camera sensor (for use with the lcd shield).

sensor.WVGA

sensor.WVGA: int

720x480 resolution for the MT9V034 camera sensor.

sensor.WVGA2

sensor.WVGA2: int

752x480 resolution for the MT9V034 camera sensor.

sensor.SVGA

sensor.SVGA: int

800x600 resolution for the camera sensor.

sensor.XGA

sensor.XGA: int

1024x768 resolution for the camera sensor.

sensor.WXGA

sensor.WXGA: int

1280x768 resolution for the MT9M114 camera sensor.

sensor.SXGA

sensor.SXGA: int

1280x1024 resolution for the camera sensor. Only works for the OV2640/OV5640 cameras.

sensor.SXGAM

sensor.SXGAM: int

1280x960 resolution for the MT9M114 camera sensor.

sensor.UXGA

sensor.UXGA: int

1600x1200 resolution for the camera sensor. Only works for the OV2640/OV5640 cameras.

sensor.HD

sensor.HD: int

1280x720 resolution for the camera sensor.

sensor.FHD

sensor.FHD: int

1920x1080 resolution for the camera sensor. Only works for the OV5640 camera.

sensor.QHD

sensor.QHD: int

2560x1440 resolution for the camera sensor. Only works for the OV5640 camera.

sensor.QXGA

sensor.QXGA: int

2048x1536 resolution for the camera sensor. Only works for the OV5640 camera.

sensor.WQXGA

sensor.WQXGA: int

2560x1600 resolution for the camera sensor. Only works for the OV5640 camera.

sensor.WQXGA2

sensor.WQXGA2: int

2592x1944 resolution for the camera sensor. Only works for the OV5640 camera.

sensor.IOCTL_SET_READOUT_WINDOW

sensor.IOCTL_SET_READOUT_WINDOW: int

Lets you set the readout window for the OV5640.

sensor.IOCTL_GET_READOUT_WINDOW

sensor.IOCTL_GET_READOUT_WINDOW: int

Lets you get the readout window for the OV5640.

sensor.IOCTL_SET_TRIGGERED_MODE

sensor.IOCTL_SET_TRIGGERED_MODE: int

Lets you set the triggered mode for the MT9V034.

sensor.IOCTL_GET_TRIGGERED_MODE

sensor.IOCTL_GET_TRIGGERED_MODE: int

Lets you get the triggered mode for the MT9V034.

sensor.IOCTL_SET_FOV_WIDE

sensor.IOCTL_SET_FOV_WIDE: int

Enable sensor.set_framesize() to optimize for the field-of-view over FPS.

sensor.IOCTL_GET_FOV_WIDE

sensor.IOCTL_GET_FOV_WIDE: int

Return if sensor.set_framesize() is optimizing for field-of-view over FPS.

sensor.IOCTL_TRIGGER_AUTO_FOCUS

sensor.IOCTL_TRIGGER_AUTO_FOCUS: int

Used to trigger auto focus for the OV5640 FPC camera module.

sensor.IOCTL_PAUSE_AUTO_FOCUS

sensor.IOCTL_PAUSE_AUTO_FOCUS: int

Used to pause auto focus (while running) for the OV5640 FPC camera module.

sensor.IOCTL_RESET_AUTO_FOCUS

sensor.IOCTL_RESET_AUTO_FOCUS: int

Used to reset auto focus back to the default for the OV5640 FPC camera module.

sensor.IOCTL_WAIT_ON_AUTO_FOCUS

sensor.IOCTL_WAIT_ON_AUTO_FOCUS: int

Used to wait on auto focus to finish after being triggered for the OV5640 FPC camera module.

sensor.IOCTL_SET_NIGHT_MODE

sensor.IOCTL_SET_NIGHT_MODE: int

Used to turn night mode on or off on a sensor. Nightmode reduces the frame rate to increase exposure dynamically.

sensor.IOCTL_GET_NIGHT_MODE

sensor.IOCTL_GET_NIGHT_MODE: int

Gets the current value of if night mode is enabled or disabled for your sensor.

sensor.IOCTL_LEPTON_GET_WIDTH

sensor.IOCTL_LEPTON_GET_WIDTH: int

Lets you get the FLIR Lepton image resolution width in pixels.

sensor.IOCTL_LEPTON_GET_HEIGHT

sensor.IOCTL_LEPTON_GET_HEIGHT: int

Lets you get the FLIR Lepton image resolution height in pixels.

sensor.IOCTL_LEPTON_GET_RADIOMETRY

sensor.IOCTL_LEPTON_GET_RADIOMETRY: int

Lets you get the FLIR Lepton type (radiometric or not).

sensor.IOCTL_LEPTON_GET_REFRESH

sensor.IOCTL_LEPTON_GET_REFRESH: int

Lets you get the FLIR Lepton refresh rate in hertz.

sensor.IOCTL_LEPTON_GET_RESOLUTION

sensor.IOCTL_LEPTON_GET_RESOLUTION: int

Lets you get the FLIR Lepton ADC resolution in bits.

sensor.IOCTL_LEPTON_RUN_COMMAND

sensor.IOCTL_LEPTON_RUN_COMMAND: int

Executes a 16-bit command given the FLIR Lepton SDK.

sensor.IOCTL_LEPTON_SET_ATTRIBUTE

sensor.IOCTL_LEPTON_SET_ATTRIBUTE: int

Sets a FLIR Lepton Attribute given the FLIR Lepton SDK.

sensor.IOCTL_LEPTON_GET_ATTRIBUTE

sensor.IOCTL_LEPTON_GET_ATTRIBUTE: int

Gets a FLIR Lepton Attribute given the FLIR Lepton SDK.

sensor.IOCTL_LEPTON_GET_FPA_TEMPERATURE

sensor.IOCTL_LEPTON_GET_FPA_TEMPERATURE: int

Gets the FLIR Lepton FPA temp in celsius.

sensor.IOCTL_LEPTON_GET_AUX_TEMPERATURE

sensor.IOCTL_LEPTON_GET_AUX_TEMPERATURE: int

Gets the FLIR Lepton AUX temp in celsius.

sensor.IOCTL_LEPTON_SET_MEASUREMENT_MODE

sensor.IOCTL_LEPTON_SET_MEASUREMENT_MODE: int

Lets you set the FLIR Lepton driver into a mode where you can get a valid temperature value per pixel. See sensor.ioctl() for more information.

sensor.IOCTL_LEPTON_GET_MEASUREMENT_MODE

sensor.IOCTL_LEPTON_GET_MEASUREMENT_MODE: int

Lets you get if measurement mode is enabled or not for the FLIR Lepton sensor. See sensor.ioctl() for more information.

sensor.IOCTL_LEPTON_SET_MEASUREMENT_RANGE

sensor.IOCTL_LEPTON_SET_MEASUREMENT_RANGE: int

Lets you set the temperature range you want to map pixels in the image to when in measurement mode. See sensor.ioctl() for more information.

sensor.IOCTL_LEPTON_GET_MEASUREMENT_RANGE

sensor.IOCTL_LEPTON_GET_MEASUREMENT_RANGE: int

Lets you get the temperature range used for measurement mode. See sensor.ioctl() for more information.

sensor.IOCTL_HIMAX_MD_ENABLE

sensor.IOCTL_HIMAX_MD_ENABLE: int

Lets you control the motion detection interrupt on the HM01B0. See sensor.ioctl() for more information.

sensor.IOCTL_HIMAX_MD_CLEAR

sensor.IOCTL_HIMAX_MD_CLEAR: int

Lets you control the motion detection interrupt on the HM01B0. See sensor.ioctl() for more information.

sensor.IOCTL_HIMAX_MD_WINDOW

sensor.IOCTL_HIMAX_MD_WINDOW: int

Lets you control the motion detection interrupt on the HM01B0. See sensor.ioctl() for more information.

sensor.IOCTL_HIMAX_MD_THRESHOLD

sensor.IOCTL_HIMAX_MD_THRESHOLD: int

Lets you control the motion detection interrupt on the HM01B0. See sensor.ioctl() for more information.

sensor.IOCTL_HIMAX_OSC_ENABLE

sensor.IOCTL_HIMAX_OSC_ENABLE: int

Lets you control the internal oscillator on the HM01B0. See sensor.ioctl() for more information.

sensor.SINGLE_BUFFER

sensor.SINGLE_BUFFER: int

Pass to sensor.set_framebuffers() to set single buffer mode (1 buffer).

sensor.DOUBLE_BUFFER

sensor.DOUBLE_BUFFER: int

Pass to sensor.set_framebuffers() to set double buffer mode (2 buffers).

sensor.TRIPLE_BUFFER

sensor.TRIPLE_BUFFER: int

Pass to sensor.set_framebuffers() to set triple buffer mode (3 buffers).

sensor.VIDEO_FIFO

sensor.VIDEO_FIFO: int

Pass to sensor.set_framebuffers() to set video FIFO mode (4 buffers).

stm — functionality specific to STM32 MCUs

functionality specific to STM32 MCUs

image — machine vision

machine vision

On this page

sensor — camera sensorFunctionssensor.resetsensor.sleepsensor.shutdownsensor.flushsensor.snapshotsensor.skip_framessensor.widthsensor.heightsensor.get_fbsensor.get_idsensor.alloc_extra_fbsensor.dealloc_extra_fbsensor.set_pixformatsensor.get_pixformatsensor.set_framesizesensor.get_framesizesensor.set_frameratesensor.get_frameratesensor.set_windowingsensor.get_windowingsensor.set_gainceilingsensor.set_contrastsensor.set_brightnesssensor.set_saturationsensor.set_qualitysensor.set_colorbarsensor.set_auto_gainsensor.get_gain_dbsensor.set_auto_exposuresensor.get_exposure_ussensor.set_auto_whitebalsensor.get_rgb_gain_dbsensor.set_auto_blcsensor.get_blc_regssensor.set_hmirrorsensor.get_hmirrorsensor.set_vflipsensor.get_vflipsensor.set_transposesensor.get_transposesensor.set_auto_rotationsensor.get_auto_rotationsensor.set_framebuffers1 - Single Buffer Mode (you may also pass sensor.SINGLE_BUFFER)2 - Double Buffer Mode (you may also pass sensor.DOUBLE_BUFFER)3 - Triple Buffer Mode (you may also pass sensor.TRIPLE_BUFFER)sensor.get_framebufferssensor.disable_delayssensor.disable_full_flushsensor.set_lens_correctionsensor.set_vsync_callbacksensor.set_frame_callbacksensor.get_frame_availablesensor.ioctlsensor.IOCTL_SET_READOUT_WINDOW - Pass this enum followed by a rect tuple (x, y, w, h) or a size tuple (w, h).sensor.IOCTL_LEPTON_SET_ATTRIBUTE - Pass this enum to set a FLIR Lepton SDK attribute.sensor.IOCTL_LEPTON_GET_ATTRIBUTE - Pass this enum to get a FLIR Lepton SDK attribute.sensor.IOCTL_LEPTON_SET_MEASUREMENT_RANGE - Pass this when measurement mode is enabled to set the temperature range in celsius for the mapping operation. The temperature image returned by the FLIR Lepton will then be clamped between these min and max values and then scaled to values between 0 to 255. To map a pixel value back to a temperature (on a grayscale image) do: ((pixel * (max_temp_in_celsius - min_temp_in_celsius)) / 255.0) + min_temp_in_celsius.sensor.set_color_palettesensor.get_color_palettesensor.__write_regsensor.__read_regConstantssensor.BINARYsensor.GRAYSCALEsensor.RGB565sensor.BAYERsensor.YUV422sensor.JPEGsensor.OV2640sensor.OV5640sensor.OV7690sensor.OV7725sensor.OV9650sensor.MT9V022sensor.MT9V024sensor.MT9V032sensor.MT9V034sensor.MT9M114sensor.LEPTONsensor.HM01B0sensor.HM0360sensor.GC2145sensor.PAG7920sensor.PAJ6100sensor.FROGEYE2020sensor.QQCIFsensor.QCIFsensor.CIFsensor.QQSIFsensor.QSIFsensor.SIFsensor.QQQQVGAsensor.QQQVGAsensor.QQVGAsensor.QVGAsensor.VGAsensor.HQQQQVGAsensor.HQQQVGAsensor.HQQVGAsensor.HQVGAsensor.HVGAsensor.B64X32sensor.B64X64sensor.B128X64sensor.B128X128sensor.B160X160sensor.B320X320sensor.LCDsensor.QQVGA2sensor.WVGAsensor.WVGA2sensor.SVGAsensor.XGAsensor.WXGAsensor.SXGAsensor.SXGAMsensor.UXGAsensor.HDsensor.FHDsensor.QHDsensor.QXGAsensor.WQXGAsensor.WQXGA2sensor.IOCTL_SET_READOUT_WINDOWsensor.IOCTL_GET_READOUT_WINDOWsensor.IOCTL_SET_TRIGGERED_MODEsensor.IOCTL_GET_TRIGGERED_MODEsensor.IOCTL_SET_FOV_WIDEsensor.IOCTL_GET_FOV_WIDEsensor.IOCTL_TRIGGER_AUTO_FOCUSsensor.IOCTL_PAUSE_AUTO_FOCUSsensor.IOCTL_RESET_AUTO_FOCUSsensor.IOCTL_WAIT_ON_AUTO_FOCUSsensor.IOCTL_SET_NIGHT_MODEsensor.IOCTL_GET_NIGHT_MODEsensor.IOCTL_LEPTON_GET_WIDTHsensor.IOCTL_LEPTON_GET_HEIGHTsensor.IOCTL_LEPTON_GET_RADIOMETRYsensor.IOCTL_LEPTON_GET_REFRESHsensor.IOCTL_LEPTON_GET_RESOLUTIONsensor.IOCTL_LEPTON_RUN_COMMANDsensor.IOCTL_LEPTON_SET_ATTRIBUTEsensor.IOCTL_LEPTON_GET_ATTRIBUTEsensor.IOCTL_LEPTON_GET_FPA_TEMPERATUREsensor.IOCTL_LEPTON_GET_AUX_TEMPERATUREsensor.IOCTL_LEPTON_SET_MEASUREMENT_MODEsensor.IOCTL_LEPTON_GET_MEASUREMENT_MODEsensor.IOCTL_LEPTON_SET_MEASUREMENT_RANGEsensor.IOCTL_LEPTON_GET_MEASUREMENT_RANGEsensor.IOCTL_HIMAX_MD_ENABLEsensor.IOCTL_HIMAX_MD_CLEARsensor.IOCTL_HIMAX_MD_WINDOWsensor.IOCTL_HIMAX_MD_THRESHOLDsensor.IOCTL_HIMAX_OSC_ENABLEsensor.SINGLE_BUFFERsensor.DOUBLE_BUFFERsensor.TRIPLE_BUFFERsensor.VIDEO_FIFO
sensor — camera sensor