ErriezMHZ19B.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020-2023 Erriez
 *
 * 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.
 */
 
#ifndef ERRIEZ_MHZ19B_H_
#define ERRIEZ_MHZ19B_H_
 
#include <Arduino.h>
 
// #define MHZ19B_SMART_WARMING_UP
 
#define MHZ19B_WARMING_UP_TIME_MS       (3UL * 60000UL)
 
#define MHZ19B_READ_INTERVAL_MS         (5UL * 1000UL)
 
#define MHZ19B_SERIAL_RX_BYTES          9
 
#define MHZ19B_SERIAL_RX_TIMEOUT_MS     120
 
// Documented commands
#define MHZ19B_CMD_SET_AUTO_CAL         0x79 
#define MHZ19B_CMD_READ_CO2             0x86 
#define MHZ19B_CMD_CAL_ZERO_POINT       0x87 
#define MHZ19B_CMD_CAL_SPAN_POINT       0x88 
#define MHZ19B_CMD_SET_RANGE            0x99 
 
// Not documented commands
#define MHZ19B_CMD_GET_AUTO_CAL         0x7D 
#define MHZ19B_CMD_GET_RANGE            0x9B 
#define MHZ19B_CMD_GET_VERSION          0xA0 
 
typedef enum {
    MHZ19B_RESULT_OK = 0,                
    MHZ19B_RESULT_ERROR = -1,            
    MHZ19B_RESULT_ERR_CRC = -2,          
    MHZ19B_RESULT_ERR_TIMEOUT = -3,      
    MHZ19B_RESULT_ARGUMENT_ERROR = -4,   
} MHZ19B_Result_e;
 
typedef enum {
    MHZ19B_RANGE_2000 = 2000,            
    MHZ19B_RANGE_5000 = 5000,            
} MHZ19B_Range_e;
 
 
class ErriezMHZ19B
{
public:
    ErriezMHZ19B(Stream *serial);
    ~ErriezMHZ19B();
 
    // Detect sensor by checking range response
    bool detect();
 
    // Minimum wait time after power-on
    bool isWarmingUp();
 
    // Minimum wait time between CO2 reads
    bool isReady();
 
    // Read CO2 value
    int16_t readCO2();
 
    // Get firmware version (NOT DOCUMENTED)
    int8_t getVersion(char *version, uint8_t versionLen);
 
    // Set/get CO2 range, default 5000ppm)
    int8_t setRange2000ppm();
    int8_t setRange5000ppm();
    int16_t getRange(); // (NOT DOCUMENTED)
 
    // Set and get ABC, default on (Automatic Baseline Correction)
    int8_t setAutoCalibration(bool calibrationOn);
    int8_t getAutoCalibration(); // (NOT DOCUMENTED)
 
    // Start Zero Point Calibration manually at 400ppm
    int8_t startZeroCalibration();
    
    // Serial communication
    int8_t sendCommand(uint8_t cmd, byte b3=0, byte b4=0, byte b5=0, byte b6=0, byte b7=0);
 
    // Global receive buffer
    uint8_t rxBuffer[MHZ19B_SERIAL_RX_BYTES];
 
private:
    Stream *_serial;                
    unsigned long _tLastReadCO2;    
 
    // CRC check on serial transmit/receive buffer
    uint8_t calcCRC(uint8_t *data);
};
 
#endif // ERRIEZ_MHZ19B_H_