From 6376cfc11f96c3659d7b7fd104f9728f5eb0cc1d Mon Sep 17 00:00:00 2001 From: Miguel Angel Califa Urquiza Date: Wed, 4 Jun 2025 17:45:49 -0500 Subject: [PATCH] doc: add issues summary --- README.md | 5 +++++ docs/issues.md | 31 +++++++++++++++++++++++++++++++ library.properties | 2 +- src/MQUnifiedsensor.cpp | 22 ++++++++++++++++------ src/MQUnifiedsensor.h | 3 +++ 5 files changed, 56 insertions(+), 7 deletions(-) create mode 100644 docs/issues.md diff --git a/README.md b/README.md index 0251259..a4dbc03 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ float ppmCH4 = MQ4.readSensor(); * AO -> Analog Output of the sensor ##### Data of board that you should have * RL Value in KOhms +* If the sensor uses a different supply voltage than the ADC reference, call `yourSensor.setVCC();` ##### Graph ![Wiring_MQSensor](https://raw.githubusercontent.com/miguel5612/MQSensorsLib_Docs/master/static/img/Points_explanation.jpeg) #### RS/R0 value (From datasheet of your sensor) @@ -173,6 +174,10 @@ Examples/MQ-board.ino * [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. +## Issues + +Consulte [docs/issues.md](docs/issues.md) para un resumen de los problemas abiertos y sus soluciones. + ## Contributing 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. diff --git a/docs/issues.md b/docs/issues.md new file mode 100644 index 0000000..a2ed000 --- /dev/null +++ b/docs/issues.md @@ -0,0 +1,31 @@ +# Issues y soluciones + +Este documento resume los problemas reportados en el repositorio y las soluciones propuestas o implementadas. + +## Abiertos + +### #75 MQ-3 sensor and CH4 gas reading 'ovf' failure +**Estado:** abierto + +El usuario reporta desbordamiento ("ovf") al utilizar valores muy altos en `setA` y `setB` para leer CH4 con un sensor MQ-3. La solución propuesta es revisar los valores utilizados en `setA` y `setB`, ya que `2*10^31` en C++ no corresponde a `2e31`. Se recomienda usar notación exponencial (`2e31`) o `pow(10,31)` y comprobar que los parámetros no excedan el rango de `float`. + +### #74 possible error in the calculation formula for `_RS_Calc` +**Estado:** resuelto en la rama `work` + +Se detectó que la resistencia del sensor se calculaba con `_VOLT_RESOLUTION` en lugar del voltaje de alimentación real. Se añadieron los métodos `setVCC` y `getVCC` y se modificaron las ecuaciones para usar `VCC`. Esta corrección se refleja en la versión 3.0.1 de la biblioteca. + +### #70 Parameters to model temperature and humidity dependence +**Estado:** abierto + +Los usuarios solicitan factores de corrección para temperatura y humedad aplicables a otros sensores (MQ-4 y MQ-8) además del MQ-135. Aún no se han añadido estos parámetros. Se anima a la comunidad a contribuir con implementaciones y ejemplos. + +### #67 Sensor won't finish the Calibration process if done in clean air +**Estado:** abierto + +Se reporta que la calibración se detiene mostrando un mensaje de "Conection issue" cuando se intenta calibrar el sensor MQ-135 en aire limpio. La recomendación del mantenedor es revisar la conexión física y probar el sensor con un programa básico para asegurar su correcto funcionamiento antes de usar la librería. Aún no se ha implementado un cambio en el código. + + +## Cerrados destacados + +Para obtener más información sobre todos los issues cerrados, consulte la página de [Issues en GitHub](https://github.com/miguel5612/MQSensorsLib/issues?q=is%3Aissue+is%3Aclosed). + diff --git a/library.properties b/library.properties index e933f6d..8e4ac73 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=MQUnifiedsensor -version=3.0.0 +version=3.0.1 author= Miguel Califa , Yersson Carrillo, Ghiordy Contreras maintainer= Miguel Califa sentence= This library allows you to read the MQ sensors very easily. diff --git a/src/MQUnifiedsensor.cpp b/src/MQUnifiedsensor.cpp index 928210d..3588f31 100644 --- a/src/MQUnifiedsensor.cpp +++ b/src/MQUnifiedsensor.cpp @@ -10,6 +10,7 @@ MQUnifiedsensor::MQUnifiedsensor(String Placa, float Voltage_Resolution, int ADC //this->_type = type; //MQ-2, MQ-3 ... MQ-309A //this->_placa = Placa; this-> _VOLT_RESOLUTION = Voltage_Resolution; + this-> _VCC = Voltage_Resolution; this-> _ADC_Bit_Resolution = ADC_Bit_Resolution; } MQUnifiedsensor::MQUnifiedsensor(String Placa, String type) { @@ -41,6 +42,10 @@ void MQUnifiedsensor::setVoltResolution(float voltage_resolution) { _VOLT_RESOLUTION = voltage_resolution; } +void MQUnifiedsensor::setVCC(float vcc) +{ + _VCC = vcc; +} void MQUnifiedsensor::setPin(int pin) { this->_pin = pin; } @@ -59,6 +64,10 @@ float MQUnifiedsensor::getVoltResolution() { return _VOLT_RESOLUTION; } +float MQUnifiedsensor::getVCC() +{ + return _VCC; +} String MQUnifiedsensor::getRegressionMethod() { if(_regressionMethod == 1) return "Exponential"; @@ -85,7 +94,8 @@ void MQUnifiedsensor::serialDebug(bool onSetup) Serial.println("Contributors: Andres A. Martinez - Juan A. Rodríguez - Mario A. Rodríguez O "); Serial.print("Sensor: "); Serial.println(_type); - Serial.print("Supply voltage: "); Serial.print(_VOLT_RESOLUTION); Serial.println(" VDC"); + Serial.print("ADC voltage: "); Serial.print(_VOLT_RESOLUTION); Serial.println(" VDC"); + Serial.print("Sensor supply (VCC): "); Serial.print(_VCC); Serial.println(" VDC"); Serial.print("ADC Resolution: "); Serial.print(_ADC_Bit_Resolution); Serial.println(" Bits"); Serial.print("R0: "); Serial.print(_R0); Serial.println(" KΩ"); Serial.print("RL: "); Serial.print(_RL); Serial.println(" KΩ"); @@ -106,7 +116,7 @@ void MQUnifiedsensor::serialDebug(bool onSetup) else { Serial.print("|"); Serial.print(_adc); Serial.print("| v = ADC*"); Serial.print(_VOLT_RESOLUTION); Serial.print("/"); Serial.print((pow(2, _ADC_Bit_Resolution)) - 1); Serial.print(" | "); Serial.print(_sensor_volt); - Serial.print(" | RS = ((" ); Serial.print(_VOLT_RESOLUTION ); Serial.print("*RL)/Voltage) - RL| "); Serial.print(_RS_Calc); Serial.print(" | Ratio = RS/R0| "); + Serial.print(" | RS = ((" ); Serial.print(_VCC ); Serial.print("*RL)/Voltage) - RL| "); Serial.print(_RS_Calc); Serial.print(" | Ratio = RS/R0| "); Serial.print(_ratio); Serial.print( " | "); if(_regressionMethod == 1) Serial.print("ratio*a + b"); else Serial.print("pow(10, (log10(ratio)-b)/a)"); @@ -145,7 +155,7 @@ float MQUnifiedsensor::readSensor(bool isMQ303A, float correctionFactor, bool in if(isMQ303A) { _VOLT_RESOLUTION = _VOLT_RESOLUTION - 0.45; //Calculations for RS using mq303a sensor look wrong #42 } - _RS_Calc = ((_VOLT_RESOLUTION*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas + _RS_Calc = ((_VCC*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas if(_RS_Calc < 0) _RS_Calc = 0; //No negative values accepted. if(!injected) _ratio = _RS_Calc / this->_R0; // Get ratio RS_gas/RS_air _ratio += correctionFactor; @@ -164,7 +174,7 @@ float MQUnifiedsensor::readSensor(bool isMQ303A, float correctionFactor, bool in float MQUnifiedsensor::readSensorR0Rs() { //More explained in: https://jayconsystems.com/blog/understanding-a-gas-sensor - _RS_Calc = ((_VOLT_RESOLUTION*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas + _RS_Calc = ((_VCC*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas if(_RS_Calc < 0) _RS_Calc = 0; //No negative values accepted. _ratio = this->_R0/_RS_Calc; // Get ratio RS_air/RS_gas <- INVERTED for MQ-131 issue 28 https://github.com/miguel5612/MQSensorsLib/issues/28 if(_ratio <= 0) _ratio = 0; //No negative values accepted or upper datasheet recomendation. @@ -194,7 +204,7 @@ float MQUnifiedsensor::calibrate(float ratioInCleanAir) { */ float RS_air; //Define variable for sensor resistance float R0; //Define variable for R0 - RS_air = ((_VOLT_RESOLUTION*_RL)/_sensor_volt)-_RL; //Calculate RS in fresh air + RS_air = ((_VCC*_RL)/_sensor_volt)-_RL; //Calculate RS in fresh air if(RS_air < 0) RS_air = 0; //No negative values accepted. R0 = RS_air/ratioInCleanAir; //Calculate R0 if(R0 < 0) R0 = 0; //No negative values accepted. @@ -231,7 +241,7 @@ float MQUnifiedsensor:: setRsR0RatioGetPPM(float value) float MQUnifiedsensor::getRS() { //More explained in: https://jayconsystems.com/blog/understanding-a-gas-sensor - _RS_Calc = ((_VOLT_RESOLUTION*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas + _RS_Calc = ((_VCC*_RL)/_sensor_volt)-_RL; //Get value of RS in a gas if(_RS_Calc < 0) _RS_Calc = 0; //No negative values accepted. return _RS_Calc; } diff --git a/src/MQUnifiedsensor.h b/src/MQUnifiedsensor.h index 3b55682..c5ef4d2 100644 --- a/src/MQUnifiedsensor.h +++ b/src/MQUnifiedsensor.h @@ -22,6 +22,7 @@ class MQUnifiedsensor void setB(float b); void setRegressionMethod(int regressionMethod); void setVoltResolution(float voltage_resolution = 5); + void setVCC(float vcc = 5); void setPin(int pin = 1); void serialDebug(bool onSetup = false); //Show on serial port information about sensor void setADC(int value); //For external ADC Usage @@ -38,6 +39,7 @@ class MQUnifiedsensor float getR0(); float getRL(); float getVoltResolution(); + float getVCC(); String getRegressionMethod(); float getVoltage(bool read = true, bool injected = false, int value = 0); float stringTofloat(String & str); @@ -51,6 +53,7 @@ class MQUnifiedsensor byte _pin = 1; byte _firstFlag = false; float _VOLT_RESOLUTION = 5.0; // if 3.3v use 3.3 + float _VCC = 5.0; // Sensor supply voltage float _RL = 10; //Value in KiloOhms byte _ADC_Bit_Resolution = 10; byte _regressionMethod = 1; // 1 -> Exponential || 2 -> Linear