resync the generic examples with arduino-1.8.5

Author: tenbaht

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/AnalogReadSerial/AnalogReadSerial.ino

@@ -1,10 +1,14 @@
 /*
   AnalogReadSerial
-  Reads an analog input on pin 0, prints the result to the serial monitor.
-  Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
- 
- This example code is in the public domain.
- */
+
+  Reads an analog input on pin 0, prints the result to the Serial Monitor.
+  Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
+  Attach the center pin of a potentiometer to pin A0, and the outside pins to +3.3V and ground.
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/AnalogReadSerial
+*/
 
 #include <Serial.h>
 

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/BareMinimum/BareMinimum.ino

@@ -4,6 +4,6 @@ void setup() {
 }
 
 void loop() {
-  // put your main code here, to run repeatedly: 
-  
+  // put your main code here, to run repeatedly:
+
 }

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/Blink/Blink.ino

@@ -1,27 +1,37 @@
 /*
   Blink
-  Turns on an LED on for one second, then off for one second, repeatedly.
- 
-  This example code is in the public domain.
- */
 
-#include <Arduino.h> 
+  Turns an LED on for one second, then off for one second, repeatedly.
+
+  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
+  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 the Technical Specs of your board at:
+  https://www.arduino.cc/en/Main/Products
+
+  modified 8 May 2014
+  by Scott Fitzgerald
+  modified 2 Sep 2016
+  by Arturo Guadalupi
+  modified 8 Sep 2016
+  by Colby Newman
+
+  This example code is in the public domain.
 
-// Pin 13 has an LED connected on most Arduino boards.
-// Pin 3 for the STM8S103 break out board
-// give it a name:
-int led = LED_BUILTIN;
+  http://www.arduino.cc/en/Tutorial/Blink
+*/
 
-// the setup routine runs once when you press reset:
-void setup() {                
-  // initialize the digital pin as an output.
-  pinMode(led, OUTPUT);     
+// the setup function runs once when you press reset or power the board
+void setup() {
+  // initialize digital pin LED_BUILTIN as an output.
+  pinMode(LED_BUILTIN, OUTPUT);
 }
 
-// the loop routine runs over and over again forever:
+// the loop function runs over and over again forever
 void loop() {
-  digitalWrite(led, HIGH);   // turn the LED on (HIGH is the voltage level)
-  delay(1000);               // wait for a second
-  digitalWrite(led, LOW);    // turn the LED off by making the voltage LOW
-  delay(1000);               // wait for a second
+  digitalWrite(LED_BUILTIN, HIGH);   // turn the LED on (HIGH is the voltage level)
+  delay(1000);                       // wait for a second
+  digitalWrite(LED_BUILTIN, LOW);    // turn the LED off by making the voltage LOW
+  delay(1000);                       // wait for a second
 }

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/DigitalReadSerial/DigitalReadSerial.ino

@@ -1,9 +1,12 @@
 /*
   DigitalReadSerial
- Reads a digital input on pin 2, prints the result to the serial monitor 
- 
- This example code is in the public domain.
- */
+
+  Reads a digital input on pin 2, prints the result to the Serial Monitor
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/DigitalReadSerial
+*/
 
 #include <Serial.h>
 
@@ -26,6 +29,3 @@ void loop() {
   Serial_println_u(buttonState);
   delay(1);        // delay in between reads for stability
 }
-
-
-

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/Fade/Fade.ino

@@ -1,37 +1,40 @@
 /*
- Fade
- 
- This example shows how to fade an LED on pin 5
- using the analogWrite() function.
- 
- This example code is in the public domain.
- */
+  Fade
 
-#include <Arduino.h>
+  This example shows how to fade an LED on pin 5 using the analogWrite()
+  function.
 
-int led = 5;           // the pin that the LED is attached to
+  The analogWrite() function uses PWM, so if you want to change the pin you're
+  using, be sure to use another PWM capable pin. On most Arduino, the PWM pins
+  are identified with a "~" sign, like ~3, ~5, ~6, ~9, ~10 and ~11.
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/Fade
+*/
+
+int led = 5;           // the PWM pin the LED is attached to
 int brightness = 0;    // how bright the LED is
 int fadeAmount = 5;    // how many points to fade the LED by
 
 // the setup routine runs once when you press reset:
-void setup()  { 
+void setup() {
   // declare pin 9 to be an output:
   pinMode(led, OUTPUT);
-} 
+}
 
 // the loop routine runs over and over again forever:
-void loop()  { 
+void loop() {
   // set the brightness of pin 9:
-  analogWrite(led, brightness);    
+  analogWrite(led, brightness);
 
   // change the brightness for next time through the loop:
   brightness = brightness + fadeAmount;
 
-  // reverse the direction of the fading at the ends of the fade: 
-  if (brightness == 0 || brightness == 255) {
-    fadeAmount = -fadeAmount ; 
-  }     
-  // wait for 30 milliseconds to see the dimming effect    
-  delay(30);                            
+  // reverse the direction of the fading at the ends of the fade:
+  if (brightness <= 0 || brightness >= 255) {
+    fadeAmount = -fadeAmount;
+  }
+  // wait for 30 milliseconds to see the dimming effect
+  delay(30);
 }
-

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/01.Basics/ReadAnalogVoltage/ReadAnalogVoltage.ino

@@ -1,10 +1,14 @@
 /*
   ReadAnalogVoltage
-  Reads an analog input on pin 0, converts it to voltage, and prints the result to the serial monitor.
-  Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
- 
- This example code is in the public domain.
- */
+
+  Reads an analog input on pin 0, converts it to voltage, and prints the result to the Serial Monitor.
+  Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
+  Attach the center pin of a potentiometer to pin A0, and the outside pins to +3.3V and ground.
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/ReadAnalogVoltage
+*/
 
 #include <Serial.h>
 

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino

@@ -1,42 +1,46 @@
-/* Blink without Delay
-
- Turns on and off a light emitting diode (LED) connected to a digital
- pin, without using the delay() function.  This means that other code
- can run at the same time without being interrupted by the LED code.
-
- The circuit:
- * LED attached from pin 3 to VCC.
- * Note: on the STM8103 breakout board, there is already an LED on the board
- that's attached to pin 3, so no hardware is needed for this example.
-
- created 2005
- by David A. Mellis
- modified 8 Feb 2010
- by Paul Stoffregen
- modified 11 Nov 2013
- by Scott Fitzgerald
- modified 13 Feb 2017 for use with sduino
- by Michael Mayer
-
-
- This example code is in the public domain.
-
- http://www.arduino.cc/en/Tutorial/BlinkWithoutDelay
- */
-
-#include <Arduino.h>
-
-// constants won't change. Used here to set a pin number :
-const int ledPin =  3;      // the number of the LED pin
-
-// Variables will change :
+/*
+  Blink without Delay
+
+  Turns on and off a light emitting diode (LED) connected to a digital pin,
+  without using the delay() function. This means that other code can run at the
+  same time without being interrupted by the LED code.
+
+  The circuit:
+  - Use the onboard LED.
+  - 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 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 the Technical Specs of your board at:
+    https://www.arduino.cc/en/Main/Products
+
+  created 2005
+  by David A. Mellis
+  modified 8 Feb 2010
+  by Paul Stoffregen
+  modified 11 Nov 2013
+  by Scott Fitzgerald
+  modified 9 Jan 2017
+  by Arturo Guadalupi
+  modified 13 Feb 2017 for use with sduino
+  by Michael Mayer
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/BlinkWithoutDelay
+*/
+
+// constants won't change. Used here to set a pin number:
+const int ledPin =  LED_BUILTIN;// the number of the LED pin
+
+// Variables will change:
 int ledState = LOW;             // ledState used to set the LED
 
 // Generally, you should use "unsigned long" for variables that hold time
 // The value will quickly become too large for an int to store
 unsigned long previousMillis = 0;        // will store last time LED was updated
 
-// constants won't change :
+// constants won't change:
 const long interval = 1000;           // interval at which to blink (milliseconds)
 
 void setup() {
@@ -47,10 +51,9 @@ void setup() {
 void loop() {
   // here is where you'd put code that needs to be running all the time.
 
-  // check to see if it's time to blink the LED; that is, if the
-  // difference between the current time and last time you blinked
-  // the LED is bigger than the interval at which you want to
-  // blink the LED.
+  // check to see if it's time to blink the LED; that is, if the difference
+  // between the current time and last time you blinked the LED is bigger than
+  // the interval at which you want to blink the LED.
   unsigned long currentMillis = millis();
 
   if (currentMillis - previousMillis >= interval) {
@@ -68,4 +71,3 @@ void loop() {
     digitalWrite(ledPin, ledState);
   }
 }
-

sduino/hardware/sduino/stm8/libraries/Generic_Examples/examples/02.Digital/Button/Button.ino

@@ -1,35 +1,30 @@
 /*
   Button
 
- Turns on and off a light emitting diode(LED) connected to digital
- pin 3, when pressing a pushbutton attached to pin 2.
+  Turns on and off a light emitting diode(LED) connected to digital pin 3,
+  when pressing a pushbutton attached to pin 2.
 
+  The circuit:
+  - LED attached from pin 3 to VCC
+  - pushbutton attached to pin 2 from +5V
+  - 10K resistor attached to pin 2 from ground
 
- The circuit:
- * LED attached from pin 3 to VCC
- * pushbutton attached to pin 2 from +5V
- * 10K resistor attached to pin 2 from ground
+  - Note: on the STM8S103 breakout board there is already an LED on the board
+    attached to pin 3.
 
- * Note: on the STM8S103 breakout board there is already an LED on the board
- attached to pin 3.
+  created 2005
+  by DojoDave <http://www.0j0.org>
+  modified 30 Aug 2011
+  by Tom Igoe
+  modified 13 Feb 2017 for use with sduino
+  by Michael Mayer
 
+  This example code is in the public domain.
 
- created 2005
- by DojoDave <http://www.0j0.org>
- modified 30 Aug 2011
- by Tom Igoe
- modified 13 Feb 2017 for use with sduino
- by Michael Mayer
+  http://www.arduino.cc/en/Tutorial/Button
+*/
 
- This example code is in the public domain.
-
- http://www.arduino.cc/en/Tutorial/Button
- */
-
-#include <Arduino.h>
-
-// constants won't change. They're used here to
-// set pin numbers:
+// constants won't change. They're used here to set pin numbers:
 const int buttonPin = 2;     // the number of the pushbutton pin
 const int ledPin =  3;      // the number of the LED pin
 
@@ -47,13 +42,12 @@ void loop() {
   // read the state of the pushbutton value:
   buttonState = digitalRead(buttonPin);
 
-  // check if the pushbutton is pressed.
-  // if it is, the buttonState is HIGH:
+  // check if the pushbutton is pressed. If it is, the buttonState is HIGH:
   if (buttonState == HIGH) {
     // turn LED on:
     digitalWrite(ledPin, HIGH);
   } else {
     // turn LED off:
     digitalWrite(ledPin, LOW);
   }
-}
+}