Fixed MQ-131 Issue

Value of _RLValue - Added getRL and setRL method

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,49 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the examples that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] MQ-3
+- [ ] MQ-4
+- [ ] MQ-5
+- [ ] MQ-6
+- [ ] MQ-7
+- [ ] MQ-8
+- [ ] MQ-9
+- [ ] MQ-131
+- [ ] MQ-135
+- [ ] MQ-303
+- [ ] MQ-309
+- [ ] ESP8266
+- [ ] ESP-32
+
+**Test Configuration**:
+* Board:
+* Software (Version of your arduino):
+* Result (Good - Medium - Bad):
+* Your Comments:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

Internal_design_documents/Experiments/.ipynb_checkpoints/LinearRegression-checkpoint.ipynb

@@ -1,6 +0,0 @@
-{
- "cells": [],
- "metadata": {},
- "nbformat": 4,
- "nbformat_minor": 2
-}

README.md

@@ -1,20 +1,122 @@
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![DOI](https://zenodo.org/badge/170540207.svg)](https://zenodo.org/badge/latestdoi/170540207)
+![Build Status][build-url]
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
 # MQSensorsLib
 
-This is a unified library to use sensors MQ: 2, 3, 4, 5, 6, 7, 8, 9, 131, 135, 303A and 309A.
+We present a unified library for MQ sensors, this library allows to read MQ signals easily from Arduino, Genuino, ESP8266, ESP-32 boards whose references are MQ2, MQ3, MQ4, MQ5, MQ6, MQ7, MQ8, MQ9, MQ131, MQ135, MQ303A, MQ309A.
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+* [Getting Started](#Getting-Started)
+* [Wiring](#Wiring)
+  * [Sensor](#Sensor)
+  * [Arduino](#Arduino)
+  * [ESP8266 or ESP-32](#ESP8266-ESP32)
+* [User Manual](#Manuals)
+* [Sensor manufacturers](#Sensor-manufacturers)
+* [Contributing](#Contributing)
+* [Authors](#Authors)
 
 ## Getting Started
 
 ```
-MQUnifiedsensor MQ4(pin, 4); //Example if sensor is MQ4, type = 4
+//Include the library
+#include <MQUnifiedsensor.h>
+/************************Hardware Related Macros************************************/
+#define         Board                   ("Arduino UNO")
+#define         Pin                     (A4)  //Analog input 4 of your arduino
+/***********************Software Related Macros************************************/
+#define         Type                    ("MQ-4") //MQ4
+#define         Voltage_Resolution      (5)
+#define         ADC_Bit_Resolution      (10) // For arduino UNO/MEGA/NANO
+#define         RatioMQ4CleanAir        (4.4) //RS / R0 = 60 ppm 
+/*****************************Globals***********************************************/
+//Declare Sensor
+MQUnifiedsensor MQ4(Board, Voltage_Resolution, ADC_Bit_Resolution, Pin, Type);
+// Setup
+MQ4.setRegressionMethod("Exponential"); //_PPM =  a*ratio^b
+MQ4.setA(1012.7); MQ4.setB(-2.786); // Configurate the ecuation values to get CH4 concentration
+MQ4.setR0(3.86018237); // Value getted on calibration
+// Loop
+MQ4.init();
+MQ4.update();
 float ppmCH4 = MQ4.readSensor();
 ```
 
+## Wiring
+### Sensor
+#### Important points:
+##### Points you should identify
+* VCC -> 5V Power supply (+) wire
+* GND -> GND Ground (-) wire
+* AO -> Analog Output of the sensor
+##### Data of board that you should have
+* RL Value in KOhms
+##### Graph
+![Wiring_MQSensor](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/Points_explanation.jpeg)
+#### RS/R0 value (From datasheet of your sensor)
+* RS/R0 (Clean air - English) -> (Aire puro - Spanish)
+* **Note**: RS/R0 is equal to Ratio variable on the program
+![Graph from datasheet](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/Graph_Explanation.jpeg)
+### Arduino
+![Arduino_Wiring_MQSensor](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/MQ_Arduino.PNG)
+#### MQ-7 / MQ-309A
+** Note ** [issue](https://github.com/miguel5612/MQSensorsLib/issues/26): MQ-7 and MQ-309 needs two different voltages for heater, they can be supplied by PWM and DC Signal controlled by your controller, another option is to use two different power sources, you should use the best option for you, next i will show the PWM option and on the examples this will be the way .
+![MQ-7_MQ-309](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/MQ-309_MQ-7.PNG)
+### ESP8266-ESP32
+![ESP8266_Wiring_MQSensor](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/MQ_ESP8266.PNG)
+
+### Manuals
+#### User Manual (v1.0) 12.2019
+[Manual](https://drive.google.com/open?id=1BAFInlvqKR7h81zETtjz4_RC2EssvFWX)
+#### User Manual (v2.0) 04.2020
+[Manual](https://github.com/miguel5612/MQSensorsLib_Docs/blob/master/Docs/MQSensorLib_2.0.pdf)
+
+
+### Serial debug (optional)
+If your sensor is an **MQ2** (Same for others sensors):
+* To enable on setup wrote
+```
+MQ2.serialDebug(true); 
+```
+* And on Loop Wrote
+```
+MQ2.serialDebug(); 
+```
+* Result:
+
+![Serial debug output](https://github.com/miguel5612/MQSensorsLib_Docs/blob/master/static/img/Serial_Mon_Explanation.jpeg?raw=true)
+
+**Note**: 
+* ![#c5f015](https://placehold.it/15/c5f015/000000?text=+) `Yellow -> Calibration status.`
+* ![#008000](https://placehold.it/15/008000/000000?text=+) `Green -> Hardware and software characteristics.`
+* ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) `Red -> Headers of the library calculations.`
+* Only valid for **1** gas sensor readings.
+
+**Usage**
+* Quick troubleshooting, since it shows everything the library does and the results of the calculations in each function.
+
 ### Prerequisites
 
-You'll need Arduino desftop app 1.8.9 or later.
+You'll need Arduino desktop app 1.8.9 or later.
 
-### Sensor manufacter:
-| Sensor | Manufacter | URL Datasheet |
+### Sensor manufacturers:
+| Sensor | Manufacture | URL Datasheet |
 |----------|----------|----------|
 | MQ-2 | Pololulu| [datasheet](https://www.pololu.com/file/0J309/MQ2.pdf) |
 | MQ-3 | Sparkfun | [datasheet](https://www.sparkfun.com/datasheets/Sensors/MQ-3.pdf) |
@@ -31,11 +133,11 @@ You'll need Arduino desftop app 1.8.9 or later.
 
 ### Info of datasheets 
 
-Review WPDigitalizer [folder](https://github.com/miguel5612/MQSensorsLib/tree/master/WPDigitalizer) [website](https://automeris.io/WebPlotDigitizer/)
+Review WPDigitalizer [folder](https://github.com/miguel5612/MQSensorsLib_Docs/tree/master/WPDigitalizer) [website](https://automeris.io/WebPlotDigitizer/)
 
 ### Installing
 
-Clone this repositry into your desktop machine
+Clone this repository into your desktop machine
 
 ```
 git clone https://github.com/miguel5612/MQSensorsLib
@@ -48,7 +150,7 @@ Use calibration systems if you have several sensors that read the same gas.
 
 ### Break down into end to end tests
 
-These test can re-adjust values defined previously and you can contribute to improve conditions or features obtained from particular scenes.
+These tests can re-adjust values defined previously and you can contribute to improve conditions or features obtained from particular scenes.
 
 ```
 Examples/MQ-3
@@ -56,7 +158,7 @@ Examples/MQ-3
 
 ### And coding style tests
 
-These tests may generate statistics validation using descriptive tools for cuantitative variables.
+These tests may generate statistics validation using descriptive tools for quantitative variables.
 
 ```
 Examples/MQ-board.ino
@@ -64,12 +166,12 @@ Examples/MQ-board.ino
 
 ## Built With
 
-* [Data sheets](https://github.com/miguel5612/MQSensorsLib/tree/master/Datasheets) - Curves and behavior for each sensor, using logarithmic graphs.
-* [Main purpose](https://github.com/miguel5612/MQSensorsLib/blob/master/static/img/bg.jpg) - Every sensor has high sensibility for a specific gas or material.
+* [Data sheets](https://github.com/miguel5612/MQSensorsLib_Docs/tree/master/Datasheets) - Curves and behavior for each sensor, using logarithmic graphs.
+* [Main purpose](https://github.com/miguel5612/MQSensorsLib_Docs/blob/master/static/img/bg.jpg) - Every sensor has high sensibility for a specific gas or material.
 
 ## Contributing
 
-Please read [CONTRIBUTING.md](https://github.com/miguel5612/MQSensorsLib/blob/NO_Functional/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+Please read [CONTRIBUTING.md](https://github.com/miguel5612/MQSensorsLib/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
 ## Authors
 
@@ -77,10 +179,10 @@ Please read [CONTRIBUTING.md](https://github.com/miguel5612/MQSensorsLib/blob/NO
 * **Ghiordy F. Contreras C.** - [*GitHub*](https://github.com/Ghiordy) - [CV](https://scienti.colciencias.gov.co/cvlac/visualizador/generarCurriculoCv.do?cod_rh=0000050476) 
 * **Yersson R. Carrillo A.** - [*GitHub*](https://github.com/Yercar18/Dronefenix)  - [CV](https://scienti.colciencias.gov.co/cvlac/visualizador/generarCurriculoCv.do?cod_rh=0001637655)
 
-## Colaborators
+## Collaborators
 
-* **Andres A. Martinez.** 
-* **Juan A. Rodríguez.** - [*Github*](https://github.com/Obiot24)
+* **Andres A. Martinez.** - [*Github*](https://github.com/andresmacsi) - [CV](https://www.linkedin.com/in/andr%C3%A9s-acevedo-mart%C3%ADnez-73ab35185/?originalSubdomain=co)
+* **Juan A. Rodríguez.** - [*Github*](https://github.com/Obiot24) - [CV]()
 * **Mario A. Rodríguez O.** - [*GitHub*](https://github.com/MarioAndresR) - [CV](https://scienti.colciencias.gov.co/cvlac/visualizador/generarCurriculoCv.do?cod_rh=0000111304)
 
 See also the list of [contributors](https://github.com/miguel5612/MQSensorsLib/contributors) who participated in this project.
@@ -88,3 +190,66 @@ See also the list of [contributors](https://github.com/miguel5612/MQSensorsLib/c
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Cite as
+
+* Plain text: Califa Urquiza, Miguel Angel, Contreras Contreras, Ghiordy, & Carrillo Amado, Yerson Ramiro. (2019, September 3). miguel5612/MQSensorsLib: Arduino Preview V1.03 (Version 1.0.3). Zenodo. http://doi.org/10.5281/zenodo.3384301
+* CSL: {
+  "publisher": "Zenodo", 
+  "DOI": "10.5281/zenodo.3384301", 
+  "title": "miguel5612/MQSensorsLib: Arduino Preview V1.03", 
+  "issued": {
+    "date-parts": [
+      [
+        2019, 
+        9, 
+        3
+      ]
+    ]
+  }, 
+  "abstract": "<p>Publishing on Zenodo platform as software in order to extend its applications for other works allowing to recognize MQSensorLib&#39;s Authors this work into scientific community using Digital Object Identifier System (DOI).</p>", 
+  "author": [
+    {
+      "family": "Califa Urquiza, Miguel Angel"
+    }, 
+    {
+      "family": "Contreras Contreras, Ghiordy"
+    }, 
+    {
+      "family": "Carrillo Amado, Yerson Ramiro"
+    }
+  ], 
+  "version": "1.0.3", 
+  "type": "article", 
+  "id": "3384301"
+}
+* BibTeX: 
+@misc{califa_urquiza_miguel_angel_2019_3384301,
+  author       = {Califa Urquiza, Miguel Angel and
+                  Contreras Contreras, Ghiordy and
+                  Carrillo Amado, Yerson Ramiro},
+  title        = {miguel5612/MQSensorsLib: Arduino Preview V1.03},
+  month        = sep,
+  year         = 2019,
+  doi          = {10.5281/zenodo.3384301},
+  url          = {https://doi.org/10.5281/zenodo.3384301}
+}
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/miguel5612/MQSensorsLib.svg?style=flat-square
+[contributors-url]: https://github.com/miguel5612/MQSensorsLib/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/miguel5612/MQSensorsLib.svg?style=flat-square
+[forks-url]: https://github.com/miguel5612/MQSensorsLib/network/members
+[stars-shield]: https://img.shields.io/github/stars/miguel5612/MQSensorsLib.svg?style=flat-square
+[stars-url]: https://github.com/miguel5612/MQSensorsLib/stargazers
+[issues-shield]: https://img.shields.io/github/issues/miguel5612/MQSensorsLib.svg?style=flat-square
+[issues-url]: https://github.com/miguel5612/MQSensorsLib/issues
+[license-shield]: https://img.shields.io/github/license/miguel5612/MQSensorsLib.svg?style=flat-square
+[license-url]: https://github.com/miguel5612/MQSensorsLib/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
+[build-url]: https://travis-ci.org/dwyl/esta.svg?branch=master
+[linkedin-url]: https://www.linkedin.com/in/miguel5612
+[product-screenshot]: images/screenshot.png

WPDigitalizer/MQ131/CL2.csv

@@ -1,5 +0,0 @@
-4.957713628975931; 5.970352865838375
-9.82303087255475; 3.890451449942809
-19.66936860744601; 2.365919697485761
-49.50200098710442; 0.9908319448927686
-99.17887133636847; 0.49659232145033677

WPDigitalizer/MQ131/NOx.csv

@@ -1,5 +0,0 @@
-5.004690736196025; 8.090958991783829
-9.81247228520288; 5.571857489319305
-19.63847609606165; 3.9994474976109777
-49.85956704514034; 2.8313919957993816
-98.7613064604988; 2.032357010936224

WPDigitalizer/MQ131/O3.csv

@@ -1,5 +0,0 @@
-5.015052099488824; 4.055085354483843
-9.839297042431014; 2.2387211385683425
-19.708460197689764; 1.2189895989248674
-50.120105449151986; 0.49659232145033727
-99.34721307419954; 0.2818382931264458

WPDigitalizer/MQ135/Acetona.csv

@@ -1,3 +0,0 @@
-10.038068731719024; 1.4367778871086752
-100.76282386271518; 0.7437057711666111
-199.67791490816478; 0.5858066785834567

WPDigitalizer/MQ135/Alcohol.csv

@@ -1,3 +0,0 @@
-10; 1.8980643862295867
-100.76282386271518; 0.9276207214357883
-199.67791490816478; 0.7371610501169261

WPDigitalizer/MQ135/CO.csv

@@ -1,3 +0,0 @@
-9.92429510870452; 2.850325339883499
-100.76282386271518; 1.5488850711364055
-199.67791490816478; 1.3446177759671738

WPDigitalizer/MQ135/CO2.csv

@@ -1,3 +0,0 @@
-10; 2.3054935712377356
-100.76282386271518; 1.049816136090719
-198.16625542394166; 0.8052859018667691

WPDigitalizer/MQ135/NH4.csv

@@ -1,3 +0,0 @@
-10; 2.563475521052897
-100.38068731719024; 1
-199.67791490816478; 0.7670732751979543

WPDigitalizer/MQ135/Tolueno.csv

@@ -1,3 +0,0 @@
-10; 1.5420548019516276
-100.38068731719024; 0.8017347542813508
-199.67791490816478; 0.6427786162225773

WPDigitalizer/MQ2/Alcohol.csv

@@ -1,9 +0,0 @@
-202,97159045689085; 2,870821251841819
-493,62843297110385; 2,120486081991352
-789,3018264543583; 1,722949305824931
-1013,5564768245204; 1,628558370192401
-1483,4109724050659; 1,4241031945513674
-2002,568136043121; 1,2616407836292618
-3045,8553406742876; 1,09372808300933
-4983,9913111605565; 0,8886628824162796
-10116,086432495827; 0,6593474448589979

WPDigitalizer/MQ2/CH4.csv

@@ -1,9 +0,0 @@
-200,6424043638923; 3,0628594206904824
-493,62843297110385; 2,262307524341795
-795,3985507023424; 1,9027463399615197
-1021,3853885815306; 1,760109364516406
-1466,3881949840988; 1,512822440016997
-2010,2873757128875; 1,3635579819828156
-3022,508881097584; 1,1618613226754184
-4945,78905312065; 0,9359079659557669
-10155,080609166793; 0,7034431020028873