aboutsummaryrefslogtreecommitdiffstats
path: root/source/arduino/digitalread.rst
blob: ec64fb09016465d2eda016a0744da0d86de9e5bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.. _arduino-digitalread:

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)



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>`_



Example
-------

::

     
    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
    
    void setup()
    {
      pinMode(ledPin, OUTPUT);      // sets the digital pin 13 as output
      pinMode(inPin, INPUT);      // sets the digital pin 7 as input
    }
    
    void loop()
    {
      val = digitalRead(inPin);   // read the input pin
      digitalWrite(ledPin, val);    // sets the LED to the button's value
    }



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).



The analog input pins can be used as digital pins, referred to as
A0, A1, etc.



See also
--------


-  `pinMode <http://arduino.cc/en/Reference/PinMode>`_\ ()
-  `digitalWrite <http://arduino.cc/en/Reference/DigitalWrite>`_\ ()
-  `Tutorial: Digital Pins <http://arduino.cc/en/Tutorial/DigitalPins>`_