aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/digitalread.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/arduino/digitalread.rst')
-rw-r--r--docs/source/arduino/digitalread.rst76
1 files changed, 24 insertions, 52 deletions
diff --git a/docs/source/arduino/digitalread.rst b/docs/source/arduino/digitalread.rst
index ec64fb0..86e52d8 100644
--- a/docs/source/arduino/digitalread.rst
+++ b/docs/source/arduino/digitalread.rst
@@ -1,3 +1,5 @@
+.. highlight:: cpp
+
.. _arduino-digitalread:
digitalRead()
@@ -6,81 +8,51 @@ digitalRead()
Description
-----------
-Reads the value from a specified digital pin, either
-`HIGH <http://arduino.cc/en/Reference/Constants>`_ or
-`LOW <http://arduino.cc/en/Reference/Constants>`_.
-
-
-
-Syntax
-------
-
-digitalRead(pin)
+Reads the value from a specified digital pin, either :ref:`HIGH
+<arduino-constants-high>` or :ref:`LOW <arduino-constants-low>`.
+Library Documentation
+---------------------
-Parameters
-----------
-
-pin: the number of the digital pin you want to read (*int*)
-
-
-
-Returns
--------
-
-`HIGH <http://arduino.cc/en/Reference/Constants>`_ or
-`LOW <http://arduino.cc/en/Reference/Constants>`_
-
+.. doxygenfunction:: digitalRead
Example
-------
-::
+The following example turns the LED on when the button is pressed::
-
- int ledPin = 13; // LED connected to digital pin 13
- int inPin = 7; // pushbutton connected to digital pin 7
- int val = 0; // variable to store the read value
+ int ledPin = 13; // LED connected to Maple pin 13
+ int buttonPin = 38; // BUT connected to Maple pin 38
- void setup()
- {
- pinMode(ledPin, OUTPUT); // sets the digital pin 13 as output
- pinMode(inPin, INPUT); // sets the digital pin 7 as input
+ void setup() {
+ pinMode(ledPin, OUTPUT);
+ pinMode(buttonPin, INPUT);
}
- void loop()
- {
- val = digitalRead(inPin); // read the input pin
- digitalWrite(ledPin, val); // sets the LED to the button's value
+ void loop() {
+ int val = digitalRead(buttonPin); // reads the input pin
+ digitalWrite(ledPin, val);
}
-
-
-Sets pin 13 to the same value as the pin 7, which is an input.
-
-
-
Note
----
-If the pin isn't connected to anything, digitalRead() can return
-either HIGH or LOW (and this can change randomly).
-
-
+If the pin isn't connected to anything, ``digitalRead()`` can return
+either HIGH or LOW (and this can change in a way that seems random).
-The analog input pins can be used as digital pins, referred to as
-A0, A1, etc.
+Arduino Compatibility
+---------------------
+The Maple version of ``digitalRead()`` is compatible with Arduino.
-See also
+See Also
--------
+- :ref:`pinMode <arduino-pinMode>`
+- :ref:`digitalWrite <arduino-digitalWrite>`
-- `pinMode <http://arduino.cc/en/Reference/PinMode>`_\ ()
-- `digitalWrite <http://arduino.cc/en/Reference/DigitalWrite>`_\ ()
-- `Tutorial: Digital Pins <http://arduino.cc/en/Tutorial/DigitalPins>`_