pxt-calliope/docs/reference/input/on-pin-pressed.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# On Pin Pressed
2016-07-16 01:43:26 +02:00
Start an [event handler](/reference/event-handler) (part of the
program that will run when something happens, like when a button is
pressed). This handler works when you touch pin `0`, `1`, or `2`
together with `GND`, and release it within 1 second.
When you are using this function in a web
2016-11-02 01:44:37 +01:00
browser, click the pins on the screen instead of the ones on the
@boardname@.
2016-07-16 01:43:26 +02:00
If you hold the `GND` pin with one hand and touch pin `0`, `1`, or `2`
with the other, a very small (safe) amount of electricity will flow
2016-11-02 01:44:37 +01:00
through your body and back into the @boardname@. This is called
2016-07-16 01:43:26 +02:00
**completing a circuit**. It's like you're a big wire!
2016-03-26 00:47:20 +01:00
```sig
2020-02-20 04:01:37 +01:00
input.onPinEvent(TouchPin.P0, Button.Click, () => {
2016-03-26 00:47:20 +01:00
})
```
## ~hint
This function works best when the @boardname@ is using batteries for power,
instead of the USB cable.
## ~
2016-07-16 01:43:26 +02:00
## Parameters
* ``name`` means the pin that is being pressed, either `P0`, `P1`, or `P2`
## Pin presses in action
See how the @boardname@ detects a press at a pin or on something connected to a pin in this video:
https://www.youtube.com/watch?v=GEpZrvbsO7o
## Example: pin pressed counter
2016-03-26 00:47:20 +01:00
This program counts how many times you press the `P0` pin.
Every time you press the pin, the program shows the number of times on the screen.
2016-03-26 00:47:20 +01:00
```blocks
let count = 0
basic.showNumber(count)
2020-02-20 04:01:37 +01:00
input.onPinEvent(TouchPin.P0, Button.Click, () => {
2016-03-26 00:47:20 +01:00
count = count + 1
basic.showNumber(count)
2016-03-26 00:47:20 +01:00
})
```
## See also
2016-03-26 00:47:20 +01:00
[@boardname@ pins](/device/pins), [pin is pressed](/reference/input/pin-is-pressed), [analog read pin](/reference/pins/analog-read-pin), [analog write pin](/reference/pins/analog-write-pin), [digital read pin](/reference/pins/digital-read-pin), [digital write pin](/reference/pins/digital-write-pin)
2016-03-26 00:47:20 +01:00