Committed release v2.0.0

See the changelog for more details

Author: HackerInside0

Changelog.md

@@ -0,0 +1,41 @@
+symbols caption:
+> \+ added
+> \- removed
+> = changed/fixed
+> \* coming in a future release
+
+Changelog v2.0.0
+
+> = Made updates and corrected some mistakes in **README.md**  
+> = Updated **keywords.txt**  
+> = Renamed the class **L293** in **L293\_standalone**  
+> = Made **virtual** some public methods in the class **L293\_standalone** to allow to redefine them in the class **L293\_twoWire**  
+> = Changed the type of the *protected* variable **speedOffset** in the class **L293\_standalone** from **uint8_t** to **int16_t** to allow it to assume values beetween -255 and 255  
+> = Changed the type of the **_speedOffset** argument from **uint8_t** to **int16_t** in the class constructors and in the *public* method ***void L293_standalone::setSpeedOffset(int8_t _speedOffset)***  
+> = Made minor changes in the ***virtual void L293\_standalone::forward(uint8_t _pwm)*** and the ***virtual void L293\_standalone::forward(uint8_t _pwm)*** methods  
+>  
+> \+ Added a new class named **L293\_twoWire**, derived from **L293\_standalone**, that adds support for motor control using only two wires. More details in **README.md**  
+> \+ Added the *protected* method ***uint8_t getSpeedWithOffset(uint8_t _pwm)*** to the class **L293\_standalone**  
+> \+ Added a new constructor to the class **L293\_standalone** that does nothing, necessary to allow the **L293\_twoWire** class to function properly
+> \+ Added comments to the code  
+> \+ Added the file **LICENSE.md**  
+> \+ Added new examples and updated the old ones  
+
+Changelog v1.0.1 :
+
+> \- removed some useless code from "src/L293.cpp"  
+>  
+> = changed the repository url  
+> = completely rewrited README.md  
+>  
+> \* add a full changelog file updated on every release  
+
+Changelog v1.0.1-transitionUpdate :
+
+> Update that adds minor changes.  
+> Necessary to allow the change of the repository URL in the Arduino library manager.  
+> For the full changelog view the release v1.0.1  
+
+Changelog v1.0.0
+
+> First release

LICENSE.md

@@ -0,0 +1,5 @@
+#LICENSE
+
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/HackerInside0/Arduino_L293.git" property="cc:attributionName" rel="cc:attributionURL">Giuseppe Masino</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.<br />Permissions beyond the scope of this license may be available at <a xmlns:cc="http://creativecommons.org/ns#" href="https://facebook.com/peppe.masino1" rel="cc:morePermissions">https://facebook.com/peppe.masino1</a>.
+
+The full license text can be found here: https://creativecommons.org/licenses/by-sa/4.0/legalcode

README.md

@@ -1,41 +1,67 @@
-# L293
+# L293 #
 
 Compatible architecture: ALL
 
-##Description
+## Description ##
 
-Library that allows to control bidirectional motors using the L293 IC
+Library that allows to control bidirectional motors using the L293 IC in two different hardware configurations:
 
-##Sintax & short command reference
+- L293_standalone
+- L293_twoWire
+
+### L293_standalone configuration ###
+
+This configuration in intended for use with a standalone L293 IC, using 3 wires for each motor to control ( exclunding the power supply ).
+The circuit must be like this:
+![L293_standalone HW configuration](https://github.com/HackerInside0/Arduino_L293/blob/master/extras/L293_standalone-HW-conf.png)
+
+### L293_twoWire configuration ###
+
+This configuration is intended for use with a circuit like this:
+![L293_twoWire HW configuration](https://github.com/HackerInside0/Arduino_L293/blob/master/extras/L293_twoWire-HW-conf.png)
+
+Where only two wires are used to control the motor: the PWM signal and the direction signal ( excluding the power supply )
+
+## Sintax & short command reference ##
+### Reference for the L293_standalone configuration ###
 
 - Creating an istance  
 
-    *L293(pwmPin, forwardPin, backPin);*   
-    *L293(pwmPin, forwardPin, backPin, speedOffset);*  
+    *L293_standalone motor(pwmPin, forwardPin, backPin);*   
+    *L293_standalone motor(pwmPin, forwardPin, backPin, speedOffset);*  
 
-    **L293**        : the name of the object  
+    **motor**       : the name of the object  
     **pwmPin**      : the pin that generate the pwm signal used to control the motor speed  
     **forwardPin**  : the digital pin used to tell the motor to go forward  
     **backpin**     : the digital pin used to tell the motor to go reverse  
-    **speedOffset** : the offset value applied to the pwm signal value, used to reduce the power given to a motor  
-                     (e.g. in a robot two motors must rotate at the same speed, but one is more powerful than other)  
+    **speedOffset** : the offset value applied to the pwm signal value, used to reduce the power given to a motor (can be a value beetween -255 and 255)
+                      (e.g. in a robot two motors must rotate at the same speed, but one is more powerful than other)  
 
-- Moving the motor
+### Reference for the L293_twoWire configuration ###
+
+- Creating an istance  
 
-  ***L293.forward(speed);***  : makes the motor to go forward, **speed** can be a value between -255 and 255
+    *L293_twoWire motor(pwmPin, directionPin);*   
+    *L293_twoWire motor(pwmPin, directionPin, speedOffset);*  
+    
+    **motor**        : the name of the object  
+    **pwmPin**       : the pin that generate the pwm signal used to control the motor speed  
+    **directionPin** : the digital pin used to manage the motor direction  
+    **speedOffset**  : the offset value applied to the pwm signal value, used to reduce the power given to a motor (can be a value beetween -255 and 255)
+                      (e.g. in a robot two motors must rotate at the same speed, but one is more powerful than other)  
 
-  ***L293.back(speed);***     : makes the motor to go reverse, **speed** can be a value between -255 and 255
+### Common reference ###
 
-  ***L293.stop();***          : stops the motor
+- Moving the motor
 
-  ***L293.setSpeedOffset(speedOffset);*** : Used to set a new speed offset value after the creation of the istance
+  ***L293.forward(speed);***  : makes the motor to go forward, **speed** can be a value beetween 0 and 255  
+  ***L293.back(speed);***     : makes the motor to go reverse, **speed** can be a value beetween 0 and 255  
+  ***L293.stop();***          : stops the motor  
+  ***L293.setSpeedOffset(speedOffset);*** : Used to set a new speed offset value after the creation of the istance, **speedOffset** can be a value beetween -255 and 255  
 
-##About the author & license info
+## About the author & license info
 
 Created by ***Giuseppe Masino, 28 may 2016***
 Author URL: http://www.facebook.com/peppe.masino1
 
-This library and the relative example files are released under the license
-**CreativeCommons Attribution-ShareAlike 4.0 International
-
-License info: http://creativecommons.org/licenses/by-sa/4.0/
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/HackerInside0/Arduino_L293.git" property="cc:attributionName" rel="cc:attributionURL">Giuseppe Masino</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.<br />Permissions beyond the scope of this license may be available at <a xmlns:cc="http://creativecommons.org/ns#" href="https://facebook.com/peppe.masino1" rel="cc:morePermissions">https://facebook.com/peppe.masino1</a>.

examples/Standalone_MotorControl/Standalone_MotorControl.ino

@@ -0,0 +1,64 @@
+/*
+ * Bidirectional Motor Control with standalone L293
+ *
+ * Example of using L293 library to control one or more DC Birirectional Motors with the standalone configuration of the L293
+ *
+ * Created by Giuseppe Masino, 25 may 2016
+ * Author URL http://www.facebook.com/peppe.masino1
+ *
+ * This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
+ * To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
+ * -----------------------------------------------------------------------------------
+ *
+ * Things that you need:
+ * - Arduino\Genuino MEGA2560 
+ *   (any Arduino\Genuino board can be used, the important is that the L293 pin 1 is connected to a PWM-enabled pin of Arduino)
+ *   (on the Arduino MEGA2560 all pins from 2 to 13 are PWM-enabled)
+ *   (use of pin 13 is discouraged because it can cause issues when the board resets)
+ *
+ * - L293
+ * - A DC Birirectional Motor (max 5V-4mA)
+ * - A breadboard
+ *
+ *
+ * The circuit:
+ * - Arduino pin 2 -> L293 pin 1
+ * - Arduino pin 3 -> L293 pin 2
+ * - Arduino pin 4 -> L293 pin 7
+ * - Arduino GND -> L293 pin 4, 5
+ * - Arduino 5V -> L293 pin 16, 8
+ *
+ * - L293 pin 3 -> a terminal of the motor
+ * - L293 pin 6 -> the other terminal of the motor
+ *
+ */
+
+//import the library in the sketch
+#include <L293.h>
+
+//these variables are constants and won't change
+//give a name to the pins that we use
+const int speedPin = 2;  //that is the pin that we use to control the motor's speed
+const int forwardPin = 3; //this is the pin that we use to tell the motor to go forward
+const int reversePin = 4; //this is the pin that we use to tell the motor to go reverse
+
+//make a new istance of the L293 library and call it "motor"
+//then show what are the pins used to control speed, to tell the motor to go forward and to tell the motor to go reverse
+L293_standalone motor(speedPin,forwardPin,reversePin);
+
+void setup()
+{
+  //nothing to do in setup()
+}
+
+void loop()
+{
+  motor.forward(255);       //set the direction and the speed of the motor
+  delay(1000);              //wait for 1 second before doing else
+  motor.back(255);          //set a new direction and the speed of the motor
+  delay(1000);              //wait for 1 second before doing else
+  motor.stop();             //stop the motor
+  delay(1000);              //wait for 1 second before doing else
+  
+  //now the loop restarts
+}

examples/Standalone_SerialMotorControl/Standalone_SerialMotorControl.ino

@@ -0,0 +1,67 @@
+/*
+ * Serial Bidirectional Motor Control
+ *
+ * Example of using L293 library to control one or more DC Birirectional Motors via the Serial line
+ *
+ * Created by Giuseppe Masino, 28 may 2016
+ * Author URL http://www.facebook.com/peppe.masino1
+ *
+ * This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
+ * To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/. *
+ * -----------------------------------------------------------------------------------
+ *
+ * Things that you need:
+ * - Arduino\Genuino MEGA2560
+ *   (any Arduino\Genuino board can be used, the important is that the L293 pin 1 is connected to a PWM-enabled pin of Arduino)
+ *   (on the Arduino MEGA2560 all pins from 2 to 13 are PWM-enabled)
+ *   (use of pin 13 is discouraged because it can cause issues when the board resets)
+ *
+ * - L293
+ * - A DC Birirectional Motor (max 5V-4mA)
+ * - A breadboard
+ *
+ *
+ * The circuit:
+ * - Arduino pin 2 -> L293 pin 1
+ * - Arduino pin 3 -> L293 pin 2
+ * - Arduino pin 4 -> L293 pin 7
+ * - Arduino GND -> L293 pin 4, 5
+ * - Arduino 5V -> L293 pin 16, 8
+ *
+ * - L293 pin 3 -> a terminal of the motor
+ * - L293 pin 6 -> the other terminal of the motor
+ *
+ */
+
+//import the library in the sketch
+#include <L293.h>
+
+//these are constants and won't change
+//give a name to the pins that you use
+const int speedPin = 2;   //that is the pin that we use to control the motor's speed
+const int forwardPin = 3; //this is the pin that we use to tell the motor to go forward
+const int reversePin = 4; //this is the pin that we use to tell the motor to go reverse
+
+//make a new istance of the L293 library and call it "motor"
+//then show what are the pins used to control speed, to tell the motor to go forward and to tell the motor to go reverse
+L293_standalone motor(speedPin,forwardPin,reversePin);
+
+void setup()
+{
+  //these istructions will be executed one time
+  
+  Serial.begin(9600); //enable serial communication
+}
+
+void loop()
+{
+  if(Serial.available() > 0)                          //check if there is an incoming command on the serial line
+  {
+    String command = Serial.readString();             //store the command in a variable
+    
+    //select the proper action
+    if(command == "forward") motor.forward(255);   
+    else if(command == "reverse") motor.back(255);
+    else if(command == "stop") motor.stop();
+  }
+}

examples/twoWire_MotorControl/twoWire_MotorControl.ino

@@ -0,0 +1,53 @@
+/*
+ * Bidirectional Motor Control
+ *
+ * Example of using L293 library to control one or more DC Birirectional Motors
+ *
+ * Created by Giuseppe Masino, 25 may 2016
+ * Author URL http://www.facebook.com/peppe.masino1
+ *
+ * This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
+ * To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
+ * -----------------------------------------------------------------------------------
+ *
+ * Things that you need:
+ * - Arduino\Genuino MEGA2560 
+ *   (any Arduino\Genuino board can be used, the important is that the L293 pin 1 is connected to a PWM-enabled pin of Arduino)
+ *   (on the Arduino MEGA2560 all pins from 2 to 13 are PWM-enabled)
+ *   (use of pin 13 is discouraged because it can cause issues when the board resets)
+ *
+ * - L293
+ * - A DC Birirectional Motor (max 5V-4mA)
+ * - A breadboard
+ *
+ * The circuit: https://github.com/HackerInside0/Arduino_L293/blob/master/extras/L293_twoWire.svg
+ *
+ */
+
+//import the library in the sketch
+#include <L293.h>
+
+//give a name to the pins that you use
+#define speedPin 2   //that is the pin that we use to control the motor's speed
+#define directionPin 3 //this is the pin that we use to tell the motor to go forward
+
+//make a new istance of the L293 library and call it "motor"
+//then show what are the pins used to control speed, to tell the motor to go forward and to tell the motor to go reverse
+L293_twoWire motor(speedPin,directionPin);
+
+void setup()
+{
+  //nothing to do in setup()
+}
+
+void loop()
+{
+  motor.forward(255);       //set the direction and the speed of the motor
+  delay(1000);              //wait for 1 second before doing else
+  motor.back(255);          //set a new direction and the speed of the motor
+  delay(1000);              //wait for 1 second before doing else
+  motor.stop();             //stop the motor
+  delay(1000);              //wait for 1 second before doing else
+  
+  //now the loop restarts
+}

examples/twoWire_SerialMotorControl/twoWire_SerialMotorControl.ino

@@ -0,0 +1,57 @@
+/*
+ * Serial Bidirectional Motor Control with L293_twoWire configuration
+ *
+ * Example of using L293 library to control one or more DC Birirectional Motors via the Serial line with the twoWire configuration of the L293
+ *
+ * Created by Giuseppe Masino, 28 may 2016
+ * Author URL http://www.facebook.com/peppe.masino1
+ *
+ * This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. 
+ * To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
+ * -----------------------------------------------------------------------------------
+ *
+ * Things that you need:
+ * - Arduino\Genuino MEGA2560
+ *   (any Arduino\Genuino board can be used, the important is that the L293 pin 1 is connected to a PWM-enabled pin of Arduino)
+ *   (on the Arduino MEGA2560 all pins from 2 to 13 are PWM-enabled)
+ *   (use of pin 13 is discouraged because it can cause issues when the board resets)
+ *
+ * - L293
+ * - A DC Birirectional Motor (max 5V-4mA)
+ * - A breadboard
+ *
+ *
+ * The circuit: https://github.com/HackerInside0/Arduino_L293/blob/master/extras/L293_twoWire.svg
+ *
+ */
+
+//import the library in the sketch
+#include <L293.h>
+
+//give a name to the pins that you use
+#define speedPin 2   //that is the pin that we use to control the motor's speed
+#define directionPin 3 //this is the pin that we use to tell the motor to go forward
+
+//make a new istance of the L293 library and call it "motor"
+//then show what are the pins used to control speed, to tell the motor to go forward and to tell the motor to go reverse
+L293_twoWire motor(speedPin,directionPin);
+
+void setup()
+{
+  //these istructions will be executed one time
+  
+  Serial.begin(9600); //enable serial communication
+}
+
+void loop()
+{
+  if(Serial.available() > 0)                          //check if there is an incoming command on the serial line
+  {
+    String command = Serial.readString();             //store the command in a variable
+    
+    //select the proper action
+    if(command == "forward") motor.forward(255);   
+    else if(command == "reverse") motor.back(255);
+    else if(command == "stop") motor.stop();
+  }
+}