DFRobot_EC.h

/*
 * file DFRobot_EC.h * @ https://github.com/DFRobot/DFRobot_EC
 *
 * Arduino library for Gravity: Analog Electrical Conductivity Sensor / Meter Kit V2 (K=1), SKU: DFR0300
 *
 * Copyright   [DFRobot](http://www.dfrobot.com), 2018
 * Copyright   GNU Lesser General Public License
 *
 * version  V1.01
 * date  2018-06
 * 
 * version  V1.1
 * date  2020-04
 * Changes the memory addressing to allow multiple EC sensors
 */

#ifndef _DFROBOT_EC_H_
#define _DFROBOT_EC_H_

#if ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif

// Length of the Serial CMD buffer
#define ReceivedBufferLength 10  

/**
 * Maps the pin (A0,A1..A11) to a number 0-11 so the address can be determined
 * @param ecPin the pin the EC sensor is attached to
 * @return the address multiplier
 */
uint8_t mapECPin(uint8_t ecPin);

class DFRobot_EC
{
public:
    // Construtors
    DFRobot_EC();
    DFRobot_EC(int ecPin);

    // Destructors
    ~DFRobot_EC();
    
    // Initialization
    void begin();
    
    // Calibration by Serial CMD
    void calibration(float voltage, float temperature, char* cmd);
    void calibration(float voltage, float temperature);

    // Voltage to EC value with temperature compensation
    float readEC(float voltage, float temperature);
    
private:
    int    _pin;
    int    _address;
    float  _ecvalue;
    float  _kvalue;
    float  _kvalueLow;
    float  _kvalueHigh;
    float  _voltage;
    float  _temperature;
    float  _rawEC;

    // Store the Serial CMD
    char   _cmdReceivedBuffer[ReceivedBufferLength];  
    byte   _cmdReceivedBufferIndex;

private:
    // Calibration process, wirte key parameters to EEPROM
    void    ecCalibration(byte mode); 

    boolean cmdSerialDataAvailable();

    byte    cmdParse(const char* cmd);
    byte    cmdParse();
};

#endif