t3311.hpp

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * 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.
 */
#pragma once

#include <string>

#include <modbus/modbus.h>

namespace upm {

  class T3311 {
  public:

    // MODBUS input registers
    typedef enum {
      REG_TEMPERATURE                       = 0x0030,
      REG_HUMIDITY                          = 0x0031,

      // This value is configured in the device itself.  By default,
      // it represents the Dew Point Temperature.  Use the
      // configuration utility from Comet to adjust the configuration.
      REG_COMPUTED                          = 0x0032,

      // available in devices with FW > 2.44
      REG_DEW_POINT                         = 0x0034,
      REG_ABS_HUMIDITY                      = 0x0035,
      REG_SPECIFIC_HUMIDITY                 = 0x0036,
      REG_MIXING_RATIO                      = 0x0037,
      REG_SPECIFIC_ENTHALPY                 = 0x0038,

      // 32 bit serial number.  These appear to be reversed when
      // comparing against the TSensor config utility, so the
      // datasheet is probably wrong.
      REG_SERIAL_HI                         = 0x1034,
      REG_SERIAL_LO                         = 0x1035,

      // this is 'somewhat' documented (middle of page 15 in the
      // Advantech-ADAM standard section) in the "Description of
      // communications protocols of TXXXX series" document.  We use
      // it to simply detect whether the device is configured for
      // Celsius or Fahrenheit data and compensate internally.

      REG_UNIT_SETTINGS                     = 0x203F,

      // firmware revision, BCD byte encoded. We only care about the
      // LO word - the HI word just contains the manufacturing date.
      REG_FW_HI                             = 0x3000,
      REG_FW_LO                             = 0x3001
    } REGS_T;


    T3311(std::string device, int address, int baud=9600, int bits=8,
          char parity='N', int stopBits=2);

    ~T3311();

    bool extendedDataAvailable()
    {
      return m_isExtendedDataAvailable;
    };

    void update();

    float getTemperature(bool fahrenheit=false);

    float getHumidity();

    float getComputedValue();

    float getDewPointTemperature(bool fahrenheit=false);

    float getAbsoluteHumidity();

    float getSpecificHumidity();

    float getMixingRatio();

    float getSpecificEnthalpy();

    std::string getSerialNumber()
    {
      return m_serialNumber;
    };

    int getFirmwareMajor()
    {
      return m_fwRevHi;
    };

    int getFirmwareMinor()
    {
      return m_fwRevLo;
    };

    void setDebug(bool enable);

  protected:
    uint16_t readInputReg(int reg);
    int readInputRegs(int reg, int len, uint16_t *buf);

    // MODBUS context
    modbus_t *m_mbContext;

    // is the device reporting in C or F?
    bool m_isCelsius;

    // Is the device FW > than 2.44?
    bool m_isExtendedDataAvailable;

    int m_fwRevHi;
    int m_fwRevLo;

    std::string m_serialNumber;

  private:
    bool m_debugging;

    // data
    float m_temperature;
    float m_humidity; // relative
    float m_computedValue;

    // with FW versions > 2.44, these other computed values are
    // available.
    float m_dewPointTemperature;
    float m_absoluteHumidity;
    float m_specificHumidity;
    float m_mixingRatio;
    float m_specificEnthalpy;
  };
}