aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-10 09:10:03 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-10 09:10:03 -0400
commitdf044ee0c3a8602ac3329a86ff6c62d3ec4568b0 (patch)
tree100dcf093a7596c2632d4b944a46c5f3bd271a38 /docs/source/lang/api
parent7374b7e9e264cd231f1e2bba44e776533938d41a (diff)
downloadlibrambutan-df044ee0c3a8602ac3329a86ff6c62d3ec4568b0.tar.gz
librambutan-df044ee0c3a8602ac3329a86ff6c62d3ec4568b0.zip
Docs: Use "BOARD_LED_PIN" instead of "13".
Fix examples where pin 13 was used explicitly instead of BOARD_LED_PIN. Also change an AVR-specific example in docs/lang/cpp/booleanvariables.rst to Maple conventions.
Diffstat (limited to 'docs/source/lang/api')
-rw-r--r--docs/source/lang/api/delay.rst13
-rw-r--r--docs/source/lang/api/digitalwrite.rst7
2 files changed, 10 insertions, 10 deletions
diff --git a/docs/source/lang/api/delay.rst b/docs/source/lang/api/delay.rst
index 9ef06a0..30bd436 100644
--- a/docs/source/lang/api/delay.rst
+++ b/docs/source/lang/api/delay.rst
@@ -42,17 +42,16 @@ Example
::
- int ledPin = 13; // LED connected to pin 13
-
void setup() {
- pinMode(ledPin, OUTPUT); // sets the digital pin as output
+ // set up the built-in LED pin for output:
+ pinMode(BOARD_LED_PIN, OUTPUT);
}
void loop() {
- digitalWrite(ledPin, HIGH); // sets the LED on
- delay(1000); // waits for a second
- digitalWrite(ledPin, LOW); // sets the LED off
- delay(1000); // waits for a second
+ digitalWrite(BOARD_LED_PIN, HIGH); // sets the LED on
+ delay(1000); // waits for a second
+ digitalWrite(BOARD_LED_PIN, LOW); // sets the LED off
+ delay(1000); // waits for a second
}
.. _lang-delay-seealso:
diff --git a/docs/source/lang/api/digitalwrite.rst b/docs/source/lang/api/digitalwrite.rst
index 376cbc3..bae8db9 100644
--- a/docs/source/lang/api/digitalwrite.rst
+++ b/docs/source/lang/api/digitalwrite.rst
@@ -28,9 +28,10 @@ more slowly as an output than the other pins.
Example
-------
-The following example sets pin 13 to ``HIGH``, makes a one-second-long
-delay, sets the pin back to ``LOW``, and delays again, causing a
-blinking pattern (you could also use :ref:`lang-toggleled`)::
+The following example sets the built-in LED pin to ``HIGH``, makes a
+one-second-long delay, sets the pin back to ``LOW``, and delays again,
+causing a blinking pattern (you could also use
+:ref:`lang-toggleled`)::
void setup() {
pinMode(BOARD_LED_PIN, OUTPUT); // sets the digital pin as output