docs: Add touch_calibrate() for pins 0,1,2, logo.

bbcmicrobit · Sep 16, 2024 · b2a0dc9 · b2a0dc9
1 parent 67fd7c7
commit b2a0dc9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/microbit_micropython_api.rst b/docs/microbit_micropython_api.rst
@@ -158,6 +158,9 @@ Each of these pins are instances of the ``MicroBitPin`` class, which offers the
     # Only available for touch pins 0, 1, and 2. Sets the touch mode.
     # Value can be either RESISTIVE or CAPACITIVE
     pin.set_touch_mode(value)
+    # Only available for touch pins 0, 1, and 2. Re-calibrates the touch pin
+    # detection.
+    pin.touch_calibrate()
 
 Except in the case of the pins marked **V2**, which offers the following API:
 
@@ -172,6 +175,8 @@ pin_logo::
     pin_logo.get_touches()
     # Sets the touch mode. Value can be either RESISTIVE or CAPACITIVE
     pin_logo.set_touch_mode(value)
+    # Re-calibrates the touch pin detection.
+    pin.touch_calibrate()
 
 pin_speaker, as the above ``MicroBitPin`` class, but does not include
 ``pin.is_touched()``.

diff --git a/docs/pin.rst b/docs/pin.rst
@@ -197,6 +197,12 @@ its own to that.
 
 .. py:class:: MicroBitTouchPin
 
+    .. py:method:: touch_calibrate()
+
+        Re-calibrates the touch pin detection.
+        This is useful when a conductive object is connected to the pin to
+        be used as a touch sensor.
+
     .. py:method:: is_touched()
 
         Return ``True`` if the pin is being touched with a finger, otherwise