From bcf14d763d3b5005d847f5f457f4cafa69ab4d8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Borna=20Kru=C5=A1lin?= Date: Thu, 19 Sep 2024 08:40:49 +0200 Subject: [PATCH] Updated workflows and README --- .github/workflows/arduino_lint.yml | 1 + .github/workflows/format.yml | 2 +- README.md | 58 +++++++++++++++--------------- library.properties | 8 ++--- 4 files changed, 35 insertions(+), 34 deletions(-) diff --git a/.github/workflows/arduino_lint.yml b/.github/workflows/arduino_lint.yml index d54ec68..1e08389 100644 --- a/.github/workflows/arduino_lint.yml +++ b/.github/workflows/arduino_lint.yml @@ -12,4 +12,5 @@ jobs: with: compliance: specification project-type: library + library-manager: update recursive: true diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 40cb0be..7b71d20 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -8,7 +8,7 @@ jobs: steps: - uses: actions/checkout@v2 - - uses: DoozyX/clang-format-lint-action@v0.12 + - uses: DoozyX/clang-format-lint-action@v0.18.2 with: source: "./src" exclude: "./src/libs" diff --git a/README.md b/README.md index 3f5b100..2feb451 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ | ![Butane, LPG & Smoke sensor MQ2 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :---------------------------------------------------------------------------------------------------------------: | -| [Butane, LPG & Smoke sensor MQ2 breakout](https://www.solde.red/333102) | +| [Butane, LPG & Smoke sensor MQ2 breakout](https://solde.red/333102) | Gas sensor registers the presence of various gases, such as oil and gasoline vapors, butane, propane, methane, ethanol(alcohol), hydrogen, smoke. It registers gases the best while they are in the liquid form, but since we cannot find them in that state that often, it measures a good concentration of substances in a gaseous state. It takes a short time to heat up in order to work correctly. @@ -19,7 +19,7 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![Alcohol, Ethanol sensor MQ3 breakout](https://github.com/SolderedElectronics/Alcohol--Ethanol-sensor-MQ3-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333103.jpg) | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Alcohol, Ethanol sensor MQ3 breakout](https://www.solde.red/333103) | +| [Alcohol, Ethanol sensor MQ3 breakout](https://solde.red/333103) | An alcohol sensor is capable of detecting alcohol (ethanol) particles on itself and gives the information in digital form back to us to manipulate it. @@ -32,7 +32,7 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![Methane, CNG sensor MQ4 breakout](https://github.com/SolderedElectronics/Methane.-CNG-sensor-MQ4-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333104.jpg) | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Methane, CNG sensor MQ4 breakout](https://www.solde.red/333104) | +| [Methane, CNG sensor MQ4 breakout](https://solde.red/333104) | Have you ever wondered how much natural gas and methane are in your living room? You can easily measure that! The MQ4 breakout board is a simple-to-use sensor that detects the natural gas and methane (CH4) in the air. Once heated to working temperature, it detects changes in air concentrations very quickly between 200 and 10000 ppm. @@ -49,7 +49,7 @@ On the through-holes, the DO stands for digital out and AO for analog out. The d | ![Natural gas, LPG sensor MQ5 breakout](https://github.com/SolderedElectronics/Natural-gas--LPG-sensor-MQ5-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333105.jpg) | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Natural gas, LPG sensor MQ5 breakout](https://www.solde.red/333105) | +| [Natural gas, LPG sensor MQ5 breakout](https://solde.red/333105) | Is your office near a high-traffic area? Are you concerned about the amount of natural and liquefied petroleum gases in your work environment? The MQ5 is a simple-to-use sensor to put your mind at ease. It detects gas particles very quickly between 200 and 10000 ppm. @@ -66,7 +66,7 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![LPG, Butane sensor MQ6 breakout ](https://github.com/SolderedElectronics/LPG--Butane-sensor-MQ6-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333106.jpg) | | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [LPG, Butane sensor MQ6 breakout ](https://www.solde.red/333106) | +| [LPG, Butane sensor MQ6 breakout ](https://solde.red/333106) | Humans can detect many scents, but can have difficulties when it comes to differentiating gases. That’s why we use sensors like MQ6. It detects LPG and butane in the air. When heated to the optimum working temperature, it detects changes in air concentrations very quickly between 200 and 10000 ppm. @@ -83,7 +83,7 @@ The DO pin stands for digital out. AO stands for analog out. The digital output | ![CO sensor MQ7 breakout](https://github.com/SolderedElectronics/CO-sensor-MQ7-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333107.jpg) | | :------------------------------------------------------------------------------------------------------------------------------------------: | -| [CO sensor MQ7 breakout](https://www.solde.red/333107) | +| [CO sensor MQ7 breakout](https://solde.red/333107) | Gas sensor MQ7 detects the presence of Carbon Monoxide (CO) in the air. The best results are given when alcohol is in liquid form, however, it still does an amazing job when measuring in gas form. It needs a bit of time to warm up in order to work correctly. @@ -97,7 +97,7 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![Hydrogen sensor MQ8 breakout](https://github.com/SolderedElectronics/Hydrogen-sensor-MQ8-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333108.jpg) | | :------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Hydrogen sensor MQ8 breakout](https://www.solde.red/333108) | +| [Hydrogen sensor MQ8 breakout](https://solde.red/333108) | Hydrogen is all around us, and it’s very flammable. Its leakage can be very dangerous to both life and property. That’s why it's important to detect any leakage to prevent in the industry. To help with that, hydrogen sensors like the MQ8 breakout board are used. The sensor detects hydrogen at the range of 100-1000 ppm. @@ -114,7 +114,7 @@ The digital and analog outs are on the breakout through-hole pins. They are mark | ![CO, flammable gasses sensor MQ9 breakout](https://github.com/SolderedElectronics/CO--flammable-gasses-sensor-MQ9-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333109.jpg) | | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [CO, flammable gasses sensor MQ9 breakout](https://www.solde.red/333109) | +| [CO, flammable gasses sensor MQ9 breakout](https://solde.red/333109) | We are surrounded by invisible gases everywhere. While we generally don’t have to worry about them, under the right circumstances, they can be very combustible and dangerous. The MQ9 breakout board detects carbon monoxide, methane, propane, and other flammable gases so the right measures can be taken in time. The sensor detects carbon monoxide at 10-1000 ppm and other combustible gasses at 100-10000 ppm. @@ -131,7 +131,7 @@ The digital and analog outs can be found on the through-holes. They are marked a | ![Ozone sensor MQ131 breakout](https://github.com/SolderedElectronics/Ozone-sensor-MQ131-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333110.jpg) | | :----------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Ozone sensor MQ131 breakout](https://www.solde.red/333110) | +| [Ozone sensor MQ131 breakout](https://solde.red/333110) | This breakout for the MQ131 sensor responds to the presence of ozone in the air. As the ozone concentration increases, the resistance changes and the ozone concentration can be measured by measuring the analogue output voltage. The sensor is of good precision and is normally used in ozone concentration detectors. There is a 3362 potentiometer on the board with which the digital signal threshold can be set. There is a digital and analogue output via the male pins. @@ -144,19 +144,19 @@ This breakout for the MQ131 sensor responds to the presence of ozone in the air. | ![Air quality sensor MQ135 breakout](https://github.com/SolderedElectronics/Air-quality-sensor-MQ135-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333111.jpg) | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Air quality sensor MQ135 breakout](https://www.solde.red/333111) | +| [Air quality sensor MQ135 breakout](https://solde.red/333111) | OPIS | ![Hydrogen Sulfide sensor MQ136 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :--------------------------------------------------------------------------------------------------------------: | -| [Hydrogen Sulfide sensor MQ136 breakout](https://www.solde.red/333112) | +| [Hydrogen Sulfide sensor MQ136 breakout](https://solde.red/333112) | OPIS | ![Ammonia sensor MQ137 breakout](https://github.com/SolderedElectronics/Ammonia-sensor-MQ137-breakout-hardware-design/blob/main/OUTPUTS/V1.1.1/333113.jpg) | | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Ammonia sensor MQ137 breakout](https://www.solde.red/333113) | +| [Ammonia sensor MQ137 breakout](https://solde.red/333113) | Gas sensor registers the presence of ammonia gas (NH3). It registers gases the best while they are in the liquid form, but since we cannot find them in that state that often, it measures a good concentration of substances in a gaseous state. It takes a short time to heat up in order to work correctly. @@ -169,7 +169,7 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![VOC sensor MQ138 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-------------------------------------------------------------------------------------------------: | -| [VOC sensor MQ138 breakout](https://www.solde.red/333114) | +| [VOC sensor MQ138 breakout](https://solde.red/333114) | Gas sensor registers the presence of VOC gasses: toulen, alcohol, acetone and hydrogen. It registers gases the best while they are in the liquid form, but since we cannot find them in that state that often, it measures a good concentration of substances in a gaseous state. It takes a short time to heat up in order to work correctly. @@ -182,91 +182,91 @@ The breakout board works with both digital (DO) and analog signals (AO). The dig | ![Methane, Natural gas sensor MQ214 breakout](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :------------------------------------------------------------------------------------------------------------------: | -| [Methane, Natural gas sensor MQ214 breakout](https://www.solde.red/333115) | +| [Methane, Natural gas sensor MQ214 breakout](https://solde.red/333115) | OPIS | ![Butane, LPG & Smoke sensor MQ2 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :--------------------------------------------------------------------------------------------------------------------------: | -| [Butane, LPG & Smoke sensor MQ2 breakout with easyC](https://www.solde.red/333116) | +| [Butane, LPG & Smoke sensor MQ2 breakout with easyC](https://solde.red/333116) | OPIS | ![Alcohol, Ethanol sensor MQ3 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-----------------------------------------------------------------------------------------------------------------------: | -| [Alcohol, Ethanol sensor MQ3 breakout with easyC](https://www.solde.red/333117) | +| [Alcohol, Ethanol sensor MQ3 breakout with easyC](https://solde.red/333117) | OPIS | ![Methane, CNG sensor MQ4 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-------------------------------------------------------------------------------------------------------------------: | -| [Methane, CNG sensor MQ4 breakout with easyC](https://www.solde.red/333118) | +| [Methane, CNG sensor MQ4 breakout with easyC](https://solde.red/333118) | OPIS | ![Natural gas, LPG sensor MQ5 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-----------------------------------------------------------------------------------------------------------------------: | -| [Natural gas, LPG sensor MQ5 breakout with easyC](https://www.solde.red/333119) | +| [Natural gas, LPG sensor MQ5 breakout with easyC](https://solde.red/333119) | OPIS | ![LPG, Butane sensor MQ6 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :------------------------------------------------------------------------------------------------------------------: | -| [LPG, Butane sensor MQ6 breakout with easyC](https://www.solde.red/333120) | +| [LPG, Butane sensor MQ6 breakout with easyC](https://solde.red/333120) | OPIS | ![CO sensor MQ7 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :---------------------------------------------------------------------------------------------------------: | -| [CO sensor MQ7 breakout with easyC](https://www.solde.red/333121) | +| [CO sensor MQ7 breakout with easyC](https://solde.red/333121) | OPIS | ![Hydrogen sensor MQ8 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :---------------------------------------------------------------------------------------------------------------: | -| [Hydrogen sensor MQ8 breakout with easyC](https://www.solde.red/333122) | +| [Hydrogen sensor MQ8 breakout with easyC](https://solde.red/333122) | OPIS | ![CO, flammable gasses sensor MQ9 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :---------------------------------------------------------------------------------------------------------------------------: | -| [CO, flammable gasses sensor MQ9 breakout with easyC](https://www.solde.red/333123) | +| [CO, flammable gasses sensor MQ9 breakout with easyC](https://solde.red/333123) | OPIS | ![Ozone sensor MQ131 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :--------------------------------------------------------------------------------------------------------------: | -| [Ozone sensor MQ131 breakout with easyC](https://www.solde.red/333124) | +| [Ozone sensor MQ131 breakout with easyC](https://solde.red/333124) | OPIS | ![Air quality sensor MQ135 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :--------------------------------------------------------------------------------------------------------------------: | -| [Air quality sensor MQ135 breakout with easyC](https://www.solde.red/333125) | +| [Air quality sensor MQ135 breakout with easyC](https://solde.red/333125) | OPIS | ![Hydrogen Sulfide sensor MQ136 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-------------------------------------------------------------------------------------------------------------------------: | -| [Hydrogen Sulfide sensor MQ136 breakout with easyC](https://www.solde.red/333126) | +| [Hydrogen Sulfide sensor MQ136 breakout with easyC](https://solde.red/333126) | OPIS | ![Ammonia sensor MQ137 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :----------------------------------------------------------------------------------------------------------------: | -| [Ammonia sensor MQ137 breakout with easyC](https://www.solde.red/333127) | +| [Ammonia sensor MQ137 breakout with easyC](https://solde.red/333127) | OPIS | ![Benzene, Toluene, Acetone, Formaldehyde sensor MQ138 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Benzene, Toluene, Acetone, Formaldehyde sensor MQ138 breakout with easyC](https://www.solde.red/333128) | +| [Benzene, Toluene, Acetone, Formaldehyde sensor MQ138 breakout with easyC](https://solde.red/333128) | OPIS | ![Methane, Natural gas sensor MQ214 breakout with easyC](https://upload.wikimedia.org/wikipedia/commons/8/8f/Example_image.svg) | | :-----------------------------------------------------------------------------------------------------------------------------: | -| [Methane, Natural gas sensor MQ214 breakout with easyC](https://www.solde.red/333129) | +| [Methane, Natural gas sensor MQ214 breakout with easyC](https://solde.red/333129) | OPIS @@ -306,7 +306,7 @@ You can find hardware design for this board in [_VOC sensor MQ138 breakout_](htt You can find hardware design for this board in [_Methane, Natural gas sensor MQ214 breakout_](https://github.com/SolderedElectronics/Methane--Natural-gas-sensor-MQ214-breakout-hardware-design) hardware repository. -You can find hardware design for this board in [_Butane, LPG & Smoke sensor MQ2 breakout with easyC_](https://github.com/SolderedElectronics/NAZIVPROIZVODA-hardware-design) hardware repository. +You can find hardware design for this board in [_Butane, LPG & Smoke sensor MQ2 breakout with easyC_](https://github.com/SolderedElectronics/Butane--LPG---Smoke-sensor-MQ2-breakout-hardware-design) hardware repository. You can find hardware design for this board in [_Alcohol, Ethanol sensor MQ3 breakout with easyC_](https://github.com/SolderedElectronics/Alcohol--Ethanol-sensor-MQ3-breakout-with-easyC-hardware-design) hardware repository. diff --git a/library.properties b/library.properties index 9399b9f..ca4af5d 100644 --- a/library.properties +++ b/library.properties @@ -1,11 +1,11 @@ -name=Soldered MQ-X Gas Sensor Library -version=1.0.0 +name=Soldered MQ-X Gas Sensor Arduino Library +version=1.0.1 author=Soldered maintainer=Soldered sentence=MQ-X Gas Sensor Library by Soldered -paragraph=MQ-X sensors are great for detecting different gases +paragraph=MQ-X are specifically designed to detect various gases. category=Sensors -url=https://sold.red/333041 +url=https://solde.red/333128 repository=https://github.com/SolderedElectronics/Soldered-MQ-Gas-Sensor-Arduino-Library architectures=* includes=MQ-Sensor-SOLDERED.h