Skip to content

Emphasize that IO functions take Arduino pin numbers #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 1, 2019
Merged

Emphasize that IO functions take Arduino pin numbers #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Language/Functions/Advanced IO/noTone.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Stops the generation of a square wave triggered by `tone()`. Has no effect if no

[float]
=== Parameters
`pin`: the pin on which to stop generating the tone
`pin`: the Arduino pin on which to stop generating the tone

[float]
=== Returns
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Advanced IO/pulseIn.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The timing of this function has been determined empirically and will probably sh

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

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Advanced IO/pulseInLong.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The timing of this function has been determined empirically and will probably sh

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

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Advanced IO/tone.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ It is not possible to generate tones lower than 31Hz. For technical details, see

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

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Analog IO/analogWrite.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The `analogWrite` function has nothing to do with the analog pins or the `analog

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


Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Digital IO/digitalRead.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Reads the value from a specified digital pin, either `HIGH` or `LOW`.

[float]
=== Parameters
`pin`: the number of the digital pin you want to read
`pin`: the Arduino pin number you want to read


[float]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Digital IO/digitalWrite.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If you do not set the `pinMode()` to `OUTPUT`, and connect an LED to a pin, when

[float]
=== Parameters
`pin`: the pin number. +
`pin`: the Arduino pin number. +
`value`: `HIGH` or `LOW`.


Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Digital IO/pinMode.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ As of Arduino 1.0.1, it is possible to enable the internal pullup resistors with

[float]
=== Parameters
`pin`: the number of the pin whose mode you wish to set. +
`pin`: the Arduino pin number to set the mode of. +
`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.


Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/External Interrupts/attachInterrupt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ For more information on interrupts, see http://gammon.com.au/interrupts[Nick Gam
[float]
=== Parameters
`interrupt`: the number of the interrupt. Allowed data types: `int`. +
`pin`: the pin number. +
`pin`: the Arduino pin number. +
`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. +
`mode`: defines when the interrupt should be triggered. Four constants are predefined as valid values: +

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/External Interrupts/detachInterrupt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Turns off the given interrupt.
[float]
=== Parameters
`interrupt`: the number of the interrupt to disable (see link:../attachinterrupt[attachInterrupt()] for more details). +
`pin`: the pin number of the interrupt to disable
`pin`: the Arduino pin number of the interrupt to disable


[float]
Expand Down