Skip to content

Commit a7c1b52

Browse files
docs: Move resistive/capacitive description to set_touch_mode().
1 parent 828de9a commit a7c1b52

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

docs/pin.rst

+11-15
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,20 @@ its own to that.
202202
Return ``True`` if the pin is being touched with a finger, otherwise
203203
return ``False``.
204204

205+
.. py:method:: was_touched()
206+
207+
Returns ``True`` or ``False`` to indicate if the pin was touched
208+
since the device started or since the last time this method was called.
209+
210+
.. py:method:: set_touch_mode(value)
211+
205212
.. note::
206-
The default touch mode for the pins on the edge connector is
213+
The default touch mode for the pins on the edge connector is
207214
`resistive`. The default for the logo pin **V2** is `capacitive`.
208215

216+
Set the touch mode for the given pin. Value can be either ``CAPACITIVE``
217+
or ``RESISTIVE``. For example, ``pin0.set_touch_mode(pin0.CAPACITIVE)``.
218+
209219
**Resistive touch**
210220
This test is done by measuring how much resistance there is between the
211221
pin and ground. A low resistance gives a reading of ``True``. To get
@@ -217,20 +227,6 @@ its own to that.
217227
using a finger as a conductor. `Capacitive touch
218228
<https://www.allaboutcircuits.com/technical-articles/introduction-to-capacitive-touch-sensing>`_
219229
does not require you to make a ground connection as part of a circuit.
220-
221-
.. py:method:: was_touched()
222-
223-
Returns ``True`` or ``False`` to indicate if the pin was touched
224-
since the device started or since the last time this method was called.
225-
226-
.. py:method:: set_touch_mode(value)
227-
228-
.. note::
229-
The default touch mode for the pins on the edge connector is
230-
`resistive`. The default for the logo pin **V2** is `capacitive`.
231-
232-
Set the touch mode for the given pin. Value can be either ``CAPACITIVE``
233-
or ``RESISTIVE``. For example, ``pin0.set_touch_mode(pin0.CAPACITIVE)``.
234230

235231
The pull mode for a pin is automatically configured when the pin changes to an
236232
input mode. Input modes are when you call ``read_analog`` / ``read_digital`` /

0 commit comments

Comments
 (0)