Merge branch 'main' into fixed_r4wifi

Author: cristidragomir97

.github/workflows/render-documentation.yml

@@ -21,8 +21,8 @@ jobs:
   render-docs:
     permissions:
       contents: write
-    uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@deps-install-fix
+    uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@main
     with:
       source-path: './src'
       target-path: './docs/api.md'
-      fail-on-warnings: true
+      fail-on-warnings: true

docs/api.md

@@ -0,0 +1,98 @@
+# Summary
+
+ Members                        | Descriptions                                
+--------------------------------|---------------------------------------------
+`class ` [`CapacitiveTouch`](#class_capacitive_touch) | A user-friendly class for capacitive touch sensing.
+
+# class `CapacitiveTouch` <a id="class_capacitive_touch" class="anchor"></a>
+
+A user-friendly class for capacitive touch sensing.
+
+Create an instance with: <br/>[CapacitiveTouch](#class_capacitive_touch) ct = [CapacitiveTouch(LOVE_BUTTON)](#class_capacitive_touch);
+
+## Summary
+
+ Members                        | Descriptions                                
+--------------------------------|---------------------------------------------
+| [`CapacitiveTouch`](#class_capacitive_touch_1ac22af64579b04c74118d037b1a8715f2) | Constructs a capacitive touch sensor for the given pin. |
+| [`begin`](#class_capacitive_touch_1a0cce24fac4a98cecf7840ebf435a5d9c) | Initializes the sensor. |
+| [`read`](#class_capacitive_touch_1a5c7b56cc0ad47963fa0b97abe2909aba) | Reads the raw sensor value. |
+| [`isTouched`](#class_capacitive_touch_1aab0faf01526c57e1f0f57aa19919d9fa) | Checks if the sensor is touched. |
+| [`setThreshold`](#class_capacitive_touch_1a5f773cd9472164c698811962070f903c) | Sets the detection threshold. |
+| [`getThreshold`](#class_capacitive_touch_1a64a1533e5ea3109c2ff15a3abf22bbba) | Retrieves the current detection threshold. |
+
+## Members
+
+### `CapacitiveTouch` <a id="class_capacitive_touch_1ac22af64579b04c74118d037b1a8715f2" class="anchor"></a>
+
+```cpp
+CapacitiveTouch(uint8_t pin)
+```
+
+Constructs a capacitive touch sensor for the given pin.
+
+#### Parameters
+* `pin` The Arduino pin number (such as LOVE_BUTTON).
+<hr />
+
+### `begin` <a id="class_capacitive_touch_1a0cce24fac4a98cecf7840ebf435a5d9c" class="anchor"></a>
+
+```cpp
+void begin()
+```
+
+Initializes the sensor.
+
+Configures the pin and initializes the CTSU/DTC hardware.
+<hr />
+
+### `read` <a id="class_capacitive_touch_1a5c7b56cc0ad47963fa0b97abe2909aba" class="anchor"></a>
+
+```cpp
+int read()
+```
+
+Reads the raw sensor value.
+
+Initiates a measurement cycle and returns the raw value. 
+#### Returns
+int The raw sensor value.
+<hr />
+
+### `isTouched` <a id="class_capacitive_touch_1aab0faf01526c57e1f0f57aa19919d9fa" class="anchor"></a>
+
+```cpp
+bool isTouched()
+```
+
+Checks if the sensor is touched.
+
+Compares the raw value to the set threshold. 
+#### Returns
+true if the sensor is touched, false otherwise.
+<hr />
+
+### `setThreshold` <a id="class_capacitive_touch_1a5f773cd9472164c698811962070f903c" class="anchor"></a>
+
+```cpp
+void setThreshold(int threshold)
+```
+
+Sets the detection threshold.
+
+#### Parameters
+* `threshold` The new threshold value.
+<hr />
+
+### `getThreshold` <a id="class_capacitive_touch_1a64a1533e5ea3109c2ff15a3abf22bbba" class="anchor"></a>
+
+```cpp
+int getThreshold()
+```
+
+Retrieves the current detection threshold.
+
+#### Returns
+int The current threshold value.
+<hr />
+

src/CapacitiveTouch.h

@@ -14,6 +14,7 @@
 
 // Define a symbolic constant for the LOVE button (special pin).
 #define LOVE_BUTTON   20  
+
 /**
  * @struct CapTouchPinMapping
  * @brief Defines the mapping between an Arduino pin and its capacitive touch hardware settings.
@@ -29,6 +30,8 @@ struct CapTouchPinMapping {
     uint8_t chac_val;     ///< Bit mask used to enable the sensor channel.
 };
 
+/// @endcond
+
 #if defined(ARDUINO_UNOR4_MINIMA)
 static const CapTouchPinMapping capTouchMappings[] = {
   {0,  true,  9,  1, (1 << 1)},