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.hpp> 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 MAX44000 Proximity Sensor library 57 * @defgroup max44000 libupm-max44000 58 * @ingroup maxim i2c light 59 */ 60 /** 61 * @library max44000 62 * @sensor max44000 63 * @comname MAX44000 Proximity Sensor 64 * @type light 65 * @man maxim 66 * @con i2c 67 * 68 * @brief API for the MAX44000 Ambient and Infrared Proximity Sensor 69 * 70 * Maxim Integrated* 71 * [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf) 72 * is an ambient and infrared proximity sensor. This module was tested on the 73 * Maxim Integrated 74 * [MAX44000PMB1 PMOD module] 75 * (http://datasheets.maximintegrated.com/en/ds/MAX44000PMB1.pdf) from the 76 * analog PMOD kit. 77 * 78 * @snippet max44000.cxx Interesting 79 */ 80 class MAX44000 { 81 public: 82 /** 83 * Instantiates an MAX44000 object 84 * 85 * @param bus Number of the used bus 86 * @param devAddr Address of the used I2C device 87 */ 88 MAX44000 (int bus, int devAddr=ADDR); 89 90 /** 91 * MAX44000 object destructor; basically, it closes the I2C connection. 92 * ~MAX44000 (); 93 * no need for the destructor - the I2c connection will be closed when 94 * m_i2cMaxControlCtx variable will be out of context 95 **/ 96 97 /** 98 * Reads the proximity value from the sensor (based on ambient data). 99 */ 100 uint16_t getProximity (); 101 /** 102 * Reads the ambient value from the sensor (based on ambient data). 103 */ 104 uint16_t getAmbient (); 105 106 /** 107 * Returns the name of the component 108 */ name()109 std::string name() 110 { 111 return m_name; 112 } 113 114 /** 115 * Reads a one-byte register 116 * 117 * @param reg Address of the register 118 */ 119 uint8_t i2cReadReg_8 (int reg); 120 121 /** 122 * Reads a two-byte register 123 * 124 * @param reg Address of the register 125 */ 126 uint16_t i2cReadReg_16 (int reg); 127 128 /** 129 * Writes to a one-byte register 130 * 131 * @param reg Address of the register 132 * @param value Byte to be written 133 */ 134 mraa::Result i2cWriteReg (uint8_t reg, uint8_t value); 135 136 private: 137 std::string m_name; 138 139 int m_maxControlAddr; 140 int m_bus; 141 mraa::I2c m_i2cMaxControlCtx; 142 }; 143 144 } 145