docs/openmvcam: Documentation checkpoint.

Author: kwagyeman

docs/conf.py

@@ -76,7 +76,7 @@
 
 # General information about the project.
 project = "MicroPython"
-copyright = "- The MicroPython Documentation is Copyright © 2014-2026, Damien P. George, Paul Sokolovsky, and contributors"
+copyright = "- The MicroPython Documentation is Copyright © 2014-2026, Damien P. George, Paul Sokolovsky, OpenMV LLC, and contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -115,6 +115,8 @@
     "library/omv.uftpd.rst",
     "library/omv.utelnet.rst",
     "library/omv.uping.rst",
+    "library/omv.umalloc.rst",
+    "library/omv.cpufreq.rst",
     "library/esp.rst",
     "library/espnow.rst",
     "library/esp32.rst",

docs/library/index.rst

@@ -87,11 +87,17 @@ library.
 
 .. _micropython_lib_micropython:
 
-MicroPython-specific libraries
-------------------------------
+OpenMV Cam libraries
+--------------------
 
-Functionality specific to the MicroPython implementation is available in
-the following libraries.
+The following sections describe the libraries available on each
+OpenMV-supported board, including both the MicroPython-specific
+built-ins and OpenMV's own extensions.
+
+Common modules
+~~~~~~~~~~~~~~
+
+Built into the firmware on every OpenMV camera board.
 
 .. toctree::
    :maxdepth: 1
@@ -106,21 +112,6 @@ the following libraries.
    openamp.rst
    uctypes.rst
    vfs.rst
-
-Libraries specific to the OpenMV Cam
-------------------------------------
-
-The following sections describe the libraries available on each
-OpenMV-supported board.
-
-Common OpenMV modules
-~~~~~~~~~~~~~~~~~~~~~
-
-Built into the firmware on every OpenMV camera board.
-
-.. toctree::
-   :maxdepth: 1
-
    omv.csi.rst
    omv.sensor.rst
    omv.image.rst
@@ -133,7 +124,6 @@ Built into the firmware on every OpenMV camera board.
    omv.imu.rst
    omv.omv.rst
    omv.crc.rst
-   omv.umalloc.rst
    omv.ml.rst
    omv.ulab.rst
    logging.rst
@@ -176,7 +166,6 @@ for which boards include each one.
 
    pyb.rst
    stm.rst
-   omv.cpufreq.rst
    mimxrt.rst
    omv.alif.rst
 
@@ -228,7 +217,6 @@ OpenMV N6 (STM32N6 — STMicroelectronics' first NPU-equipped MCU):
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`ssd1306` — OLED driver
 * :mod:`tb6612` — TB6612 motor driver
 
@@ -263,7 +251,6 @@ OpenMV Pure Thermal:
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`tfp410` — DVI/HDMI serializer
 * :mod:`ft5x06` — capacitive touchscreen driver
 * :mod:`dht` — DHT11 and DHT22 temperature/humidity sensors
@@ -280,7 +267,6 @@ Legacy STM32-based OpenMV camera boards:
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`dht` — DHT11 and DHT22 temperature/humidity sensors
 * :mod:`onewire` — 1-Wire bus protocol
 * :mod:`ds18x20` — DS18x20 temperature sensor driver
@@ -295,7 +281,6 @@ Arduino Giga R1 WiFi:
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`dht` — DHT11 and DHT22 temperature/humidity sensors
 * :mod:`onewire` — 1-Wire bus protocol
 * :mod:`neopixel` — control of WS2812 / NeoPixel LEDs
@@ -309,7 +294,6 @@ Arduino Portenta H7:
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`dht` — DHT11 and DHT22 temperature/humidity sensors
 * :mod:`ds18x20` — DS18x20 temperature sensor driver
 * :mod:`onewire` — 1-Wire bus protocol
@@ -325,7 +309,6 @@ Arduino Nicla Vision:
 
 * :mod:`pyb` — functions related to the board
 * :mod:`stm` — functionality specific to STM32 MCUs
-* :mod:`cpufreq` — CPU frequency control
 * :mod:`lsm6dsox` — LSM6DSOX 6-axis IMU
 * :mod:`dht` — DHT11 and DHT22 temperature/humidity sensors
 * :mod:`ds18x20` — DS18x20 temperature sensor driver

docs/library/machine.Counter.rst

@@ -96,7 +96,7 @@ Constructors
       Stops the Counter, disabling any interrupts and releasing hardware resources.
       A Soft Reset should deinitialize all Counter objects.
 
-   .. method:: value(value: int | None = None, /) -> int
+   .. method:: value(value: int = ..., /) -> int
 
       Get, and optionally set, the counter value as a signed integer.
       Implementations must aim to do the get and set atomically (i.e. without
@@ -116,7 +116,7 @@ Constructors
       the counter (i.e. to measure the counts since the last call), and this will
       avoid this problem.
 
-   .. method:: cycles(value: int | None = None, /) -> int
+   .. method:: cycles(value: int = ..., /) -> int
 
       Get or set the current cycles counter of the counter as signed 16 bit integer.
       The value represents the overflow or underflow events of the count range.

docs/library/machine.Encoder.rst

@@ -98,14 +98,14 @@ Constructors
       Stops the Encoder, disabling any interrupts and releasing hardware resources.
       A Soft Reset should deinitialize all Encoder objects.
 
-   .. method:: value(value: int | None = None, /) -> int
+   .. method:: value(value: int = ..., /) -> int
 
       Get, and optionally set, the encoder value as a signed integer.
       Implementations should aim to do the get and set atomically.
 
       See :meth:`machine.Counter.value` for details about overflow of this value.
 
-   .. method:: cycles(value: int | None = None, /) -> int
+   .. method:: cycles(value: int = ..., /) -> int
 
       Get or set the current cycles counter of the counter as signed 16 bit integer.
       The value represents the overflow or underflow events of the count range.

docs/library/machine.LED.rst

@@ -47,7 +47,7 @@ Constructors
 
       Toggles the LED state.
 
-   .. method:: value(v: int | None = None) -> int | None
+   .. method:: value(v: int = ...) -> int | None
 
       If ``v`` is given, sets the LED to the given value. If ``v`` is not given,
       returns the current LED value.

docs/library/machine.PWM.rst

@@ -54,7 +54,7 @@ Constructors
 
       Disable the PWM output.
 
-   .. method:: freq(value: int | None = None, /) -> int | None
+   .. method:: freq(value: int = ..., /) -> int | None
 
       Get or set the current frequency of the PWM output.
 
@@ -63,7 +63,7 @@ Constructors
       With a single *value* argument the frequency is set to that value in Hz.  The
       method may raise a ``ValueError`` if the frequency is outside the valid range.
 
-   .. method:: duty_u16(value: int | None = None, /) -> int | None
+   .. method:: duty_u16(value: int = ..., /) -> int | None
 
       Get or set the current duty cycle of the PWM output, as an unsigned 16-bit
       value in the range 0 to 65535 inclusive.
@@ -73,7 +73,7 @@ Constructors
       With a single *value* argument the duty cycle is set to that value, measured
       as the ratio ``value / 65535``.
 
-   .. method:: duty_ns(value: int | None = None, /) -> int | None
+   .. method:: duty_ns(value: int = ..., /) -> int | None
 
       Get or set the current pulse width of the PWM output, as a value in nanoseconds.
 

docs/library/machine.Pin.rst

@@ -116,7 +116,7 @@ Constructors
 
       Returns ``None``.
 
-   .. method:: value(x: Any | None = None, /) -> int | None
+   .. method:: value(x: Any = ..., /) -> int | None
 
       This method allows to set and get the value of the pin, depending on whether
       the argument ``x`` is supplied or not.
@@ -148,7 +148,7 @@ Constructors
 
       When setting the value this method returns ``None``.
 
-   .. method:: __call__(x: Any | None = None, /) -> int | None
+   .. method:: __call__(x: Any = ..., /) -> int | None
 
       Pin objects are callable.  The call method provides a (fast) shortcut to set
       and get the value of the pin.  It is equivalent to Pin.value([x]).
@@ -217,21 +217,21 @@ Constructors
 
       Availability: mimxrt, nrf, renesas-ra, rp2, samd, stm32, alif ports.
 
-   .. method:: mode(mode: int | None = None, /) -> int | None
+   .. method:: mode(mode: int = ..., /) -> int | None
 
       Get or set the pin mode.
       See the constructor documentation for details of the ``mode`` argument.
 
       Availability: cc3200, stm32 ports.
 
-   .. method:: pull(pull: int | None = None, /) -> int | None
+   .. method:: pull(pull: int = ..., /) -> int | None
 
       Get or set the pin pull state.
       See the constructor documentation for details of the ``pull`` argument.
 
       Availability: cc3200, stm32 ports.
 
-   .. method:: drive(drive: int | None = None, /) -> int | None
+   .. method:: drive(drive: int = ..., /) -> int | None
 
       Get or set the pin drive strength.
       See the constructor documentation for details of the ``drive`` argument.

docs/library/machine.RTC.rst

@@ -24,7 +24,7 @@ Constructors
    Methods
    -------
 
-   .. method:: datetime(datetimetuple: tuple | None = None, /) -> tuple | None
+   .. method:: datetime(datetimetuple: tuple = ..., /) -> tuple | None
 
       Get or set the date and time of the RTC.
 
@@ -87,7 +87,7 @@ Constructors
          - ``wake`` specifies the sleep mode from where this interrupt can wake
            up the system.
 
-   .. method:: memory(data: bytes | None = None, /) -> bytes | None
+   .. method:: memory(data: bytes = ..., /) -> bytes | None
 
       ``RTC.memory(data)`` will write *data* to the RTC memory, where *data* is any
       object which supports the buffer protocol (including `bytes`, `bytearray`,

docs/library/machine.Signal.rst

@@ -96,7 +96,7 @@ Constructors
    Methods
    -------
 
-   .. method:: value(x: Any | None = None, /) -> int | None
+   .. method:: value(x: Any = ..., /) -> int | None
 
       This method allows to set and get the value of the signal, depending on whether
       the argument ``x`` is supplied or not.

docs/library/machine.rst

@@ -71,7 +71,7 @@ Reset related functions
 
    Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values.
 
-.. function:: bootloader(value: int | None = None, /) -> None
+.. function:: bootloader(value: int = ..., /) -> None
 
    Reset the device and enter its bootloader.  This is typically used to put the
    device into a state where it can be programmed with new firmware.
@@ -114,7 +114,7 @@ and then re-enabled to their previous state.  For example::
 Power related functions
 -----------------------
 
-.. function:: freq(hz: int | None = None, /) -> int
+.. function:: freq(hz: int = ..., /) -> int
 
     Returns the CPU frequency in hertz.
 
@@ -137,8 +137,8 @@ Power related functions
 
    .. note:: This function is deprecated, use :func:`lightsleep()` instead with no arguments.
 
-.. function:: lightsleep(time_ms: int | None = None, /) -> None
-              deepsleep(time_ms: int | None = None, /) -> None
+.. function:: lightsleep(time_ms: int = ..., /) -> None
+              deepsleep(time_ms: int = ..., /) -> None
 
    Stops execution in an attempt to enter a low power state.