Committing dev changes

Author: Main Push Robot

README.md

@@ -1,27 +1,27 @@
-# NAZIV PROIZVODA Arduino library
+# MQ-X Arduino library
 
 [![Compile Sketches](http://github-actions.40ants.com/e-radionicacom/Soldered-Generic-Arduino-Library/matrix.svg?branch=dev&only=Compile%20Sketches)](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/compile_test.yml)
 [![Make docs and publish to GitHub Pages](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/make_docs.yml/badge.svg?branch=dev)](https://github.com/e-radionicacom/Soldered-Generic-Arduino-Library/actions/workflows/make_docs.yml)
 
-| ![Product name](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
+| ![MQ-X](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) |
 | :---------------------------------------------------------------------------------------------: |
-| [NAZIV PROIZVODA](https://www.solde.red/SKU)                                                            |
+| [MQ-X](https://www.solde.red/333041)                                                            |
 
-OPIS PROIZVODA + LINK NA [easyC ecosystem](https://www.soldered.com/easyC). 
+MQ-X Gas Sensors Arduino Library soon to be compliant to [easyC ecosystem](https://www.soldered.com/easyC). 
 
 ### Repository Contents
 - **/src** - source files for the library (.h & .cpp)
 - **/examples** - examples for using the library
 - ***other*** - *keywords* file highlights function words in your IDE, *library.properties* enables implementation with Arduino Library Manager.
 
 ### Hardware design
-You can find hardware design for this board in NAZIV PROIZVODA hardware repository
+You can find hardware design for this board in MQ-X Soldered Library hardware repository
 
 ### Documentation
 
 Access Arduino library documentation [here](https://e-radionicacom.github.io/Soldered-Generic-Arduino-Library/).
 
-- Tutorial for using the NAZIV PROIZVODA board
+- Tutorial for using the MQ-X Sensor Soldered board
 - Installing an Arduino library
 
 ### About Soldered
@@ -37,7 +37,7 @@ At Soldered, we design and manufacture a wide selection of electronic products t
 
 ### Original source
 ​
-This library is possible thanks to original [arduino-mcp23017](https://github.com/blemasle/arduino-mcp23017) library. Thank you, blemasle. 
+This library is possible thanks to original [MQSensorsLib](https://github.com/miguel5612/MQSensorsLib) library. Thank you, miguel5612. 
 
 
 ### Open-source license

examples/AlgorithmTester/AlgorithmTester.ino

@@ -0,0 +1,237 @@
+// Include the library
+#include "MQ-Sensor-SOLDERED.h"
+
+// Wiring NOT required, only an arduino or esp8266 board
+
+/*
+    This program was made to test the algorithm that from the ratio obtains
+    the PPM (The core of this library), regardless of the plate in which the
+    result is executed should give a small error (ideally less than 5%), is
+    our way of self-evaluation, we tell the library what is the value of the
+    ratio and ask him to calculate the PPM and compare it against the value
+    that should really give, these values were taken from the same datasheet
+    with which the library was made.
+*/
+
+// Include the library
+#include "MQ-Sensor-SOLDERED.h"
+
+// Declare Sensor, any MQ will work
+MQ2 sensor(A1);
+
+/*****************************Globals***********************************************/
+double ratio[4] = {};
+double expectedValue[4] = {};
+double calculatedValues[4] = {};
+double error[4] = {};
+/**************************Object_Sensor********************************************/
+
+void setup()
+{
+    // Init serial port
+    Serial.begin(115200);
+    // init the sensor
+    sensor.begin();
+
+    // Print in serial monitor
+    Serial.println("MQ2 to MQ9 - test program");
+}
+
+void loop()
+{
+    // Testing MQ2 LPG
+    ratio[0] = 1.8;
+    ratio[1] = 1.05;
+    ratio[2] = 0.8;
+    ratio[3] = 0.5;
+    expectedValue[0] = 200;
+    expectedValue[1] = 500;
+    expectedValue[2] = 1000;
+    expectedValue[3] = 3000;
+    testSensor("MQ-2", 574.25, -2.222);
+
+    // Testing MQ3 Benzene
+    ratio[0] = 4;
+    ratio[1] = 3;
+    ratio[2] = 1;
+    ratio[3] = 0.8;
+    expectedValue[0] = 0.1;
+    expectedValue[1] = 0.21;
+    expectedValue[2] = 4;
+    expectedValue[3] = 10;
+    testSensor("MQ-3", 4.8387, -2.68);
+
+    // Testing MQ4 CH4
+    ratio[0] = 1.9;
+    ratio[1] = 1;
+    ratio[2] = 0.6;
+    ratio[3] = 0.42;
+    expectedValue[0] = 200;
+    expectedValue[1] = 1000;
+    expectedValue[2] = 5000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-4", 1012.7, -2.786);
+
+    // Testing MQ5 H2
+    ratio[0] = 1.8;
+    ratio[1] = 1.3;
+    ratio[2] = 0.8;
+    ratio[3] = 0.68;
+    expectedValue[0] = 200;
+    expectedValue[1] = 500;
+    expectedValue[2] = 3000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-5", 1163.8, -3.874);
+
+    // Testing MQ6 CH4
+    ratio[0] = 2.6;
+    ratio[1] = 1.9;
+    ratio[2] = 1;
+    ratio[3] = 0.8;
+    expectedValue[0] = 200;
+    expectedValue[1] = 500;
+    expectedValue[2] = 2000;
+    expectedValue[3] = 5000;
+    testSensor("MQ-6", 2127.2, -2.526);
+
+    // Testing MQ7 CO
+    ratio[0] = 1.8;
+    ratio[1] = 1;
+    ratio[2] = 0.4;
+    ratio[3] = 0.25;
+    expectedValue[0] = 50;
+    expectedValue[1] = 100;
+    expectedValue[2] = 400;
+    expectedValue[3] = 1000;
+    testSensor("MQ-7", 99.042, -1.518);
+
+    // Testing MQ8 H2
+    ratio[0] = 2.6;
+    ratio[1] = 1;
+    ratio[2] = 0.21;
+    ratio[3] = 0.03;
+    expectedValue[0] = 500;
+    expectedValue[1] = 1000;
+    expectedValue[2] = 3000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-8", 976.97, -0.688);
+
+    // Testing MQ9 LPG
+    ratio[0] = 2;
+    ratio[1] = 1.4;
+    ratio[2] = 0.7;
+    ratio[3] = 0.23;
+    expectedValue[0] = 200;
+    expectedValue[1] = 500;
+    expectedValue[2] = 2000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-9", 1000.5, -2.186);
+
+    // Testing MQ131 O3
+    ratio[0] = 5;
+    ratio[1] = 2;
+    ratio[2] = 0.7;
+    ratio[3] = 0.5;
+    expectedValue[0] = 5;
+    expectedValue[1] = 20;
+    expectedValue[2] = 70;
+    expectedValue[3] = 100;
+    testSensor("MQ-131", 23.943, -1.11);
+
+    // Testing MQ135 NH4
+    ratio[0] = 2.6;
+    ratio[1] = 1.9;
+    ratio[2] = 1.1;
+    ratio[3] = 0.75;
+    expectedValue[0] = 10;
+    expectedValue[1] = 20;
+    expectedValue[2] = 100;
+    expectedValue[3] = 200;
+    testSensor("MQ-135", 102.2, -2.473);
+
+    // Testing MQ303 Isobutano
+    ratio[0] = 0.4;
+    ratio[1] = 0.3;
+    ratio[2] = 0.19;
+    ratio[3] = 0.08;
+    expectedValue[0] = 100;
+    expectedValue[1] = 300;
+    expectedValue[2] = 1000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-303", 6.2144, -2.894);
+
+    // Testing MQ309 CO
+    ratio[0] = 6;
+    ratio[1] = 5;
+    ratio[2] = 4.3;
+    ratio[3] = 4;
+    expectedValue[0] = 1000;
+    expectedValue[1] = 3000;
+    expectedValue[2] = 5000;
+    expectedValue[3] = 7000;
+    testSensor("MQ-309", 1000000, -4.01);
+
+    // Testing linear equation for MQ-4
+    sensor.setRegressionMethod(0); //_PPM =  pow(10, (log10(ratio)-b)/a)
+    ratio[0] = 2.5;
+    ratio[1] = 1.5;
+    ratio[2] = 0.9;
+    ratio[3] = 0.65;
+    expectedValue[0] = 200;
+    expectedValue[1] = 1000;
+    expectedValue[2] = 5000;
+    expectedValue[3] = 10000;
+    testSensor("MQ-4", -0.318, 1.133);
+
+    while (1)
+        ;
+}
+
+
+void testSensor(String SensorName, float A, float B)
+{
+    sensor.setA(A);
+    sensor.setB(B);
+    calculatedValues[0] = sensor.validateEcuation(ratio[0]);
+    calculatedValues[1] = sensor.validateEcuation(ratio[1]);
+    calculatedValues[2] = sensor.validateEcuation(ratio[2]);
+    calculatedValues[3] = sensor.validateEcuation(ratio[3]);
+    error[0] = calculatePercentualError(expectedValue[0], calculatedValues[0]);
+    error[1] = calculatePercentualError(expectedValue[1], calculatedValues[1]);
+    error[2] = calculatePercentualError(expectedValue[2], calculatedValues[2]);
+    error[3] = calculatePercentualError(expectedValue[3], calculatedValues[3]);
+
+    Serial.print("Error(%) ");
+    Serial.print(SensorName);
+    Serial.print(": ");
+    Serial.print(error[0]);
+    Serial.print(" ");
+    Serial.print(error[1]);
+    Serial.print(" ");
+    Serial.print(error[2]);
+    Serial.print(" ");
+    Serial.print(error[3]);
+    Serial.print(" | Calculated(PPM): ");
+    Serial.print(calculatedValues[0]);
+    Serial.print(" ");
+    Serial.print(calculatedValues[1]);
+    Serial.print(" ");
+    Serial.print(calculatedValues[2]);
+    Serial.print(" ");
+    Serial.print(calculatedValues[3]);
+    Serial.print(" | Expected(PPM): ");
+    Serial.print(expectedValue[0]);
+    Serial.print(" ");
+    Serial.print(expectedValue[1]);
+    Serial.print(" ");
+    Serial.print(expectedValue[2]);
+    Serial.print(" ");
+    Serial.print(expectedValue[3]);
+    Serial.println(" | ");
+}
+
+double calculatePercentualError(double expectedValue, double calculatedValue)
+{
+    // Return the diference between two measures
+    return abs(calculatedValue - expectedValue) / expectedValue;
+}

examples/Calibration/Calibration.ino

@@ -0,0 +1,71 @@
+/*
+  MQUnifiedsensor Library - calibrating an mq2
+
+  Demonstrates the use a mq2 sensor.
+  Library originally added 01 may 2019
+  by Miguel A Califa, Yersson Carrillo, Ghiordy Contreras, Mario Rodriguez
+
+  Added example
+  modified 27 May 2019
+  by Miguel Califa
+
+ This example code is in the public domain.
+
+*/
+
+// Include the library
+#include "MQ-Sensor-SOLDERED.h"
+
+double alcoholPPM = (0);
+// Defaults, uncomment if you need
+#define RatioMQ2CleanAir 9.83 // RS / R0 = 9.83 ppm
+//#define RatioMQ3CleanAir 60   //RS / R0 = 60 ppm
+//#define RatioMQ4CleanAir 4.4  //RS / R0 = 4.4 ppm
+//#define RatioMQ5CleanAir 6.5  //RS / R0 = 6.5 ppm
+//#define RatioMQ6CleanAir 10   //RS / R0 = 10 ppm
+//#define RatioMQ7CleanAir 27.5 //RS / R0 = 27.5 ppm
+//#define RatioMQ8CleanAir 70   //RS / R0 = 70 ppm
+//#define RatioMQ9CleanAir 9.6  //RS / R0 = 9.6 ppm
+//#define RatioMQ131CleanAir 15 //RS / R0 = 15 ppm
+//#define RatioMQ135CleanAir 3.6//RS / R0 = 3.6 ppm
+//#define RatioMQ303CleanAir 1  //RS / R0 = 1 ppm
+//#define RatioMQ309CleanAir 11 //RS / R0 = 11 ppm
+
+unsigned long counter = 0;
+
+
+MQ2 mq2(A1);
+
+void setup()
+{
+    // Init serial port
+    Serial.begin(115200);
+    mq2.setRegressionMethod(1); //_PPM =  a*ratio^b
+    mq2.setA(574.25);
+    mq2.setB(-2.222); // Configurate the ecuation values to get LPG concentration
+    /*
+      //If the RL value is different from 10K please assign your RL value with the following method:
+      MQ3.setRL(10);
+    */
+    // init the sensor
+    mq2.begin();
+    // Print in serial monitor
+    Serial.println("mq2 - Calibracion");
+    Serial.println("Note - Make sure you are in a clean room and the sensor has pre-heated almost 4 hours");
+    Serial.println("Autonumeric | lecture (R0)");
+}
+
+void loop()
+{
+    mq2.update();
+    // Read the sensor and print in serial port
+    float lecture = mq2.calibrate(RatioMQ2CleanAir);
+    // Print in serial monitor
+    Serial.print(counter);
+    Serial.print(" | ");
+    Serial.println(lecture);
+    // Increment counter
+    counter++;
+    // Wait to measure next sample
+    delay(400);
+}