Skip to content

Commit b74cbb8

Browse files
authored
Merge pull request #516 from per1234/specify-arduino-pin
Emphasize that IO functions take Arduino pin numbers
2 parents f639ee2 + c11cb67 commit b74cbb8

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

Language/Functions/Advanced IO/noTone.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Stops the generation of a square wave triggered by `tone()`. Has no effect if no
2727

2828
[float]
2929
=== Parameters
30-
`pin`: the pin on which to stop generating the tone
30+
`pin`: the Arduino pin on which to stop generating the tone
3131

3232
[float]
3333
=== Returns

Language/Functions/Advanced IO/pulseIn.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The timing of this function has been determined empirically and will probably sh
3131

3232
[float]
3333
=== Parameters
34-
`pin`: the number of the pin on which you want to read the pulse. Allowed data types: `int`. +
34+
`pin`: the number of the Arduino pin on which you want to read the pulse. Allowed data types: `int`. +
3535
`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. Allowed data types: `int`. +
3636
`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second. Allowed data types: `unsigned long`.
3737

Language/Functions/Advanced IO/pulseInLong.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The timing of this function has been determined empirically and will probably sh
3333

3434
[float]
3535
=== Parameters
36-
`pin`: the number of the pin on which you want to read the pulse. Allowed data types: `int`. +
36+
`pin`: the number of the Arduino pin on which you want to read the pulse. Allowed data types: `int`. +
3737
`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. Allowed data types: `int`. +
3838
`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second. Allowed data types: `unsigned long`.
3939

Language/Functions/Advanced IO/tone.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ It is not possible to generate tones lower than 31Hz. For technical details, see
3535

3636
[float]
3737
=== Parameters
38-
`pin`: the pin on which to generate the tone. +
38+
`pin`: the Arduino pin on which to generate the tone. +
3939
`frequency`: the frequency of the tone in hertz. Allowed data types: `unsigned int`. +
4040
`duration`: the duration of the tone in milliseconds (optional). Allowed data types: `unsigned long`.
4141

Language/Functions/Analog IO/analogWrite.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `analogWrite` function has nothing to do with the analog pins or the `analog
3333

3434
[float]
3535
=== Parameters
36-
`pin`: the pin to write to. Allowed data types: `int`. +
36+
`pin`: the Arduino pin to write to. Allowed data types: `int`. +
3737
`value`: the duty cycle: between 0 (always off) and 255 (always on). Allowed data types: `int`.
3838

3939

Language/Functions/Digital IO/digitalRead.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Reads the value from a specified digital pin, either `HIGH` or `LOW`.
2828

2929
[float]
3030
=== Parameters
31-
`pin`: the number of the digital pin you want to read
31+
`pin`: the Arduino pin number you want to read
3232

3333

3434
[float]

Language/Functions/Digital IO/digitalWrite.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you do not set the `pinMode()` to `OUTPUT`, and connect an LED to a pin, when
3535

3636
[float]
3737
=== Parameters
38-
`pin`: the pin number. +
38+
`pin`: the Arduino pin number. +
3939
`value`: `HIGH` or `LOW`.
4040

4141

Language/Functions/Digital IO/pinMode.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ As of Arduino 1.0.1, it is possible to enable the internal pullup resistors with
3030

3131
[float]
3232
=== Parameters
33-
`pin`: the number of the pin whose mode you wish to set. +
33+
`pin`: the Arduino pin number to set the mode of. +
3434
`mode`: `INPUT`, `OUTPUT`, or `INPUT_PULLUP`. See the http://arduino.cc/en/Tutorial/DigitalPins[Digital Pins] page for a more complete description of the functionality.
3535

3636

Language/Functions/External Interrupts/attachInterrupt.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ For more information on interrupts, see http://gammon.com.au/interrupts[Nick Gam
6565
[float]
6666
=== Parameters
6767
`interrupt`: the number of the interrupt. Allowed data types: `int`. +
68-
`pin`: the pin number. +
68+
`pin`: the Arduino pin number. +
6969
`ISR`: the ISR to call when the interrupt occurs; this function must take no parameters and return nothing. This function is sometimes referred to as an interrupt service routine. +
7070
`mode`: defines when the interrupt should be triggered. Four constants are predefined as valid values: +
7171

Language/Functions/External Interrupts/detachInterrupt.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Turns off the given interrupt.
3131
[float]
3232
=== Parameters
3333
`interrupt`: the number of the interrupt to disable (see link:../attachinterrupt[attachInterrupt()] for more details). +
34-
`pin`: the pin number of the interrupt to disable
34+
`pin`: the Arduino pin number of the interrupt to disable
3535

3636

3737
[float]

0 commit comments

Comments
 (0)