v1.0.0 initial release

Author: cakraawijaya

BACA.md

@@ -0,0 +1,38 @@
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?style=flat)](https://github.com/ellerbrock/open-source-badges/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?logo=github&color=%23F7DF1E)](https://opensource.org/licenses/MIT)
+![GitHub last commit](https://img.shields.io/github/last-commit/cakraawijaya/MQ2_LPG?logo=Codeforces&logoColor=white&color=%23F7DF1E)
+![Project](https://img.shields.io/badge/Project-Library-light.svg?style=flat&logo=arduino&logoColor=white&color=%23F7DF1E)
+![Type](https://img.shields.io/badge/Type-Personal%20Experiment-light.svg?style=flat&logo=gitbook&logoColor=white&color=%23F7DF1E)
+
+# MQ2_LPG
+Pustaka ini digunakan untuk membaca data gas LPG: propana (C3H8) dan butana (C4H10) yang ditangkap oleh sensor.
+
+<br>
+
+## INFORMASI UMUM
+<img src="extras/documentation/pinout/MQ2.jpg" alt="mq2-sensor-pinout"><br><br>
+• Kreator: Devan Cakra M.W.
+
+• Lembar data: <a href="https://components101.com/sensors/mq2-gas-sensor">Klik Disini</a>
+
+• Cara mengkalibrasi bagian LPG pada sensor MQ-2: <a href="extras/articles/Cara Kalibrasi.md">Klik Disini</a>
+
+• Versi Pustaka: V1.0.0 (08-April-2023).
+
+• Fitur: Terdapat fungsi kalibrasi MQ-2 yang dinamis, sehingga memudahkan pengguna untuk membaca data gas, terutama LPG.
+
+<br><br>
+
+## Apresiasi
+Jika karya ini bermanfaat bagi anda, maka dukunglah karya ini sebagai bentuk apresiasi kepada penulis dengan mengklik tombol ``` ⭐Bintang ``` di bagian atas repositori.
+
+<br><br>
+
+## LISENSI
+LISENSI MIT - Hak Cipta © 2023 - Devan C. M. Wijaya, S.Kom
+
+Dengan ini diberikan izin tanpa biaya kepada siapa pun yang mendapatkan salinan perangkat lunak ini dan file dokumentasi terkait perangkat lunak untuk menggunakannya tanpa batasan, termasuk namun tidak terbatas pada hak untuk menggunakan, menyalin, memodifikasi, menggabungkan, mempublikasikan, mendistribusikan, mensublisensikan, dan/atau menjual salinan Perangkat Lunak ini, dan mengizinkan orang yang menerima Perangkat Lunak ini untuk dilengkapi dengan persyaratan berikut:
+
+Pemberitahuan hak cipta di atas dan pemberitahuan izin ini harus menyertai semua salinan atau bagian penting dari Perangkat Lunak.
+
+DALAM HAL APAPUN, PENULIS ATAU PEMEGANG HAK CIPTA DI SINI TETAP MEMILIKI HAK KEPEMILIKAN PENUH. PERANGKAT LUNAK INI DISEDIAKAN SEBAGAIMANA ADANYA, TANPA JAMINAN APAPUN, BAIK TERSURAT MAUPUN TERSIRAT, OLEH KARENA ITU JIKA TERJADI KERUSAKAN, KEHILANGAN, ATAU LAINNYA YANG TIMBUL DARI PENGGUNAAN ATAU URUSAN LAIN DALAM PERANGKAT LUNAK INI, PENULIS ATAU PEMEGANG HAK CIPTA TIDAK BERTANGGUNG JAWAB, KARENA PENGGUNAAN PERANGKAT LUNAK INI TIDAK DIPAKSAKAN SAMA SEKALI, SEHINGGA RISIKO ADALAH MILIK ANDA SENDIRI.

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2023 - Devan C. M. Wijaya, S.Kom.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,38 @@
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?style=flat)](https://github.com/ellerbrock/open-source-badges/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?logo=github&color=%23F7DF1E)](https://opensource.org/licenses/MIT)
+![GitHub last commit](https://img.shields.io/github/last-commit/cakraawijaya/MQ2_LPG?logo=Codeforces&logoColor=white&color=%23F7DF1E)
+![Project](https://img.shields.io/badge/Project-Library-light.svg?style=flat&logo=arduino&logoColor=white&color=%23F7DF1E)
+![Type](https://img.shields.io/badge/Type-Personal%20Experiment-light.svg?style=flat&logo=gitbook&logoColor=white&color=%23F7DF1E)
+
+# MQ2_LPG
+This library is used to read the LPG gas data: propane (C3H8) and butane (C4H10) captured by the sensor.
+
+<br>
+
+## GENERAL INFORMATION
+<img src="extras/documentation/pinout/MQ2.jpg" alt="mq2-sensor-pinout"><br><br>
+• Creator: Devan Cakra M.W.
+
+• Datasheet: <a href="https://components101.com/sensors/mq2-gas-sensor">Click Here</a>
+
+• How to calibrate the LPG part of the MQ-2 sensor: <a href="extras/articles/How To Calibration.md">Click Here</a>
+
+• Library Version: V1.0.0 (08-April-2023).
+
+• Features: There is a dynamic MQ-2 calibration function, making it easier for users to read gas data, especially LPG.
+
+<br><br>
+
+## Appreciation
+If this work is useful to you, then support this work as a form of appreciation to the author by clicking the ``` ⭐Star ``` button at the top of the repository.
+
+<br><br>
+
+## LICENSE
+MIT License - Copyright © 2023 - Devan C. M. Wijaya, S.Kom
+
+Permission is hereby granted without charge to any person obtaining a copy of this software and the software-related documentation files to deal in them without restriction, including without limitation the right to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons receiving the Software to be furnished therewith on the following terms:
+
+The above copyright notice and this permission notice must accompany all copies or substantial portions of the Software.
+
+IN ANY EVENT, THE AUTHOR OR COPYRIGHT HOLDER HEREIN RETAINS FULL OWNERSHIP RIGHTS. THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, THEREFORE IF ANY DAMAGE, LOSS, OR OTHERWISE ARISES FROM THE USE OR OTHER DEALINGS IN THE SOFTWARE, THE AUTHOR OR COPYRIGHT HOLDER SHALL NOT BE LIABLE, AS THE USE OF THE SOFTWARE IS NOT COMPELLED AT ALL, SO THE RISK IS YOUR OWN.

examples/basic_mq2_lpg/basic_mq2_lpg.ino

@@ -0,0 +1,42 @@
+// Library: Gas MQ2-LPG
+// By: Devan Cakra M.W
+
+#include "MQ2_LPG.h" // library declaration
+#define MQ2PIN A0 // mq2 pin declaration
+
+MQ2Sensor mq2(MQ2PIN); // create a new object with the name mq2 to hold the MQ2Sensor class
+
+void setup() {
+  Serial.begin(9600); // default baudrate for the Arduino board
+  mq2.begin(); // initiate mq2 sensor
+}
+
+// gas calibration data
+#define RL_Value 100 // 100K ohm
+#define x1_Value 199.150007852152
+#define x2_Value 797.3322752256328
+#define y1_Value 1.664988323698715
+#define y2_Value 0.8990240080541785
+#define x_Value 497.4177875376839
+#define y_Value 1.0876679972710004
+#define Ro_Value 6.02
+#define Voltage_Value 5.0
+#define bitADC_Value 1023.0 // development board adc resolution
+
+void calibration(){
+  mq2.RL(RL_Value); // resistance load setting
+  mq2.Ro(Ro_Value); // reverse osmosis setting
+  mq2.Volt(Voltage_Value); // voltage sensor setting
+  mq2.BitADC(bitADC_Value); // development board adc resolution setting
+  mq2.mCurve(x1_Value, x2_Value, y1_Value, y2_Value); // mCurve setting
+  mq2.bCurve(x_Value, y_Value); // bCurve setting
+  mq2.getCalibrationData(); // get data calibration
+  mq2.viewCalibrationData(); // print to serial monitor: data calibration
+}
+
+void loop() {
+  calibration(); // calls calibration method
+  mq2.readGas(); // reading mq2 sensor data
+  mq2.viewGasData(); // print to serial monitor: gas value & status
+  delay(3000); // delay for 3 seconds
+}

extras/articles/Cara Kalibrasi.md

@@ -0,0 +1,94 @@
+## Mencari Nilai Ro (Reverse Osmosis)
+
+```ino
+#include "MQ2_LPG.h" // library declaration
+#define MQ2PIN A0 // mq2 pin declaration
+
+MQ2Sensor mq2(MQ2PIN); // create a new object with the name mq2 to hold the MQ2Sensor class
+
+void setup() {
+  Serial.begin(9600); // default baudrate for the Arduino board
+  mq2.begin(); // initiate mq2 sensor
+}
+
+// gas calibration data
+#define RL_Value 10 // 10K ohm
+#define x1_Value 0
+#define x2_Value 0
+#define y1_Value 0
+#define y2_Value 0
+#define x_Value 0
+#define y_Value 0
+#define Voltage_Value 5.0
+#define bitADC_Value 1023.0 // development board adc resolution
+
+void calibration(){
+  mq2.RL(RL_Value); // resistance load setting
+  mq2.Volt(Voltage_Value); // voltage sensor setting
+  mq2.BitADC(bitADC_Value); // development board adc resolution setting
+  mq2.mCurve(x1_Value, x2_Value, y1_Value, y2_Value); // mCurve setting
+  mq2.bCurve(x_Value, y_Value); // bCurve setting
+  mq2.getCalibrationData(); // get data calibration
+  mq2.viewCalibrationData(); // print to serial monitor: data calibration
+}
+
+void loop() {
+  calibration(); // calls calibration method
+  delay(3000); // delay for 3 seconds
+}
+```
+
+<br>
+
+<div align="justify">
+
+Setelah data Ro didapatkan, maka langkah selanjutnya yaitu memasukkan data Ro tersebut ke bagian #define.
+
+```ino
+#define Ro_Value 6.31
+```
+
+<br><br>
+
+## Mencari Titik Koordinat Yang Sesuai
+  
+  Bukalah link berikut: <a href="https://automeris.io/WebPlotDigitizer/">WebPlotDigitizer</a> , lalu klik ``` Launch Now! ```. Kemudian klik ``` Load Image ```. Hal tersebut dapat anda ketahui selengkapnya di bawah ini.
+
+<img src="../documentation/experiment/Load Image.jpg" alt="load-image">
+  
+  Upload gambar sesuai dengan link yang telah disediakan: <a href="../documentation/experiment/Calibration Graph.jpg" alt="calibration-graph">Klik disini</a>.
+
+<br>
+  
+  Kemudian memilih tipe plot: ``` 2D (X-Y) Plot ```. Selanjutnya klik ``` Align Axes ``` → ``` Proceed ```.
+
+<img src="../documentation/experiment/Plot Type.jpg" alt="plot-type"><br>
+  
+  Selanjutnya, anda harus memberikan batas nilai, mulai dari ``` X1 → X2 → Y1 → Y2 ```. Selanjutnya klik ``` Complete! ``` untuk mengatur ``` X-Axis ``` dan ``` Y-Axis ```. Jangan lupa untuk mencentang bagian ``` Log Scale ``` → ``` OK ```.
+
+<img src="../documentation/experiment/Axes Calibration.jpg" alt="axes-calibration"><br>
+  
+  Langkah berikutnya, klik ``` Add Point (A) ```, lalu pilih kurva yang diinginkan (dalam hal ini hanya menggunakan LPG dan Propane). Jangan lupa cari titik koordinat yang saling berhimpitan satu sama lain seperti yang ditampilkan pada gambar berikut.
+
+<img src="../documentation/experiment/Add Point.jpg" alt="add-point"><br>
+  
+  Kemudian, klik ``` View Data ``` untuk mengetahui nilai dari titik koordinat yang telah dipilih tadi. Misalnya seperti yang terlihat pada gambar di bawah ini.
+
+<img src="../documentation/experiment/View Data.jpg" alt="view-data"><br>
+  
+  Langkah terakhir, data koordinat diatas kemudian dimasukkan kedalam kode yang ada di Arduino IDE bagian #define.
+
+```ino
+#define x1_Value 199.150007852152
+#define x2_Value 797.3322752256328
+#define y1_Value 1.664988323698715
+#define y2_Value 0.8990240080541785
+#define x_Value 497.4177875376839
+#define y_Value 1.0876679972710004
+```
+
+<br>
+  
+  Lalu unggah program.&nbsp;&nbsp;&nbsp;<strong>~ SELESAI... , SELAMAT MENCOBA</strong> ~
+
+</div>

extras/articles/How To Calibration.md

@@ -0,0 +1,94 @@
+## Finding Ro (Reverse Osmosis) Value
+
+```ino
+#include "MQ2_LPG.h" // library declaration
+#define MQ2PIN A0 // mq2 pin declaration
+
+MQ2Sensor mq2(MQ2PIN); // create a new object with the name mq2 to hold the MQ2Sensor class
+
+void setup() {
+  Serial.begin(9600); // default baudrate for the Arduino board
+  mq2.begin(); // initiate mq2 sensor
+}
+
+// gas calibration data
+#define RL_Value 10 // 10K ohm
+#define x1_Value 0
+#define x2_Value 0
+#define y1_Value 0
+#define y2_Value 0
+#define x_Value 0
+#define y_Value 0
+#define Voltage_Value 5.0
+#define bitADC_Value 1023.0 // development board adc resolution
+
+void calibration(){
+  mq2.RL(RL_Value); // resistance load setting
+  mq2.Volt(Voltage_Value); // voltage sensor setting
+  mq2.BitADC(bitADC_Value); // development board adc resolution setting
+  mq2.mCurve(x1_Value, x2_Value, y1_Value, y2_Value); // mCurve setting
+  mq2.bCurve(x_Value, y_Value); // bCurve setting
+  mq2.getCalibrationData(); // get data calibration
+  mq2.viewCalibrationData(); // print to serial monitor: data calibration
+}
+
+void loop() {
+  calibration(); // calls calibration method
+  delay(3000); // delay for 3 seconds
+}
+```
+
+<br>
+
+<div align="justify">
+  
+<i>After the Ro data is obtained, the next step is to enter the Ro data into the #define section.</i>
+
+```ino
+#define Ro_Value 6.31
+```
+
+<br><br>
+
+## Finding the Right Coordinate Point
+
+<i>Open the following link: <a href="https://automeris.io/WebPlotDigitizer/">WebPlotDigitizer</a> , then click ``` Launch Now! ```. Then click ``` Load Image ```. You can find out more about this below.</i>
+
+<img src="../documentation/experiment/Load Image.jpg" alt="load-image">
+
+<i>Upload the image according to the link provided: <a href="../documentation/experiment/Calibration Graph.jpg" alt="calibration-graph">Click here</a>.</i>
+
+<br>
+
+<i>Then choose a plot type: ``` 2D (X-Y) Plot ```. Then click ``` Align Axes ``` → ``` Proceed ```.</i>
+
+<img src="../documentation/experiment/Plot Type.jpg" alt="plot-type"><br>
+
+<i>Next, you must provide a value limit, starting from ``` X1 → X2 → Y1 → Y2 ```. Then click ``` Complete! ``` to set the ``` X-Axis ``` and ``` Y-Axis ```. Don't forget to tick the ``` Log Scale ``` → ``` OK ``` section.</i>
+  
+<img src="../documentation/experiment/Axes Calibration.jpg" alt="axes-calibration"><br>
+
+<i>In the next step, click ``` Add Point (A) ```, then select the desired curve (in this case using only LPG and Propane). Don't forget to look for coordinate points that overlap each other as shown in the following image.</i>
+
+<img src="../documentation/experiment/Add Point.jpg" alt="add-point"><br>
+
+<i>Then, click ``` View Data ``` to find out the value of the coordinate point that was selected earlier. For example, as shown in the image below.</i>
+
+<img src="../documentation/experiment/View Data.jpg" alt="view-data"><br>
+
+<i>In the final step, the coordinate data above is then entered into the code in the #define section of the Arduino IDE.</i>
+
+```ino
+#define x1_Value 199.150007852152
+#define x2_Value 797.3322752256328
+#define y1_Value 1.664988323698715
+#define y2_Value 0.8990240080541785
+#define x_Value 497.4177875376839
+#define y_Value 1.0876679972710004
+```
+
+<br>
+  
+  Then upload the program.&nbsp;&nbsp;&nbsp;<strong>~ DONE... , GOOD LUCK</strong> ~
+
+</div>