pxt-calliope/docs/reference/input/pin-is-pressed.md
Peli de Halleux 7da483f258 fixing links
2016-04-18 09:47:34 -07:00

37 lines
1.1 KiB
Markdown

# Pin Is Pressed
Gets the pin state (pressed or not pressed), by detecting when the user holds the `GND` pin with one hand, and presses pin `0`, `1`, or `2` with the other hand, thus completing a circuit.
*Note* that this function works best when the BBC micro:bit is powered by AAA battery.
```sig
input.pinIsPressed(TouchPin.P0);
```
### Parameters
* name - [String](/reference/types/string); the pin name ("P0", "P1", or "P2")
### returns
* [Boolean](/reference/types/boolean) - `true` if pressed, `false` if not pressed
### Example
This example displays 1 if P0 is pressed, and 0 if P0 is not pressed:
```blocks
basic.forever(() => {
if (input.pinIsPressed(TouchPin.P0)) {
basic.showNumber(1, 150)
} else {
basic.showNumber(0, 150)
}
})
```
### See also
[BBC micro:bit pins](/device/pins), [on pin pressed](/reference/input/on-pin-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)