Committed release v3.1.0

Author: Giuseppe Masino

Changelog.md

@@ -1,56 +1,94 @@
-symbols caption:
-> \+ added
-> \- removed
-> = 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**  
-> = 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
+# Change Log  
+All notable changes to this project will be documented in this file.  
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)  
+and this project adheres to [Semantic Versioning](http://semver.org/).  
+
+[![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com)
+[![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org)
+
+
+## [Unreleased] ##
+
+### Removed ###
+
+- The ***getDirection()*** method  
+
+## [3.1.0] - 2017-06-17 ##
+
+### Added ###
+
+- The following methods to detect the motor's status:
+	- ***isForceStopped()***  
+	- ***isStopped()***  
+	- ***isForward()***  
+	- ***isReverse()***  
+- Better Doxigen-style comments  
+
+### Changed ###
+
+- This changelog format is now based on [Keep a Changelog](http://keepachangelog.com/)  
+- Rewrote the changelog to accomplish what about the previous point  
+- Renamed the changelog file for the same purpose  
+- **Updated the repository URL**  
+- Updated **README.md**  
+- Made the code more modular and extensible  
+- Made a general cleanup of the code
+- Merged the examples that share most code  
+
+### Deprecated ###
+
+- The ***getDirection()*** method is now replaced by the methods ***isForward(), isReverse(), isStopped()*** and ***isForceStopped()***  
+
+## [3.0.0] - 2017-01-04 ##
+
+### Added ###
+
+- Now is possible to change the motor direction without affect the current speed using a dedicated method
+- A method to get the direction of the motor  
+- A method to get the current PWM value  
+- A method to **"force stop"** the motor  
+
+### Changed ###
+
+- Updated **README.md**
+- Now the class **L293\_standalone** is named **L293**
+- Rewrote the code for the **L293** class
+- Now the method **setSpeedOffset()** is named **setPWMOffset()**
+
+### Fixed ###
+
+- A bug about the timing when switching a motor from the forward mode to the reverse mode and viceversa, now it is immediate
+
+## [2.0.0] - 2016-10-16 ##
+
+### Added ###
+
+- A new class named **L293\_twoWire**, derived from **L293\_standalone**, that adds support for motor control using only two wires.
+- Better comments to the code  
+- The file **LICENSE.md**  
+- New examples  
+
+### Changed ###
+
+- Corrected some mistakes in **README.md**
+- Updated the old examples
+- Now the class **L293** is named **L293\_ standalone**
+- Now the **speed Offset** can be a value beetween -255 and 255
+
+## [1.0.1] - 2016-08-25 ##
+
+### Removed ###
+
+- Some useless code
+
+### Changed ###
+
+- Updated the repository URL
+- Rewrited **README.md**
+
+## [1.0.0] - 2016-08-11 ##
+
+### Added ###
+
+- Unreleased library files

LICENSE.md

@@ -1,10 +1,10 @@
-#LICENSE
+# 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 />
-<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:  
+<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/qub1750ul/Arduino_L293" property="cc:attributionName" rel="cc:attributionURL">Giuseppe Masino (qub1750ul)</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.   
 
@@ -16,4 +16,4 @@ If you need permissions that are beyond the scope of this license, you can ask t
 
 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
+Otherwise, the full license text can be found here: https://creativecommons.org/licenses/by-sa/4.0/legalcode

README.md

@@ -1,92 +1,38 @@
 # L293 #
 
-Compatible architecture: ALL
+![Project status badge](https://img.shields.io/badge/Project%20status-ACTIVE-brightgreen.svg)
+[![License badge](https://img.shields.io/badge/license-custom%20CC%20BY--SA%204.0-brightgreen.svg)](https://github.com/qub1750ul/Arduino_L293/blob/master/LICENSE.md)  
+[![Arduino Library specification badge](https://img.shields.io/badge/Arduino%20Library%20Specification%20-rev.%202.1-blue.svg)](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification)
+[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-blue.svg)](https://www.arduino.cc/en/Main/Software)  
+[![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com)
+[![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org)
 
-## Description ##
-
-Library that allows to control bidirectional motors using the L293 IC in two different hardware configurations:
-
-- standalone
-- twoWire
-
-### standalone configuration ###
-
-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)
-
-### 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)
+An Arduino library that allows to control bidirectional motors using the L293 IC and compatible L298 boards.  
 
-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 ##
-### 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 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)  
-					  
-- 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 only ###
+## Description ##
 
-- Creating an istance  
+This library is designed to make easy the control of bidirectional motors either for beginners or for experts, providing a level of abstraction over the direct "lower-level" management of the MCU I/O ports that drive the H-bridge(s).
 
-    *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)  
+This means that the programmer haven't to care about the implementation of the control code and timings and can focus on the desired behavior.
 
+The main goal of this library is to be simple to use for beginners but flexible for experts.
 
+[Checkout the wiki for more information](https://github.com/qub1750ul/Arduino_L293/wiki/)  
 
-## About the author & license info
+## About the author & license info ##
 
 <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:  
+<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://facebook.com/dev.giuseppemasino" 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.   
+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.  
+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.  
+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>
 
-The text of this license can also be found in the LICENSE.md file
+The text of this license can also be found in the LICENSE.md file