lib/module: Add Module FAN support.

Signed-off-by: Tinyu-Zhao <[email protected]>

Author: Tinyu-Zhao

docs/en/conf.py

@@ -46,12 +46,20 @@
 ]
 
 autodoc_mock_imports = [
-    "micropython"
+    "micropython",
+    "machine",
+    "M5",
+    "module.mbus",
+    "pid",
+    "driver",
+    "imu"
+
 ]
 
 autodoc_default_options = {
     'members': "",
     'show-inheritance': "",
+    'members-order': 'bysource',
 }
 
 autodoc_typehints = "description"

docs/en/module/fan.rst

@@ -0,0 +1,60 @@
+Fan v1.1 Module
+================
+
+.. sku: M013-V11
+
+.. include:: ../refs/module.fan.ref
+
+This is the driver library of Fan Module, which is used to control the fan.
+
+Support the following products:
+
+    |FAN|
+
+
+UiFlow2 Example
+---------------
+
+control module fan v1.1
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Open the |fan_cores3_example.m5f2| project in UiFlow2.
+
+Initializes the fan module, sets the fan status, PWM frequency and duty cycle, and displays the fan status, speed, PWM frequency and duty cycle on the screen in real time. When the user touches the screen, the fan status toggles on/off.
+
+UiFlow2 Code Block:
+
+    |example.png|
+
+Example output:
+
+    None
+
+MicroPython Example
+-------------------
+
+control module fan v1.1
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Initializes the fan module, sets the fan status, PWM frequency and duty cycle, and displays the fan status, speed, PWM frequency and duty cycle on the screen in real time. When the user touches the screen, the fan status toggles on/off.
+
+MicroPython Code Block:
+
+    .. literalinclude:: ../../../examples/module/fan/fan_cores3_example.py
+        :language: python
+        :linenos:
+
+Example output:
+
+    None
+
+
+**API**
+-------
+
+FanModule
+^^^^^^^^^
+
+.. autoclass:: module.fan.FanModule
+    :members:
+    :member-order: bysource

docs/en/module/index.rst

@@ -9,6 +9,7 @@ Module
     display.rst
     dmx.rst
     dualkmeter.rst
+    fan.rst
     gnss.rst
     gps.rst
     gpsv2.rst

docs/en/refs/module.fan.ref

@@ -0,0 +1,29 @@
+.. |FAN| image:: https://static-cdn.m5stack.com/resource/docs/products/module/fan/fan_01.webp
+    :target: https://docs.m5stack.com/en/module/fan_v11
+    :height: 200px
+    :width: 200px
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/example.png
+.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/init.png
+
+.. |set_fan_state.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/set_fan_state.png
+.. |get_fan_state.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_fan_state.png
+.. |set_pwm_frequency.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/set_pwm_frequency.png
+.. |get_pwm_frequency.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_pwm_frequency.png
+.. |set_pwm_duty_cycle.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/set_pwm_duty_cycle.png
+.. |get_pwm_duty_cycle.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_pwm_duty_cycle.png
+.. |get_fan_rpm.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_fan_rpm.png
+.. |get_single_frequency.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_single_frequency.png
+.. |write_flash.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/write_flash.png
+.. |get_firmware_version.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_firmware_version.png
+.. |get_i2c_address.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/get_i2c_address.png
+.. |set_i2c_address.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/fan_v11/set_i2c_address.png
+
+
+.. |fan_cores3_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/module/fan_v11/fan_cores3_example.m5f2"
+        target="_blank"
+    >
+        fan_cores3_example.m5f2
+    </a>