Skip to content

V2 docs: add set_touch_mode() #701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 8, 2021
Merged

V2 docs: add set_touch_mode() #701

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
396bb2a
V2 docs: add set_touch_mode()
microbit-mark Jan 8, 2021
f4a754c
V2 docs: add set_touch_mode() to micropython API doc
microbit-mark Jan 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
V2 docs: add set_touch_mode() to micropython API doc
  • Loading branch information
@microbit-mark
microbit-mark committed Jan 8, 2021
commit f4a754cc6878f2ae9253bc9537877398403ad51a
8 changes: 7 additions & 1 deletion docs/microbit_micropython_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ Provide digital and analog input and output functionality, for the pins in the
connector, the **V2** logo and the **V2** speaker. Some pins are connected
internally to the I/O that drives the LED matrix and the buttons.

Each pin is provided as an object directly in the ``microbit`` module. This keeps the API relatively flat, making it very easy to use:
Each pin is provided as an object directly in the ``microbit`` module. This
keeps the API relatively flat, making it very easy to use:

* pin0
* pin1
Expand Down Expand Up @@ -144,13 +145,18 @@ Each of these pins are instances of the ``MicroBitPin`` class, which offers the
# Only available for touch pins 0, 1, and 2. Returns boolean if the pin
# is touched
pin.is_touched()
# Only available for touch pins 0, 1, 2 and on micro:bit V2 also the logo.
# Sets the touch mode. Value can be either RESISTIVE or CAPACITIVE
pin.set_touch_mode(value)

Except in the case of the pins marked **V2**, which offers the following API::

pin_logo::

# returns boolean for logo touch pin
pin_logo.is_touched()
# Sets the touch mode. Value can be either RESISTIVE or CAPACITIVE
pin.set_touch_mode(value)

pin_speaker:

Expand Down