Skip to content

Commit 81fb9a5

Browse files
committed
specify return type for docs
1 parent 277b439 commit 81fb9a5

File tree

1 file changed

+21
-21
lines changed
  • ports/espressif/bindings/esp32_camera

1 file changed

+21
-21
lines changed

ports/espressif/bindings/esp32_camera/Camera.c

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,27 +59,27 @@
5959
//| jpeg_quality: int=15,
6060
//| double_buffered: bool = True,
6161
//| grab_mode: GrabMode = GrabMode.WhenEmpty,
62-
//| ):
63-
//| """
64-
//| Configure and initialize a camera with the given properties
65-
//|
66-
//| This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``/.env`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError, this probably indicates the setting is too small and should be increased.
67-
//|
68-
//| :param data_pins: The 8 data data_pins used for image data transfer from the camera module, least significant bit first
69-
//| :param pixel_clock: The pixel clock output from the camera module
70-
//| :param vsync: The vertical sync pulse output from the camera module
71-
//| :param href: The horizontal reference output from the camera module
72-
//| :param i2c: The I2C bus connected to the camera module
73-
//| :param external_clock_frequency: The frequency generated on the external clock pin
74-
//| :param external_clock_pin: The pin on which to generate the external clock
75-
//| :param powerdown_pin: The powerdown input to the camera module
76-
//| :param reset_pin: The reset input to the camera module
77-
//| :param pixel_format: The pixel format of the captured image
78-
//| :param frame_size: The size of captured image
79-
//| :param 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 availalble 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.
80-
//| :param framebuffer_count: The number of framebuffers
81-
//| :param grab_mode: When to grab a new frame
82-
//| """
62+
//| ) -> None:
63+
//| """
64+
//| Configure and initialize a camera with the given properties
65+
//|
66+
//| This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``/.env`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError, this probably indicates the setting is too small and should be increased.
67+
//|
68+
//| :param data_pins: The 8 data data_pins used for image data transfer from the camera module, least significant bit first
69+
//| :param pixel_clock: The pixel clock output from the camera module
70+
//| :param vsync: The vertical sync pulse output from the camera module
71+
//| :param href: The horizontal reference output from the camera module
72+
//| :param i2c: The I2C bus connected to the camera module
73+
//| :param external_clock_frequency: The frequency generated on the external clock pin
74+
//| :param external_clock_pin: The pin on which to generate the external clock
75+
//| :param powerdown_pin: The powerdown input to the camera module
76+
//| :param reset_pin: The reset input to the camera module
77+
//| :param pixel_format: The pixel format of the captured image
78+
//| :param frame_size: The size of captured image
79+
//| :param 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 availalble 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.
80+
//| :param framebuffer_count: The number of framebuffers
81+
//| :param grab_mode: When to grab a new frame
82+
//| """
8383
//|
8484
STATIC mp_obj_t esp32_camera_camera_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
8585
enum { ARG_data_pins, ARG_pixel_clock_pin, ARG_vsync_pin, ARG_href_pin, ARG_i2c, ARG_external_clock_pin, ARG_external_clock_frequency, ARG_powerdown_pin, ARG_reset_pin, ARG_pixel_format, ARG_frame_size, ARG_jpeg_quality, ARG_framebuffer_count, ARG_grab_mode, NUM_ARGS };

0 commit comments

Comments
 (0)