docs: Add changes for v4.7.0.

kwagyeman · kwagyeman · commit 093b0c9cab41 · 2025-06-01T20:08:37.000-07:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -79,7 +79,7 @@
 #
 # We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"
 # breakdown, so use the same version identifier for both to avoid confusion.
-version = release = '1.24'
+version = release = '1.25'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -153,6 +153,7 @@
                     "rp2/quickref.rst",
                     "rp2/tutorial/intro.rst",
                     "rp2/tutorial/pio.rst",
+                    "rp2/tutorial/reset.rst",
                     "samd/general.rst",
                     "samd/quickref.rst",
                     "samd/pinout.rst",
diff --git a/docs/library/network.LAN.rst b/docs/library/network.LAN.rst
@@ -37,13 +37,6 @@ Constructors
        or ``True``, the clock is driven by the Ethernet controller, if set to ``LAN.IN``
        or ``Pin.IN`` or ``False``, the clock is driven by the PHY interface.
 
-   For example, with the Seeed Arch Mix board you can  use::
-
-     nic = LAN(0, phy_type=LAN.PHY_LAN8720, phy_addr=1, ref_clk_mode=Pin.IN)
-
-   .. note:: On esp32 port the constructor requires different arguments. See
-             :ref:`esp32 port reference <esp32_network_lan>`.
-
 Methods
 -------
 
diff --git a/docs/library/omv.ml.postprocessing.rst b/docs/library/omv.ml.postprocessing.rst
@@ -28,6 +28,26 @@ Constructors
     E.g. ``[[((x, y, w, h), score)]]``. Note that empty class list are included in the output to ensure the position
     of each class list in the output matches the position of the class index in the model output.
 
+class yolo_lc_postprocess -- YOLO LC
+------------------------------------
+
+Used to post-process YOLO LC model output.
+
+Constructors
+~~~~~~~~~~~~
+
+.. class:: yolo_lc_postprocess(threshold:float=0.6, anchors:List[Tuple[float, float]]=None, nms_threshold:float=0.1, nms_sigma:float=0.1) -> yolo_lc_postprocess
+
+    Create a YOLO LC postprocessor.
+
+    ``threshold`` The threshold to use for postprocessing.
+
+    ``anchors`` A list of anchor points ``(x, y)`` the model was trained on  to use for postprocessing.
+
+    This post-processor returns a list of rect ``[x, y, w, h]`` and score tuples for each class in the model output.
+    E.g. ``[[((x, y, w, h), score)]]``. Note that empty class list are included in the output to ensure the position
+    of each class list in the output matches the position of the class index in the model output.
+
 class yolo_v2_postprocess -- YOLO V2
 ------------------------------------
 
@@ -65,3 +85,21 @@ Constructors
     This post-processor returns a list of rect ``[x, y, w, h]`` and score tuples for each class in the model output.
     E.g. ``[[((x, y, w, h), score)]]``. Note that empty class list are included in the output to ensure the position
     of each class list in the output matches the position of the class index in the model output.
+
+class yolo_v8_postprocess -- YOLO V8
+------------------------------------
+
+Used to post-process YOLO V8 model output.
+
+Constructors
+~~~~~~~~~~~~
+
+.. class:: yolo_v8_postprocess(threshold:float=0.6, nms_threshold:float=0.1, nms_sigma:float=0.1) -> yolo_v8_postprocess
+
+    Create a YOLO V8 postprocessor.
+
+    ``threshold`` The threshold to use for postprocessing.
+
+    This post-processor returns a list of rect ``[x, y, w, h]`` and score tuples for each class in the model output.
+    E.g. ``[[((x, y, w, h), score)]]``. Note that empty class list are included in the output to ensure the position
+    of each class list in the output matches the position of the class index in the model output.
diff --git a/docs/library/omv.rpc.rst b/docs/library/omv.rpc.rst
@@ -392,45 +392,3 @@ Be controlled by another ``rpc`` device over Async Serial (UART).
 
    NOTE: Master and slave baud rates must match. Connect master tx to slave rx and master rx to
    slave tx. Finally, both devices must share a common ground.
-
-class rpc_usb_vcp_master - USB VCP Master Interface
----------------------------------------------------
-
-Control another ``rpc`` device over a USB Virtual COM Port.
-
-.. class:: rpc_usb_vcp_master()
-
-   Creates a USB VCP ``rpc`` master. This interface can move data at the USB speed.
-
-class rpc_usb_vcp_slave - USB VCP Slave Interface
--------------------------------------------------
-
-Be controlled by another ``rpc`` device over a USB Virtual COM Port.
-
-.. class:: rpc_usb_vcp_slave()
-
-   Creates a USB VCP ``rpc`` slave. This interface can move data at the USB speed.
-
-class rpc_network_master - Network Master Interface
----------------------------------------------------
-
-Control another ``rpc`` device over a network.
-
-.. class:: rpc_network_master(network_if, port=0x1DBA)
-
-   Creates a Network ``rpc`` master.
-
-   * network_if - Network interface created from ``network.LAN()``, ``network.WLAN()``, or etc.
-   * port - Port to route traffic to.
-
-class rpc_network_slave - Network Slave Interface
----------------------------------------------------
-
-Be controlled by another ``rpc`` device a network.
-
-.. class:: rpc_network_slave(network_if, port=0x1DBA)
-
-   Creates a Network ``rpc`` slave.
-
-   * network_if - Network interface created from ``network.LAN()``, ``network.WLAN()``, or etc.
-   * port - Port to route traffic to.
diff --git a/docs/library/omv.sensor.rst b/docs/library/omv.sensor.rst
@@ -573,6 +573,7 @@ Functions
    * `sensor.IOCTL_RGB_STATS` - Pass this enum to get the RGB statistics from the camera sensor. Returns a tuple of (r, gb, gr, b) values.
    * `sensor.IOCTL_GENX320_SET_BIASES` - Pass this enum followed by a bias enum to set the GENX320 sensor biases.
    * `sensor.IOCTL_GENX320_SET_BIAS` - Pass this enum followed by a bias enum and a bias value to set the GENX320 sensor bias.
+   * `sensor.IOCTL_GENX320_SET_AFK` - Pass this enum followed by ``enable``, ``freq_low_in_hz``, ``freq_high_in_hz`` to change the GENX320 anti-flickering-filter settings.
 
 .. function:: set_color_palette(palette:int) -> None
 
@@ -1118,6 +1119,11 @@ Constants
 
    Lets you set the GENX320 camera sensor biases. See `sensor.ioctl()` for more information.
 
+.. data:: IOCTL_GENX320_SET_AFK
+   :type: int
+
+   Lets you set the GENX320 camera sensor anti-flickering-filter. See `sensor.ioctl()` for more information.
+
 .. data:: GENX320_BIASES_DEFAULT
    :type: int
 
diff --git a/docs/library/omv.tof.rst b/docs/library/omv.tof.rst
@@ -36,7 +36,7 @@ Functions
    ``type`` indicates the type of thermopile shield:
 
       * `tof.TOF_NONE`: 0 pixels.
-      * `tof.TOF_VL53L5CX`: 8x8 pixels.
+      * `tof.TOF_VL53LX`: 8x8 pixels.
 
    By default type is ``-1`` which will cause `tof.init()` to automatically scan and initialize an
    attached thermal sensor based on the I2C address.
@@ -48,7 +48,7 @@ Functions
    ``type`` indicates the type of thermopile shield:
 
       * `tof.TOF_NONE`: 0 pixels.
-      * `tof.TOF_VL53L5CX`: 8x8 pixels.
+      * `tof.TOF_VL53LX`: 8x8 pixels.
 
    By default type is ``-1`` which will cause `tof.init()` to automatically scan and initialize an
    attached thermal sensor based on the I2C address.
@@ -62,28 +62,28 @@ Functions
    Returns the width (horizontal resolution) of the depth sensor in-use:
 
       * `tof.TOF_NONE`: 0 pixels.
-      * `tof.TOF_VL53L5CX`: 8 pixels.
+      * `tof.TOF_VL53LX`: 8 pixels.
 
 .. function:: height() -> int
 
    Returns the height (vertical resolution) of the depth sensor in-use:
 
       * `tof.TOF_NONE`: 0 pixels.
-      * `tof.TOF_VL53L5CX`: 8 pixels.
+      * `tof.TOF_VL53LX`: 8 pixels.
 
 .. function:: type() -> int
 
    Returns the type of the depth sensor in-use:
 
       * `tof.TOF_NONE`
-      * `tof.TOF_VL53L5CX`
+      * `tof.TOF_VL53LX`
 
 .. function:: refresh() -> int
 
    Returns the refresh rate of the depth sensor in-use:
 
       * `tof.TOF_NONE`: 0 Hz.
-      * `tof.TOF_VL53L5CX`: 15 Hz.
+      * `tof.TOF_VL53LX`: 15 Hz.
 
 .. function:: read_depth(hmirror:bool=False, vflip:bool=False, transpose:bool=False, timeout:int=-1)
 
@@ -266,7 +266,7 @@ Constants
 
    No TOF sensor type.
 
-.. data:: TOF_VL53L5CX
+.. data:: TOF_VL53LX
    :type: int
 
-   VL53L5CX TOF sensor.
+   VL53L5CX or VL53L8CX TOF sensor.
diff --git a/docs/openmvcam/general.rst b/docs/openmvcam/general.rst
@@ -6,16 +6,23 @@ General information about the openmvcam
 Local filesystem and SD card
 ----------------------------
 
-There is a small internal filesystem (a drive) on the openmvcam which is stored
-within the microcontroller's flash memory.
+There is a small internal filesystem (a drive) on the openmvcam, called ``/flash``,
+which is stored within the microcontroller's flash memory.  If a micro SD card
+is inserted into the slot, it is available as ``/sdcard``.
 
 When the openmvcam boots up, it needs to choose a filesystem to boot from.  If
-there is no SD card, then it uses the internal filesystem as the boot
-filesystem, otherwise, it uses the SD card.  After the boot, the current
-directory is set to ``/``.
+there is no SD card, then it uses the internal filesystem ``/flash`` as the boot
+filesystem, otherwise, it uses the SD card ``/sdcard``. After the boot, the current
+directory is set to one of the directories above.
+
+If needed, you can prevent the use of the SD card by creating an empty file
+called ``/flash/SKIPSD``.  If this file exists when the openmvcam boots
+up then the SD card will be skipped and the openmvcam will always boot from the
+internal filesystem (in this case the SD card won't be mounted but you can still
+mount and use it later in your program using ``vfs.mount``).
 
 The boot filesystem is used for 2 things: it is the filesystem from which
-``boot.py`` and ``main.py`` files are searched for, and it is the filesystem
+the ``boot.py`` and ``main.py`` files are searched for, and it is the filesystem
 which is made available on your PC over the USB cable.
 
 The filesystem will be available as a USB flash drive on your PC.  You can
@@ -26,18 +33,7 @@ pyboard.*
 
 .. note::
 
-   The above behavior is different from the pyboard which allows access to the
-   internal file system and SD card at the same time within a script by creating
-   a virtual file system with multiple drives for the internal flash and SD
-   card.  The OpenMV Cam's behavior is different because modern operating systems
-   do not mount the OpenMV Cam's internal flash drive and/or SD Card as a
-   virtual file system but instead as a block device... meaning that modern
-   operating systems do not see a pyboard's file system the same way as the
-   pyboard sees it.  To avoid this situation we only allow one file system at a
-   time to keep the operating system the OpenMV Cam is attached to and what the
-   OpenMV Cam thinks its file system looks like in sync.
-
-   That said, there is another complication.  Because modern operating systems
+   Because modern operating systems
    mount the OpenMV Cam's internal flash drive or SD card as a block device they
    treat it as if it cannot create files itself.  Because of this if you create
    a file onboard your OpenMV Cam in code you must remount the OpenMV Cam after
diff --git a/docs/openmvcam/pinout-openmv-ae3-pag7936.png b/docs/openmvcam/pinout-openmv-ae3-pag7936.png
diff --git a/docs/openmvcam/pinout-openmv-n6-pag7936.png b/docs/openmvcam/pinout-openmv-n6-pag7936.png
diff --git a/docs/openmvcam/quickref.rst b/docs/openmvcam/quickref.rst
@@ -12,6 +12,14 @@ the OpenMV Cam please consider reading the following sections first:
    general.rst
    tutorial/index.rst
 
+.. image:: pinout-openmv-n6-pag7936.png
+    :alt: OpenMV N6 PAG7936 Pinout
+    :width: 700px
+
+.. image:: pinout-openmv-ae3-pag7936.png
+    :alt: OpenMV AE3 PAG7936 Pinout
+    :width: 700px
+
 .. image:: pinout-openmv-cam-rt1062-ov5640.png
     :alt: OpenMV Cam RT1062 OV5640 Pinout
     :width: 700px
diff --git a/docs/openmvcam/tutorial/io_tutorial.rst b/docs/openmvcam/tutorial/io_tutorial.rst
@@ -8,6 +8,18 @@ can create a system that's able to "sense", "plan", and "act" in one package.
 
 First, let's take a look at your OpenMV Cam's pinout below:
 
+.. image:: ../pinout-openmv-n6-pag7936.png
+    :alt: OpenMV N6 PAG7936 Pinout
+    :width: 700px
+
+.. image:: ../pinout-openmv-ae3-pag7936.png
+    :alt: OpenMV AE3 PAG7936 Pinout
+    :width: 700px
+
+.. image:: ../pinout-openmv-cam-rt1062-ov5640.png
+    :alt: OpenMV Cam RT1062 OV5640 Pinout
+    :width: 700px
+
 .. image:: ../pinout-openmv-cam-h7-plus-ov5640.png
     :alt: OpenMV Cam H7 Plus OV5640 Pinout
     :width: 700px
diff --git a/docs/openmvcam/tutorial/openmvide_overview.rst b/docs/openmvcam/tutorial/openmvide_overview.rst
@@ -140,6 +140,11 @@ looking for errors. When OpenMV IDE detects and error it will automatically
 open the file in error and highlight the line in error along with displaying
 a nice error message box. This feature saves you tons of time fixing errors.
 
+.. note::
+
+   The serial terminal in the IDE shows text output from the OpenMV Cam.
+   It does not allow you to send data to the OpenMV Cam.
+
 Anyway, if you want to stop the script just click on the stop button which will
 replace the run button while a script is running. Note that scripts can
 automatically stop by themselves either due to finishing or a compile error. In
diff --git a/docs/openmvcam/tutorial/production.rst b/docs/openmvcam/tutorial/production.rst
@@ -50,6 +50,13 @@ be looked at before running your code. That said, your script can still determin
 is attached or not and read/write files. So, if you still want to be able to execute generic
 scripts from the flash and/or sd card you can do so.
 
+.. note::
+
+   Only the a frozn ``boot.py`` and ``main.py`` will override MicroPython's default search paths. For
+   any imported scripts/modules a matching script/module will override any other scripts/modules
+   frozen in the firmware. This allows you to quickly test changes in scripts/modules without having
+   to deploy a new firmware. To disable this behavior clean the ``sys`` module search path.   
+
 How to protect your code
 ------------------------
 
@@ -58,5 +65,3 @@ dump your OpenMV Cam's program flash (or if you code in a back door vulnerabilit
 feature ways for developers to protect their application from being read using debugging tools.
 Right now, OpenMV does not offer a generic way for you to do this. We leave this up to you. However,
 rest assured. If you really need to prevent anyone from seeing your scripts it's absolutely possible.
-
-
diff --git a/docs/reference/reset_boot.rst b/docs/reference/reset_boot.rst
@@ -63,10 +63,6 @@ Some system state remains the same after a soft reset, including:
 - An active :doc:`REPL <repl>` appears continuous before and after soft reset,
   except in some unusual cases:
 
-  * If the :ref:`machine.USBDevice <machine.USBDevice>` class has been used to
-    create a custom USB interface then any built-in USB serial device will
-    appear to disconnect and reconnect as the custom USB interface must be
-    cleared during reset.
   * A serial UART REPL will restore its default hardware configuration (baud
     rate, etc).
 
@@ -116,8 +112,7 @@ that it's always available after reset for use with the :doc:`REPL <repl>`,
 .. warning:: boot.py should always exit and not run indefinitely.
 
    Depending on the port, some hardware initialisation is delayed until after
-   ``boot.py`` exits. This includes initialising USB on the stm32 port and all
-   ports which support :ref:`machine.USBDevice <machine.USBDevice>`. On these
+   ``boot.py`` exits. This includes initialising USB on the stm32 port. On these
    ports, output printed from ``boot.py`` may not be visible on the built-in USB
    serial port until after ``boot.py`` finishes running.
 
@@ -229,34 +224,3 @@ To confirm which files are still present in the internal filesystem::
     import os
     os.listdir()
 
-Safe Mode and Factory Reset
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you're unable to easily access the REPL then you may need to perform one of
-two processes:
-
-1. "Safe mode" boot, which skips ``boot.py`` and ``main.py`` and immediately
-   starts a REPL, allowing you to clean up. This is only supported on some ports.
-2. Factory Reset to erase the entire contents of the flash filesystem. This may
-   also be necessary if the internal flash filesystem has become corrupted
-   somehow.
-
-The specific process(es) are different on each port:
-
-- :doc:`pyboard and stm32 port instructions </pyboard/tutorial/reset>`
-- :doc:`esp32 port instructions </esp32/tutorial/reset>`
-- :doc:`renesas-ra port instructions </renesas-ra/tutorial/reset>`
-- :doc:`rp2 port instructions </rp2/tutorial/reset>`
-- :doc:`wipy port instructions </wipy/tutorial/reset>`
-
-For ports without specific instructions linked above, the factory reset process
-involves erasing the board's entire flash and then flashing MicroPython again
-from scratch. Usually this will involve the same tool(s) that were originally
-used to install MicroPython. Consult the installation docs for your board, or
-ask on the `GitHub Discussions`_ if you're not sure.
-
-.. warning:: Re-flashing the MicroPython firmware without erasing the entire
-             flash first will usually not recover from soft bricking, as a
-             firmware update usually preserves the contents of the filesystem.
-
-.. _GitHub Discussions: https://github.com/orgs/micropython/discussions
diff --git a/docs/reference/speed_python.rst b/docs/reference/speed_python.rst
@@ -135,7 +135,7 @@ of buffer and pass it to ``readinto()``.
 Strings vs Bytes
 ~~~~~~~~~~~~~~~~
 
-MicroPython uses :ref:`string interning <qstr>` to save space when there are
+MicroPython uses :ref:``string interning <qstr>`` to save space when there are
 multiple identical strings. Each time a new string is allocated at runtime (for
 example, when two other strings are concatenated), MicroPython checks whether
 the new string can be interned to save RAM.
