src/max44000/max44000.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include <mraa/i2c.h>
  28
  29 #define ADDR               0x4A // device address
  30
  31 // registers address
  32 #define ISR                0x00 // Interrupt Status Register
  33 #define MCR                0x01 // Main Configuration Register
  34 #define RCR                0x02 // Receive Configuration Register
  35 #define TCR                0x03 // Transmit Configuration Register
  36 #define ALSDATA_HIGH       0x04 // ambient sensor data high byte
  37 #define ALSDATA_LOW        0x05 // ambient sensor data low byte
  38 #define PRXDATA            0x15 // proximity sensor data
  39
  40 #define ALS_UP_THRESH_HIGH 0x06 // ALS Interrupt Threshold Registers High
  41 #define ALS_UP_THRESH_LOW  0x07 // ALS Interrupt Threshold Registers LOW
  42 #define ALS_LO_THRESH_HIGH 0x08 // ALS Interrupt Threshold Registers High
  43 #define ALS_LO_THRESH_LOW  0x09 // ALS Interrupt Threshold Registers Low
  44 #define TPTR               0x0A // ALS/PROX Threshold Persist Timer Register
  45 #define PROX_THRESH_IND    0x0B // Proximity Threshold Register
  46 #define PROX_THRESH        0x0C // Proximity Threshold Register
  47 #define TRIM_GAIN_GREEN    0x0F // Digital Gain Trim Register
  48 #define TRIM_GAIN_IR       0x10 // Digital Gain Trim Register
  49
  50 #define HIGH               1
  51 #define LOW                0
  52
  53 namespace upm {
  54
  55 /**
  56  * @brief C++ API for MAX44000 chip (Ambient and Infrared Proximity Sensor)
  57  *
  58  * This file defines the MAX44000 C++ interface for libmax44000
  59  *
  60  * @snippet proximity.cxx Interesting
  61  *
  62  * PMOD pins for MAX44000PMB1 board
  63  *
  64  * ( -= J1 =- )
  65  * (1) - NUL
  66  * (2) - IRQ
  67  * (3) - SCL
  68  * (4) - SDA
  69  * (5) - GND
  70  * (6) - VCC
  71  *
  72  */
  73 class MAX44000 {
  74     public:
  75         /**
  76          * Instanciates a MAX44000 object
  77          *
  78          * @param bus number of used bus
  79          * @param devAddr addres of used i2c device
  80          */
  81         MAX44000 (int bus, int devAddr);
  82
  83         /**
  84          * MAX44000 object destructor, basicaly it close i2c connection.
  85          */
  86         ~MAX44000 ();
  87
  88         /**
  89          * Read the proximity value from the chip (based on ambient data).
  90          */
  91         uint16_t getProximity ();
  92         /**
  93          * Read the ambient value from the chip (based on ambient data).
  94          */
  95         uint16_t getAmbient ();
  96
  97         /**
  98          * Return name of the component
  99          */
 100         std::string name()
 101         {
 102             return m_name;
 103         }
 104
 105         /**
 106          * Read one byte register
 107          *
 108          * @param reg address of a register
 109          */
 110         uint8_t i2cReadReg_8 (int reg);
 111
 112         /**
 113          * Read two bytes register
 114          *
 115          * @param reg address of a register
 116          */
 117         uint16_t i2cReadReg_16 (int reg);
 118
 119         /**
 120          * Write to one byte register
 121          *
 122          * @param reg address of a register
 123          * @param value byte to be written
 124          */
 125         mraa_result_t i2cWriteReg (uint8_t reg, uint8_t value);
 126
 127     private:
 128         std::string m_name;
 129
 130         int m_maxControlAddr;
 131         int m_bus;
 132         mraa_i2c_context m_i2cMaxControlCtx;
 133 };
 134
 135 }