RumPiLibraryDocumentation/html/_m_q5_8h_source.html

#pragma once

#include "../Common.h"

#include "GasSensor.h"


namespace RumPi

{

    class MQ5 : public GasSensor

    {

    public:

        MQ5();


        MQ5(IAnalogDigitalConverterComponent* analogToDigitalConverter, const unsigned int& analogToDigitalConverterIndex, const unsigned int& digitalOutputPinNumber);


        MQ5(IAnalogDigitalConverterComponent* analogToDigitalConverter, const unsigned int& analogToDigitalConverterIndex);


        MQ5(const unsigned int& digitalOutputPinNumber);


        virtual ~MQ5();


        void Initialize() override;


        double ReadGasValue() const override;


        double CalculatePropanePPM(const double& sensorGasValueInVolts) const;


        std::string ToString() const override;

    };

} // namespace RumPi

GasSensor.h

RumPi::GasSensor
Base class for the MQ-series gas sensors (MQ2, MQ7, ...).
Definition: GasSensor.h:19

RumPi::IAnalogDigitalConverterComponent
Interface for analog-to-digital converter components (e.g.
Definition: AnalogDigitalConverterComponent.h:14

RumPi::MQ5
MQ-5 gas sensor, typically used for detecting LPG and natural gas (propane).
Definition: MQ5.h:14

RumPi::MQ5::MQ5
MQ5()
Builds a default MQ-5 (LPG / propane) sensor and initializes its datasheet values.
Definition: MQ5.cpp:15

RumPi::MQ5::ReadGasValue
double ReadGasValue() const override
Reads the current propane PPM for the sensor's raw reading (from the precomputed cache).
Definition: MQ5.cpp:129

RumPi::MQ5::Initialize
void Initialize() override
Initializes the MQ-5's datasheet values (its propane gas curve) and precomputes a PPM value for every...
Definition: MQ5.cpp:101

RumPi::MQ5::~MQ5
virtual ~MQ5()
Destroys the sensor, turning it off first.
Definition: MQ5.cpp:85

RumPi::MQ5::CalculatePropanePPM
double CalculatePropanePPM(const double &sensorGasValueInVolts) const
Computes the propane concentration (PPM) from the sensor's output voltage using a power-law fit of th...
Definition: MQ5.cpp:149

RumPi::MQ5::ToString
std::string ToString() const override
Serializes the MQ-5's gas name, raw reading, and propane PPM to a string.
Definition: MQ5.cpp:169

RumPi
RumPi is the library's top-level facade.
Definition: AlertManager.h:6