rooty/Arduino
1
0
Fork 0
mirror of https://github.com/arduino/Arduino.git synced 2025-02-07 01:54:26 +01:00
Code Issues Releases Activity

Use Auto Format compatible bullet character in built-in example comment lists

Browse Source 
Tools > Auto Format in the Arduino IDE removes asterisks from the start of every line in a C style comment, causing that character to be unsuitable for use as a bullet for lists in the example comments.
This commit is contained in:
per1234 2017-07-12 12:30:49 -07:00 committed by Cristian Maglie
parent 827a933eed
commit 499c424d59
41 changed files with 93 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
build/shared/examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino
View File

@ -5,8 +5,8 @@
can run at the same time without being interrupted by the LED code. can run at the same time without being interrupted by the LED code.
The circuit: The circuit:
* Use the onboard LED. - Use the onboard LED.
* Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO - Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
the correct LED pin independent of which board is used. the correct LED pin independent of which board is used.
If you want to know what pin the on-board LED is connected to on your Arduino model, check If you want to know what pin the on-board LED is connected to on your Arduino model, check

8
build/shared/examples/02.Digital/Button/Button.ino
View File

@ -6,11 +6,11 @@
The circuit: The circuit:
* LED attached from pin 13 to ground - LED attached from pin 13 to ground
* pushbutton attached to pin 2 from +5V - pushbutton attached to pin 2 from +5V
* 10K resistor attached to pin 2 from ground - 10K resistor attached to pin 2 from ground
* Note: on most Arduinos there is already an LED on the board - Note: on most Arduinos there is already an LED on the board
attached to pin 13. attached to pin 13.

8
build/shared/examples/02.Digital/Debounce/Debounce.ino
View File

@ -7,11 +7,11 @@
noise). noise).
The circuit: The circuit:
* LED attached from pin 13 to ground - LED attached from pin 13 to ground
* pushbutton attached from pin 2 to +5V - pushbutton attached from pin 2 to +5V
* 10K resistor attached from pin 2 to ground - 10K resistor attached from pin 2 to ground
* Note: On most Arduino boards, there is already an LED on the board - Note: On most Arduino boards, there is already an LED on the board
connected to pin 13, so you don't need any extra components for this example. connected to pin 13, so you don't need any extra components for this example.

4
build/shared/examples/02.Digital/DigitalInputPullup/DigitalInputPullup.ino
View File

@ -5,8 +5,8 @@
digital input on pin 2 and prints the results to the Serial Monitor. digital input on pin 2 and prints the results to the Serial Monitor.
The circuit: The circuit:
* Momentary switch attached from pin 2 to ground - Momentary switch attached from pin 2 to ground
* Built-in LED on pin 13 - Built-in LED on pin 13
Unlike pinMode(INPUT), there is no pull-down resistor necessary. An internal Unlike pinMode(INPUT), there is no pull-down resistor necessary. An internal
20K-ohm resistor is pulled to 5V. This configuration causes the input to 20K-ohm resistor is pulled to 5V. This configuration causes the input to

6
build/shared/examples/02.Digital/StateChangeDetection/StateChangeDetection.ino
View File

@ -10,9 +10,9 @@
and on to off. and on to off.
The circuit: The circuit:
* pushbutton attached to pin 2 from +5V - pushbutton attached to pin 2 from +5V
* 10K resistor attached to pin 2 from ground - 10K resistor attached to pin 2 from ground
* LED attached from pin 13 to ground (or use the built-in LED on - LED attached from pin 13 to ground (or use the built-in LED on
most Arduino boards) most Arduino boards)
created 27 Sep 2005 created 27 Sep 2005

6
build/shared/examples/02.Digital/toneKeyboard/toneKeyboard.ino
View File

@ -4,9 +4,9 @@
Plays a pitch that changes based on a changing analog input Plays a pitch that changes based on a changing analog input
circuit: circuit:
* 3 force-sensing resistors from +5V to analog in 0 through 5 - 3 force-sensing resistors from +5V to analog in 0 through 5
* 3 10K resistors from analog in 0 through 5 to ground - 3 10K resistors from analog in 0 through 5 to ground
* 8-ohm speaker on digital pin 8 - 8-ohm speaker on digital pin 8
created 21 Jan 2010 created 21 Jan 2010
modified 9 Apr 2012 modified 9 Apr 2012

2
build/shared/examples/02.Digital/toneMelody/toneMelody.ino
View File

@ -4,7 +4,7 @@
Plays a melody Plays a melody
circuit: circuit:
* 8-ohm speaker on digital pin 8 - 8-ohm speaker on digital pin 8
created 21 Jan 2010 created 21 Jan 2010
modified 30 Aug 2011 modified 30 Aug 2011

2
build/shared/examples/02.Digital/toneMultiple/toneMultiple.ino
View File

@ -4,7 +4,7 @@
Plays multiple tones on multiple pins in sequence Plays multiple tones on multiple pins in sequence
circuit: circuit:
* 3 8-ohm speaker on digital pins 6, 7, and 8 - 3 8-ohm speaker on digital pins 6, 7, and 8
created 8 March 2010 created 8 March 2010
by Tom Igoe by Tom Igoe

6
build/shared/examples/02.Digital/tonePitchFollower/tonePitchFollower.ino
View File

@ -4,9 +4,9 @@
Plays a pitch that changes based on a changing analog input Plays a pitch that changes based on a changing analog input
circuit: circuit:
* 8-ohm speaker on digital pin 9 - 8-ohm speaker on digital pin 9
* photoresistor on analog 0 to 5V - photoresistor on analog 0 to 5V
* 4.7K resistor on analog 0 to ground - 4.7K resistor on analog 0 to ground
created 21 Jan 2010 created 21 Jan 2010
modified 31 May 2012 modified 31 May 2012

4
build/shared/examples/03.Analog/AnalogInOutSerial/AnalogInOutSerial.ino
View File

@ -6,10 +6,10 @@
Also prints the results to the Serial Monitor. Also prints the results to the Serial Monitor.
The circuit: The circuit:
* potentiometer connected to analog pin 0. - potentiometer connected to analog pin 0.
Center pin of the potentiometer goes to the analog pin. Center pin of the potentiometer goes to the analog pin.
side pins of the potentiometer go to +5V and ground side pins of the potentiometer go to +5V and ground
* LED connected from digital pin 9 to ground - LED connected from digital pin 9 to ground
created 29 Dec. 2008 created 29 Dec. 2008
modified 9 Apr 2012 modified 9 Apr 2012

14
build/shared/examples/03.Analog/AnalogInput/AnalogInput.ino
View File

@ -6,14 +6,14 @@
the value obtained by analogRead(). the value obtained by analogRead().
The circuit: The circuit:
* Potentiometer attached to analog input 0 - Potentiometer attached to analog input 0
* center pin of the potentiometer to the analog pin - center pin of the potentiometer to the analog pin
* one side pin (either one) to ground - one side pin (either one) to ground
* the other side pin to +5V - the other side pin to +5V
* LED anode (long leg) attached to digital output 13 - LED anode (long leg) attached to digital output 13
* LED cathode (short leg) attached to ground - LED cathode (short leg) attached to ground
* Note: because most Arduinos have a built-in LED attached - Note: because most Arduinos have a built-in LED attached
to pin 13 on the board, the LED is optional. to pin 13 on the board, the LED is optional.

2
build/shared/examples/03.Analog/AnalogWriteMega/AnalogWriteMega.ino
View File

@ -5,7 +5,7 @@
This sketch was written for the Arduino Mega, and will not work on other boards. This sketch was written for the Arduino Mega, and will not work on other boards.
The circuit: The circuit:
* LEDs attached from pins 2 through 13 to ground. - LEDs attached from pins 2 through 13 to ground.
created 8 Feb 2009 created 8 Feb 2009
by Tom Igoe by Tom Igoe

4
build/shared/examples/03.Analog/Calibration/Calibration.ino
View File

@ -12,8 +12,8 @@
maximum low and listen for anything higher as the new maximum. maximum low and listen for anything higher as the new maximum.
The circuit: The circuit:
* Analog sensor (potentiometer will do) attached to analog input 0 - Analog sensor (potentiometer will do) attached to analog input 0
* LED attached from digital pin 9 to ground - LED attached from digital pin 9 to ground
created 29 Oct 2008 created 29 Oct 2008
By David A Mellis By David A Mellis

2
build/shared/examples/03.Analog/Fading/Fading.ino
View File

@ -4,7 +4,7 @@
This example shows how to fade an LED using the analogWrite() function. This example shows how to fade an LED using the analogWrite() function.
The circuit: The circuit:
* LED attached from digital pin 9 to ground. - LED attached from digital pin 9 to ground.
Created 1 Nov 2008 Created 1 Nov 2008
By David A. Mellis By David A. Mellis

2
build/shared/examples/03.Analog/Smoothing/Smoothing.ino
View File

@ -7,7 +7,7 @@
continually averages them. continually averages them.
The circuit: The circuit:
* Analog sensor (potentiometer will do) attached to analog input 0 - Analog sensor (potentiometer will do) attached to analog input 0
Created 22 April 2007 Created 22 April 2007
By David A. Mellis <dam@mellis.org> By David A. Mellis <dam@mellis.org>

4
build/shared/examples/04.Communication/ASCIITable/ASCIITable.ino
View File

@ -2,8 +2,8 @@
ASCII table ASCII table
Prints out byte values in all possible formats: Prints out byte values in all possible formats:
* as raw binary values - as raw binary values
* as ASCII-encoded decimal, hex, octal, and binary values - as ASCII-encoded decimal, hex, octal, and binary values
For more on ASCII, see http://www.asciitable.com and http://en.wikipedia.org/wiki/ASCII For more on ASCII, see http://www.asciitable.com and http://en.wikipedia.org/wiki/ASCII

6
build/shared/examples/04.Communication/Midi/Midi.ino
View File

@ -7,9 +7,9 @@
The circuit: The circuit:
* digital in 1 connected to MIDI jack pin 5 - digital in 1 connected to MIDI jack pin 5
* MIDI jack pin 2 connected to ground - MIDI jack pin 2 connected to ground
* MIDI jack pin 4 connected to +5V through 220-ohm resistor - MIDI jack pin 4 connected to +5V through 220-ohm resistor
Attach a MIDI cable to the jack, then to a MIDI synth, and play music. Attach a MIDI cable to the jack, then to a MIDI synth, and play music.
created 13 Jun 2006 created 13 Jun 2006

4
build/shared/examples/04.Communication/MultiSerial/MultiSerial.ino
View File

@ -7,8 +7,8 @@
This example works only with boards with more than one serial like Arduino Mega, Due, Zero etc This example works only with boards with more than one serial like Arduino Mega, Due, Zero etc
The circuit: The circuit:
* Any serial device attached to Serial port 1 - Any serial device attached to Serial port 1
* Serial monitor open on Serial port 0: - Serial monitor open on Serial port 0:
created 30 Dec. 2008 created 30 Dec. 2008
modified 20 May 2012 modified 20 May 2012

2
build/shared/examples/04.Communication/PhysicalPixel/PhysicalPixel.ino
View File

@ -11,7 +11,7 @@
proxy), PD, or Max/MSP. proxy), PD, or Max/MSP.
The circuit: The circuit:
* LED connected from digital pin 13 to ground - LED connected from digital pin 13 to ground
created 2006 created 2006
by David A. Mellis by David A. Mellis

8
build/shared/examples/04.Communication/ReadASCIIString/ReadASCIIString.ino
View File

@ -6,10 +6,10 @@
It parses them into ints, and uses those to fade an RGB LED. It parses them into ints, and uses those to fade an RGB LED.
Circuit: Common-Cathode RGB LED wired like so: Circuit: Common-Cathode RGB LED wired like so:
* Red anode: digital pin 3 - Red anode: digital pin 3
* Green anode: digital pin 5 - Green anode: digital pin 5
* Blue anode: digital pin 6 - Blue anode: digital pin 6
* Cathode : GND - Cathode : GND
created 13 Apr 2012 created 13 Apr 2012
by Tom Igoe by Tom Igoe

4
build/shared/examples/04.Communication/SerialCallResponse/SerialCallResponse.ino
View File

@ -10,8 +10,8 @@
Thanks to Greg Shakar and Scott Fitzgerald for the improvements Thanks to Greg Shakar and Scott Fitzgerald for the improvements
The circuit: The circuit:
* potentiometers attached to analog inputs 0 and 1 - potentiometers attached to analog inputs 0 and 1
* pushbutton attached to digital I/O 2 - pushbutton attached to digital I/O 2
Created 26 Sept. 2005 Created 26 Sept. 2005
by Tom Igoe by Tom Igoe

4
build/shared/examples/04.Communication/SerialCallResponseASCII/SerialCallResponseASCII.ino
View File

@ -12,8 +12,8 @@
Thanks to Greg Shakar and Scott Fitzgerald for the improvements Thanks to Greg Shakar and Scott Fitzgerald for the improvements
The circuit: The circuit:
* potentiometers attached to analog inputs 0 and 1 - potentiometers attached to analog inputs 0 and 1
* pushbutton attached to digital I/O 2 - pushbutton attached to digital I/O 2

2
build/shared/examples/04.Communication/VirtualColorMixer/VirtualColorMixer.ino
View File

@ -4,7 +4,7 @@
take those three values and use them to change the background color of the screen. take those three values and use them to change the background color of the screen.
The circuit: The circuit:
* potentiometers attached to analog inputs 0, 1, and 2 - potentiometers attached to analog inputs 0, 1, and 2
http://www.arduino.cc/en/Tutorial/VirtualColorMixer http://www.arduino.cc/en/Tutorial/VirtualColorMixer

2
build/shared/examples/05.Control/Arrays/Arrays.ino
View File

@ -9,7 +9,7 @@
contiguous, here the pins can be in any random order. contiguous, here the pins can be in any random order.
The circuit: The circuit:
* LEDs from pins 2 through 7 to ground - LEDs from pins 2 through 7 to ground
created 2006 created 2006
by David A. Mellis by David A. Mellis

2
build/shared/examples/05.Control/ForLoopIteration/ForLoopIteration.ino
View File

@ -5,7 +5,7 @@
Lights multiple LEDs in sequence, then in reverse. Lights multiple LEDs in sequence, then in reverse.
The circuit: The circuit:
* LEDs from pins 2 through 7 to ground - LEDs from pins 2 through 7 to ground
created 2006 created 2006
by David A. Mellis by David A. Mellis

6
build/shared/examples/05.Control/IfStatementConditional/IfStatementConditional.ino
View File

@ -7,12 +7,12 @@
regardless of the level. regardless of the level.
The circuit: The circuit:
* potentiometer connected to analog pin 0. - potentiometer connected to analog pin 0.
Center pin of the potentiometer goes to the analog pin. Center pin of the potentiometer goes to the analog pin.
side pins of the potentiometer go to +5V and ground side pins of the potentiometer go to +5V and ground
* LED connected from digital pin 13 to ground - LED connected from digital pin 13 to ground
* Note: On most Arduino boards, there is already an LED on the board - Note: On most Arduino boards, there is already an LED on the board
connected to pin 13, so you don't need any extra components for this example. connected to pin 13, so you don't need any extra components for this example.
created 17 Jan 2009 created 17 Jan 2009

10
build/shared/examples/05.Control/WhileStatementConditional/WhileStatementConditional.ino
View File

@ -10,11 +10,11 @@
This is a variation on the calibrate example. This is a variation on the calibrate example.
The circuit: The circuit:
* photoresistor connected from +5V to analog in pin 0 - photoresistor connected from +5V to analog in pin 0
* 10K resistor connected from ground to analog in pin 0 - 10K resistor connected from ground to analog in pin 0
* LED connected from digital pin 9 to ground through 220 ohm resistor - LED connected from digital pin 9 to ground through 220 ohm resistor
* pushbutton attached from pin 2 to +5V - pushbutton attached from pin 2 to +5V
* 10K resistor attached from pin 2 to ground - 10K resistor attached from pin 2 to ground
created 17 Jan 2009 created 17 Jan 2009
modified 30 Aug 2011 modified 30 Aug 2011

4
build/shared/examples/05.Control/switchCase/switchCase.ino
View File

@ -10,8 +10,8 @@
over the sensor. over the sensor.
The circuit: The circuit:
* photoresistor from analog in 0 to +5V - photoresistor from analog in 0 to +5V
* 10K resistor from analog in 0 to ground - 10K resistor from analog in 0 to ground
created 1 Jul 2009 created 1 Jul 2009
modified 9 Apr 2012 modified 9 Apr 2012

2
build/shared/examples/05.Control/switchCase2/switchCase2.ino
View File

@ -10,7 +10,7 @@
the LEDs off. the LEDs off.
The circuit: The circuit:
* 5 LEDs attached to digital pins 2 through 6 through 220-ohm resistors - 5 LEDs attached to digital pins 2 through 6 through 220-ohm resistors
created 1 Jul 2009 created 1 Jul 2009
by Tom Igoe by Tom Igoe

6
build/shared/examples/06.Sensors/Knock/Knock.ino
View File

@ -6,9 +6,9 @@
"knock" to the serial port, and toggles the LED on pin 13. "knock" to the serial port, and toggles the LED on pin 13.
The circuit: The circuit:
* + connection of the piezo attached to analog in 0 - + connection of the piezo attached to analog in 0
* - connection of the piezo attached to ground - - connection of the piezo attached to ground
* 1-megohm resistor attached from analog in 0 to ground - 1-megohm resistor attached from analog in 0 to ground
http://www.arduino.cc/en/Tutorial/Knock http://www.arduino.cc/en/Tutorial/Knock

8
build/shared/examples/06.Sensors/Memsic2125/Memsic2125.ino
View File

@ -7,10 +7,10 @@
computer. computer.
The circuit: The circuit:
* X output of accelerometer to digital pin 2 - X output of accelerometer to digital pin 2
* Y output of accelerometer to digital pin 3 - Y output of accelerometer to digital pin 3
* +V of accelerometer to +5V - +V of accelerometer to +5V
* GND of accelerometer to ground - GND of accelerometer to ground
http://www.arduino.cc/en/Tutorial/Memsic2125 http://www.arduino.cc/en/Tutorial/Memsic2125

6
build/shared/examples/06.Sensors/Ping/Ping.ino
View File

@ -7,9 +7,9 @@
the distance of the object from the sensor. the distance of the object from the sensor.
The circuit: The circuit:
* +V connection of the PING))) attached to +5V - +V connection of the PING))) attached to +5V
* GND connection of the PING))) attached to ground - GND connection of the PING))) attached to ground
* SIG connection of the PING))) attached to digital pin 7 - SIG connection of the PING))) attached to digital pin 7
http://www.arduino.cc/en/Tutorial/Ping http://www.arduino.cc/en/Tutorial/Ping

8
build/shared/examples/07.Display/RowColumnScanning/RowColumnScanning.ino
View File

@ -20,11 +20,11 @@
Pin numbers: Pin numbers:
Matrix: Matrix:
* Digital pins 2 through 13, - Digital pins 2 through 13,
* analog pins 2 through 5 used as digital 16 through 19 - analog pins 2 through 5 used as digital 16 through 19
Potentiometers: Potentiometers:
* center pins are attached to analog pins 0 and 1, respectively - center pins are attached to analog pins 0 and 1, respectively
* side pins attached to +5V and ground, respectively. - side pins attached to +5V and ground, respectively.
This example code is in the public domain. This example code is in the public domain.

2
build/shared/examples/07.Display/barGraph/barGraph.ino
View File

@ -10,7 +10,7 @@
depends on an analog input. depends on an analog input.
The circuit: The circuit:
* LEDs from pins 2 through 11 to ground - LEDs from pins 2 through 11 to ground
created 4 Sep 2010 created 4 Sep 2010
by Tom Igoe by Tom Igoe

4
build/shared/examples/09.USB/Keyboard/KeyboardLogout/KeyboardLogout.ino
View File

@ -13,8 +13,8 @@
To wake: Spacebar. To wake: Spacebar.
Circuit: Circuit:
* Arduino Leonardo or Micro - Arduino Leonardo or Micro
* wire to connect D2 to ground. - wire to connect D2 to ground.
created 6 Mar 2012 created 6 Mar 2012
modified 27 Mar 2012 modified 27 Mar 2012

4
build/shared/examples/09.USB/Keyboard/KeyboardMessage/KeyboardMessage.ino
View File

@ -6,8 +6,8 @@
Sends a text string when a button is pressed. Sends a text string when a button is pressed.
The circuit: The circuit:
* pushbutton attached from pin 4 to +5V - pushbutton attached from pin 4 to +5V
* 10-kilohm resistor attached from pin 4 to ground - 10-kilohm resistor attached from pin 4 to ground
created 24 Oct 2011 created 24 Oct 2011
modified 27 Mar 2012 modified 27 Mar 2012

4
build/shared/examples/09.USB/Keyboard/KeyboardReprogram/KeyboardReprogram.ino
View File

@ -13,8 +13,8 @@
a final key combination (CTRL-U). a final key combination (CTRL-U).
Circuit: Circuit:
* Arduino Leonardo, Micro, Due, LilyPad USB, or Yún - Arduino Leonardo, Micro, Due, LilyPad USB, or Yún
* wire to connect D2 to ground. - wire to connect D2 to ground.
created 5 Mar 2012 created 5 Mar 2012
modified 29 Mar 2012 modified 29 Mar 2012

2
build/shared/examples/09.USB/Keyboard/KeyboardSerial/KeyboardSerial.ino
View File

@ -8,7 +8,7 @@
if you send a, you get b, send A you get B, and so forth. if you send a, you get b, send A you get B, and so forth.
The circuit: The circuit:
* none - none
created 21 Oct 2011 created 21 Oct 2011
modified 27 Mar 2012 modified 27 Mar 2012

2
build/shared/examples/09.USB/KeyboardAndMouseControl/KeyboardAndMouseControl.ino
View File

@ -5,7 +5,7 @@
Controls the mouse from five pushbuttons on an Arduino Leonardo, Micro or Due. Controls the mouse from five pushbuttons on an Arduino Leonardo, Micro or Due.
Hardware: Hardware:
* 5 pushbuttons attached to D2, D3, D4, D5, D6 - 5 pushbuttons attached to D2, D3, D4, D5, D6
The mouse movement is always relative. This sketch reads The mouse movement is always relative. This sketch reads
four pushbuttons, and uses them to set the movement of the mouse. four pushbuttons, and uses them to set the movement of the mouse.

2
build/shared/examples/09.USB/Mouse/ButtonMouseControl/ButtonMouseControl.ino
View File

@ -7,7 +7,7 @@
Controls the mouse from five pushbuttons on an Arduino Leonardo, Micro or Due. Controls the mouse from five pushbuttons on an Arduino Leonardo, Micro or Due.
Hardware: Hardware:
* 5 pushbuttons attached to D2, D3, D4, D5, D6 - 5 pushbuttons attached to D2, D3, D4, D5, D6
The mouse movement is always relative. This sketch reads The mouse movement is always relative. This sketch reads

4
build/shared/examples/09.USB/Mouse/JoystickMouseControl/JoystickMouseControl.ino
View File

@ -6,8 +6,8 @@
a second pushbutton to click the left mouse button a second pushbutton to click the left mouse button
Hardware: Hardware:
* 2-axis joystick connected to pins A0 and A1 - 2-axis joystick connected to pins A0 and A1
* pushbuttons connected to pin D2 and D3 - pushbuttons connected to pin D2 and D3
The mouse movement is always relative. This sketch reads The mouse movement is always relative. This sketch reads
two analog inputs that range from 0 to 1023 (or less on either end) two analog inputs that range from 0 to 1023 (or less on either end)