Committed release v3.0.0

Author: Giuseppe Masino

Changelog.md

@@ -4,6 +4,21 @@ symbols caption:
 > = changed/fixed
 > \* coming in a future release
 
+Changelog v3.0.0
+
+> = Updated **README.md**  
+> = Updated **keywords.txt**  
+> = Renamed the class **L293\_standalone** in **L293**  
+> = Rewrited the class **L293** and **L293\_standalone**  
+> = Renamed the method **setSpeedOffset()** in **setPWMOffset()**  
+> = Fixed a bug about the timing when switching a motor from the forward mode to the reverse mode and viceversa
+> 
+> \+ Added an overload for the **forward(speed)** and the **back(speed)** method described in README.md
+> \+ Added the method getDirection()
+> \+ Added the method getPWMDC()
+> \+ Added the method getRawPWMDC()
+> \+ Added the method forceStop(handleTime)
+
 Changelog v2.0.0
 
 > = Made updates and corrected some mistakes in **README.md**  

LICENSE.md

@@ -1,5 +1,19 @@
 #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>.
+<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 />
+<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">The L293 Library</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/HackerInside0/Arduino_L293" 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> and also under the following terms:  
 
-The full license text can be found here: https://creativecommons.org/licenses/by-sa/4.0/legalcode
+The softwares, source files, schematics and all other material are provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular scope and noninfringement.   
+
+In no event shall me and/or other peopole that holds the rights and/or are implied in the creation and distribution of the above mentioned things be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising form, out of or in connection with the above mentioned things or the use or other dealings in it.  
+
+The above copyright notice and this permission notice shall accompany and/or be included ( depending on the type of work ) in all the derived works from mine, as addendum to compliance with the provisions above.  
+
+If you need permissions that are beyond the scope of this license, you can ask to me through this facebook page <a xmlns:cc="http://creativecommons.org/ns#" href="https://www.facebook.com/dev.hackerinside/" rel="cc:morePermissions">https://www.facebook.com/dev.hackerinside/</a>
+
+Relatively to the Creative Commons Attribution-ShareAlike 4.0 International License:  
+A summary the license can be found here: http://creativecommons.org/licenses/by-sa/4.0/  
+Otherwise, the full license text can be found here: https://creativecommons.org/licenses/by-sa/4.0/legalcode

README.md

@@ -6,38 +6,59 @@ Compatible architecture: ALL
 
 Library that allows to control bidirectional motors using the L293 IC in two different hardware configurations:
 
-- L293_standalone
-- L293_twoWire
+- standalone
+- twoWire
 
-### L293_standalone configuration ###
+### 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 ).
+This configuration in intended for use with a standalone L293 IC and breakout boards that expose the ENABLE pin and the two INPUTS, using 3 wires for each motor to control ( excluding 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 ###
+### 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 ###
+### Common reference ###
+
+- Moving the motor
+
+  ***motor.forward(speed);***  : makes the motor to go forward, **speed** can be a value beetween 0 and 255  
+  ***motor.forward();***       : makes the motor to go forward without modifing the speed  
+  ***motor.back(speed);***     : makes the motor to go reverse, **speed** can be a value beetween 0 and 255  
+  ***motor.back();***          : makes the motor to go reverse without modifing the speed  
+  ***motor.stop();***          : stops the motor  
+  ***motor.setPWMOffset(speedOffset);*** : sets the offset value applied to the pwm signal value, **speedOffset** can be a value beetween -255 and 255  
+  ***motor.getRawPWMDC();***   : returns the current speed value whitout appling the speed offset  
+  ***motor.getPWMDC();***      : returns the real current speed value  
+  ***motor.getDirection();***  : return an integer representing the status of the motor: 
+  - 0 : the motor is going forward  
+  - 1 : the motor is going reverse  
+  - 3 : the motor is braked  
+  - 4 : unknown status
+  
+### Reference for the standalone configuration only ###
 
 - Creating an istance  
 
-    *L293_standalone motor(pwmPin, forwardPin, backPin);*   
-    *L293_standalone motor(pwmPin, forwardPin, backPin, speedOffset);*  
+    *L293 motor(pwmPin, forwardPin, backPin);*   
+    *L293 motor(pwmPin, forwardPin, backPin, speedOffset);*  
 
     **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 (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)  
+    **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
+ 	
+	**motor.forceStop(handlingTime);** : stops the motor electically braking it, **handlingTime** is the time in milliseconds during which the motor is braked, the recommended value is 100
 
-### Reference for the L293_twoWire configuration ###
+### Reference for the L293_twoWire configuration only ###
 
 - Creating an istance  
 
@@ -50,18 +71,22 @@ Where only two wires are used to control the motor: the PWM signal and the direc
     **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)  
 
-### Common reference ###
 
-- Moving the motor
-
-  ***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
 
-Created by ***Giuseppe Masino, 28 may 2016***
-Author URL: http://www.facebook.com/peppe.masino1
+<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 />
+<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">The L293 Library</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/HackerInside0/Arduino_L293" 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> and also under the following terms:  
+
+The softwares, source files, schematics and all other material are provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular scope and noninfringement.   
+
+In no event shall me and/or other peopole that holds the rights and/or are implied in the creation and distribution of the above mentioned things be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising form, out of or in connection with the above mentioned things or the use or other dealings in it.  
+
+The above copyright notice and this permission notice shall accompany and/or be included ( depending on the type of work ) in all the derived works from mine, as addendum to compliance with the provisions above.  
+
+If you need permissions that are beyond the scope of this license, you can ask to me through this facebook page <a xmlns:cc="http://creativecommons.org/ns#" href="https://www.facebook.com/dev.hackerinside/" rel="cc:morePermissions">https://www.facebook.com/dev.hackerinside/</a>
 
-<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 text of this license can also be found in the LICENSE.md file

examples/MotorControl/MotorControl.ino

@@ -5,6 +5,7 @@
  *
  * Created by Giuseppe Masino, 25 may 2016
  * Author URL http://www.facebook.com/peppe.masino1
+ * Author email: dev.giuseppemasino@outlook.it
  *
  * This example and the L293 library are released under the license
  * CreativeCommons ShareAlike-Attribution
@@ -17,7 +18,7 @@
  *   (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
+ * - An L293 IC
  * - A DC Birirectional Motor (max 5V-4mA)
  * - A breadboard
  *
@@ -37,7 +38,7 @@
 //import the library in the sketch
 #include <L293.h>
 
-//these variables are constants and won't change
+//these 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

keywords.txt

@@ -4,9 +4,13 @@
 # Constants (LITERAL1)
 #######################################
 
-L293_standalone	KEYWORD1
+L293			KEYWORD1
 L293_twoWire	KEYWORD1
+stop			KEYWORD2
+setPWMOffset	KEYWORD2
+getRawPWMDC		KEYWORD2
+getPWMDC		KEYWORD2
 forward			KEYWORD2
 back			KEYWORD2
-stop			KEYWORD2
-setSpeedOffset	KEYWORD2
+getDirection	KEYWORD2
+forceStop		KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=L293
-version=2.0.0
+version=3.0.0
 author=Giuseppe Masino <http://www.facebook.com/peppe.masino1>
 maintainer=Giuseppe Masino <http://www.facebook.com/peppe.masino1>
 sentence=Allow to control brushless motors with L293 motor driver