diff --git a/docs/reference/pins/on-pulsed.md b/docs/reference/pins/on-pulsed.md new file mode 100644 index 00000000..d33a23fe --- /dev/null +++ b/docs/reference/pins/on-pulsed.md @@ -0,0 +1,31 @@ +# On Pulsed + +Configure the specified pin for digital input, and then +execute the associated code block whenever the pin +pulses **High** or **Low** (as specified). + +```sig +pins.onPulsed(DigitalPin.P0, PulseValue.High, () => { }); +``` + +### Parameters + +* ``pin``: The micro:bit hardware pin to configure (``P0`` through ``P20``) +* ``pulsed``: Which state will cause the associated block to execute (**High** or **Low**) + +### Example + +The following example configures pin ``P2`` for digital input, +and then displays the string `LOW` whenever ``P2`` pulses low. + +```blocks +pins.onPulsed(DigitalPin.P2, PulseValue.Low, () => { + basic.showString("LOW"); +}); +``` + +### See also + +[servo set pulse](/reference/pins/servo-set-pulse), +[pulse duration](/reference/pins/pulse-duration), +[digital read pin](/reference/pins/digital-read-pin)