si114x.hpp

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2015 Intel Corporation.
 *
 * Thanks to Adafruit for some important clues
 *
 * 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 <mraa/i2c.h>
#include <mraa/gpio.h>

#define SI114X_I2C_BUS 0
#define SI114X_DEFAULT_I2C_ADDR 0x60
#define SI114X_HW_KEY 0x17


namespace upm {
  
  class SI114X {
  public:

    typedef enum { REG_PART_ID       = 0x00,
                   REG_REV_ID        = 0x01,
                   REG_SEQ_ID        = 0x02,
                   REG_INT_CFG       = 0x03,
                   REG_IRQ_ENABLE    = 0x04,

                   // these two are not documented in the datasheet,
                   // but are mentioned there, as well as in the
                   // Adafruit example
                   REG_IRQ_MODE1     = 0x05,
                   REG_IRQ_MODE2     = 0x06,

                   REG_HW_KEY        = 0x07,
                   REG_MEAS_RATE0    = 0x08,
                   REG_MEAS_RATE1    = 0x09,

                   REG_PS_LED21      = 0x0f,
                   REG_PS_LED3       = 0x10,

                   REG_UCOEF0        = 0x13,
                   REG_UCOEF1        = 0x14,
                   REG_UCOEF2        = 0x15,
                   REG_UCOEF3        = 0x16,
                   REG_PARAM_WR      = 0x17,
                   REG_COMMAND       = 0x18,

                   REG_RESPONSE      = 0x20,
                   REG_IRQ_STATUS    = 0x21,
                   REG_ALS_VIS_DATA0 = 0x22,
                   REG_ALS_VIS_DATA1 = 0x23,
                   REG_ALS_IR_DATA0  = 0x24,
                   REG_ALS_IR_DATA1  = 0x25,
                   REG_PS1_DATA0     = 0x26,
                   REG_PS1_DATA1     = 0x27,
                   REG_PS2_DATA0     = 0x28,
                   REG_PS2_DATA1     = 0x29,
                   REG_PS3_DATA0     = 0x2a,
                   REG_PS3_DATA1     = 0x2b,
                   REG_AUX_UVINDEX0  = 0x2c,
                   REG_AUX_UVINDEX1  = 0x2d,
                   REG_PARAM_READ    = 0x2e,

                   REG_CHIP_STAT     = 0x30,

                   REG_ANA_IN_KEY0   = 0x3b,
                   REG_ANA_IN_KEY1   = 0x3c,
                   REG_ANA_IN_KEY2   = 0x3d,
                   REG_ANA_IN_KEY3   = 0x3e
    } SI114X_REG_T;
    
    typedef enum { PARAM_I2C_ADDDR         = 0x00,
                   PARAM_CHLIST            = 0x01,
                   PARAM_PSLED12_SEL       = 0x02,
                   PARAM_PSLED3_SEL        = 0x03,

                   PARAM_PS_ENCODING       = 0x05,
                   PARAM_ALS_ENCODING      = 0x06,
                   PARAM_PS1_ADCMUX        = 0x07,
                   PARAM_PS2_ADCMUX        = 0x08,
                   PARAM_PS3_ADCMUX        = 0x09,
                   PARAM_PS_ADC_COUNT      = 0x0a,
                   PARAM_PS_ADC_GAIN       = 0x0b,
                   PARAM_PS_ADC_MISC       = 0x0c,

                   PARAM_ALS_IR_ADCMUX     = 0x0e,
                   PARAM_AUX_ADCMUX        = 0x0f,
                   PARAM_ALS_VIS_ADC_COUNT = 0x10,
                   PARAM_ALS_VIS_ADC_GAIN  = 0x11,
                   PARAM_ALS_VIS_ADC_MISC  = 0x12,

                   PARAM_LED_REC           = 0x1c,
                   PARAM_ALS_IR_ADC_COUNT  = 0x1d,
                   PARAM_ALS_IR_ADX_GAIN   = 0x1e,
                   PARAM_ALS_IR_ADC_MISC   = 0x1f
    } SI114X_PARAM_T;
    
    typedef enum { CMD_NOOP          = 0x00, // clear RESPONSE reg
                   CMD_RESET         = 0x01,
                   CMD_BUSADDR       = 0x02,

                   CMD_PS_FORCE      = 0x05,
                   CMD_GET_CAL       = 0x12,
                   CMD_ALS_FORCE     = 0x06,
                   CMD_PSALS_FORCE   = 0x07,

                   CMD_PS_PAUSE      = 0x09,
                   CMD_ALS_PAUSE     = 0x0a,
                   CMD_PSALS_PAUSE   = 0x0b,

                   CMD_PS_AUTO       = 0x0d,
                   CMD_ALS_AUTO      = 0x0e,
                   CMD_PSALS_AUTO    = 0x0f,

                   CMD_PARAM_QUERY   = 0x80, // OR'd with PARAM_T value
                   CMD_PARAM_SET     = 0xa0  // OR'd with PARAM_T value
    } SI114X_CMD_T;


    typedef enum { CHLIST_EN_PS1     = 0x01, // proximity sense 1-3
                   CHLIST_EN_PS2     = 0x02,
                   CHLIST_EN_PS3     = 0x04,

                   CHLIST_EN_ALS_VIS = 0x10, // ambient light sense
                   CHLIST_EN_ALS_IR  = 0x20,
                   CHLIST_EN_AUX     = 0x40, // AUX sense
                   CHLIST_EN_UV      = 0x80  // UV sense
    } SI114X_CHLIST_BITS_T;

    typedef enum { ERR_NONE          = 0x00, // no error if high nibble is 0
                                             // lower nibble is a counter
                   ERR_INVALID_SET   = 0x80, // invalid setting
                   ERR_PS1_ADC_OVER  = 0x88, // overflows
                   ERR_PS2_ADC_OVER  = 0x89,
                   ERR_PS3_ADC_OVER  = 0x8a,
                   ERR_ALS_VIS_ADC_OVER  = 0x8c,
                   ERR_ALS_IR_ADC_OVER   = 0x8d,
                   ERR_AUX_ADC_OVER  = 0x8e
    } SI114X_ERR_T;
    

    typedef enum { IRQEN_ALS_IE      = 0x01,
                   IRQEN_PS1_IE      = 0x04,
                   IRQEN_PS2_IE      = 0x08,
                   IRQEN_PS3_IE      = 0x10
    } SI114X_IRQEN_BITS_T;

    SI114X(int bus, uint8_t address = SI114X_DEFAULT_I2C_ADDR);

    ~SI114X();

    bool writeByte(uint8_t reg, uint8_t byte);

    uint8_t readByte(uint8_t reg);

    uint16_t readWord(uint8_t reg);

    void reset();

    void setUVCalibration(uint8_t uvcoeff0, uint8_t uvcoeff1, uint8_t uvcoeff2,
                          uint8_t uvcoeff3);

    void writeParam(SI114X_PARAM_T param, uint8_t value);
    
    uint8_t readParam(SI114X_PARAM_T param);

    void initialize();

    void update();

    float getUVIndex() { return m_uvIndex; };

  private:
    mraa_i2c_context m_i2c;
    uint8_t m_addr;
    // UV calibration values
    uint8_t m_uv_cal[4];
    // updated by update()
    float m_uvIndex;
  };
}