Rahul Maran / Mbed 2 deprecated 4180Lab_4

a

Dependencies:   4DGL-uLCD-SE LSM9DS1_Library_cal SDFileSystem mbed-rtos mbed wave_player

mpr121.h@0:2b0c527942db, 2016-11-02 (annotated)

Committer:
rmaran6
Date:
Wed Nov 02 02:02:03 2016 +0000
Revision:
0:2b0c527942db
a

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rmaran6 0:2b0c527942db 1 /*
rmaran6 0:2b0c527942db 2 Copyright (c) 2011 Anthony Buckton (abuckton [at] blackink [dot} net {dot} au)
rmaran6 0:2b0c527942db 3
rmaran6 0:2b0c527942db 4
rmaran6 0:2b0c527942db 5 Permission is hereby granted, free of charge, to any person obtaining a copy
rmaran6 0:2b0c527942db 6 of this software and associated documentation files (the "Software"), to deal
rmaran6 0:2b0c527942db 7 in the Software without restriction, including without limitation the rights
rmaran6 0:2b0c527942db 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
rmaran6 0:2b0c527942db 9 copies of the Software, and to permit persons to whom the Software is
rmaran6 0:2b0c527942db 10 furnished to do so, subject to the following conditions:
rmaran6 0:2b0c527942db 11
rmaran6 0:2b0c527942db 12 The above copyright notice and this permission notice shall be included in
rmaran6 0:2b0c527942db 13 all copies or substantial portions of the Software.
rmaran6 0:2b0c527942db 14
rmaran6 0:2b0c527942db 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
rmaran6 0:2b0c527942db 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
rmaran6 0:2b0c527942db 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
rmaran6 0:2b0c527942db 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
rmaran6 0:2b0c527942db 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
rmaran6 0:2b0c527942db 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
rmaran6 0:2b0c527942db 21 THE SOFTWARE.
rmaran6 0:2b0c527942db 22
rmaran6 0:2b0c527942db 23 Parts written by Jim Lindblom of Sparkfun
rmaran6 0:2b0c527942db 24 Ported to mbed by A.Buckton, Feb 2011
rmaran6 0:2b0c527942db 25 */
rmaran6 0:2b0c527942db 26
rmaran6 0:2b0c527942db 27 #ifndef MPR121_H
rmaran6 0:2b0c527942db 28 #define MPR121_H
rmaran6 0:2b0c527942db 29
rmaran6 0:2b0c527942db 30 //using namespace std;
rmaran6 0:2b0c527942db 31
rmaran6 0:2b0c527942db 32 class Mpr121
rmaran6 0:2b0c527942db 33 {
rmaran6 0:2b0c527942db 34
rmaran6 0:2b0c527942db 35 public:
rmaran6 0:2b0c527942db 36 // i2c Addresses, bit-shifted
rmaran6 0:2b0c527942db 37 enum Address { ADD_VSS = 0xb4,// ADD->VSS = 0x5a <-wiring on Sparkfun board
rmaran6 0:2b0c527942db 38 ADD_VDD = 0xb6,// ADD->VDD = 0x5b
rmaran6 0:2b0c527942db 39 ADD_SCL = 0xb8,// ADD->SDA = 0x5c
rmaran6 0:2b0c527942db 40 ADD_SDA = 0xba // ADD->SCL = 0x5d
rmaran6 0:2b0c527942db 41 };
rmaran6 0:2b0c527942db 42
rmaran6 0:2b0c527942db 43 // Real initialiser, takes the i2c address of the device.
rmaran6 0:2b0c527942db 44 Mpr121(I2C *i2c, Address i2cAddress);
rmaran6 0:2b0c527942db 45
rmaran6 0:2b0c527942db 46 bool getProximityMode();
rmaran6 0:2b0c527942db 47
rmaran6 0:2b0c527942db 48 void setProximityMode(bool mode);
rmaran6 0:2b0c527942db 49
rmaran6 0:2b0c527942db 50 int readTouchData();
rmaran6 0:2b0c527942db 51
rmaran6 0:2b0c527942db 52 unsigned char read(int key);
rmaran6 0:2b0c527942db 53
rmaran6 0:2b0c527942db 54 int write(int address, unsigned char value);
rmaran6 0:2b0c527942db 55 int writeMany(int start, unsigned char* dataSet, int length);
rmaran6 0:2b0c527942db 56
rmaran6 0:2b0c527942db 57 void setElectrodeThreshold(int electrodeId, unsigned char touchThreshold, unsigned char releaseThreshold);
rmaran6 0:2b0c527942db 58
rmaran6 0:2b0c527942db 59 protected:
rmaran6 0:2b0c527942db 60 // Configures the MPR with standard settings. This is permitted to be overwritten by sub-classes.
rmaran6 0:2b0c527942db 61 void configureSettings();
rmaran6 0:2b0c527942db 62
rmaran6 0:2b0c527942db 63 private:
rmaran6 0:2b0c527942db 64 // The I2C bus instance.
rmaran6 0:2b0c527942db 65 I2C *i2c;
rmaran6 0:2b0c527942db 66
rmaran6 0:2b0c527942db 67 // i2c address of this mpr121
rmaran6 0:2b0c527942db 68 Address address;
rmaran6 0:2b0c527942db 69 };
rmaran6 0:2b0c527942db 70
rmaran6 0:2b0c527942db 71
rmaran6 0:2b0c527942db 72 // MPR121 Register Defines
rmaran6 0:2b0c527942db 73 #define MHD_R 0x2B
rmaran6 0:2b0c527942db 74 #define NHD_R 0x2C
rmaran6 0:2b0c527942db 75 #define NCL_R 0x2D
rmaran6 0:2b0c527942db 76 #define FDL_R 0x2E
rmaran6 0:2b0c527942db 77 #define MHD_F 0x2F
rmaran6 0:2b0c527942db 78 #define NHD_F 0x30
rmaran6 0:2b0c527942db 79 #define NCL_F 0x31
rmaran6 0:2b0c527942db 80 #define FDL_F 0x32
rmaran6 0:2b0c527942db 81 #define NHDT 0x33
rmaran6 0:2b0c527942db 82 #define NCLT 0x34
rmaran6 0:2b0c527942db 83 #define FDLT 0x35
rmaran6 0:2b0c527942db 84 // Proximity sensing controls
rmaran6 0:2b0c527942db 85 #define MHDPROXR 0x36
rmaran6 0:2b0c527942db 86 #define NHDPROXR 0x37
rmaran6 0:2b0c527942db 87 #define NCLPROXR 0x38
rmaran6 0:2b0c527942db 88 #define FDLPROXR 0x39
rmaran6 0:2b0c527942db 89 #define MHDPROXF 0x3A
rmaran6 0:2b0c527942db 90 #define NHDPROXF 0x3B
rmaran6 0:2b0c527942db 91 #define NCLPROXF 0x3C
rmaran6 0:2b0c527942db 92 #define FDLPROXF 0x3D
rmaran6 0:2b0c527942db 93 #define NHDPROXT 0x3E
rmaran6 0:2b0c527942db 94 #define NCLPROXT 0x3F
rmaran6 0:2b0c527942db 95 #define FDLPROXT 0x40
rmaran6 0:2b0c527942db 96 // Electrode Touch/Release thresholds
rmaran6 0:2b0c527942db 97 #define ELE0_T 0x41
rmaran6 0:2b0c527942db 98 #define ELE0_R 0x42
rmaran6 0:2b0c527942db 99 #define ELE1_T 0x43
rmaran6 0:2b0c527942db 100 #define ELE1_R 0x44
rmaran6 0:2b0c527942db 101 #define ELE2_T 0x45
rmaran6 0:2b0c527942db 102 #define ELE2_R 0x46
rmaran6 0:2b0c527942db 103 #define ELE3_T 0x47
rmaran6 0:2b0c527942db 104 #define ELE3_R 0x48
rmaran6 0:2b0c527942db 105 #define ELE4_T 0x49
rmaran6 0:2b0c527942db 106 #define ELE4_R 0x4A
rmaran6 0:2b0c527942db 107 #define ELE5_T 0x4B
rmaran6 0:2b0c527942db 108 #define ELE5_R 0x4C
rmaran6 0:2b0c527942db 109 #define ELE6_T 0x4D
rmaran6 0:2b0c527942db 110 #define ELE6_R 0x4E
rmaran6 0:2b0c527942db 111 #define ELE7_T 0x4F
rmaran6 0:2b0c527942db 112 #define ELE7_R 0x50
rmaran6 0:2b0c527942db 113 #define ELE8_T 0x51
rmaran6 0:2b0c527942db 114 #define ELE8_R 0x52
rmaran6 0:2b0c527942db 115 #define ELE9_T 0x53
rmaran6 0:2b0c527942db 116 #define ELE9_R 0x54
rmaran6 0:2b0c527942db 117 #define ELE10_T 0x55
rmaran6 0:2b0c527942db 118 #define ELE10_R 0x56
rmaran6 0:2b0c527942db 119 #define ELE11_T 0x57
rmaran6 0:2b0c527942db 120 #define ELE11_R 0x58
rmaran6 0:2b0c527942db 121 // Proximity Touch/Release thresholds
rmaran6 0:2b0c527942db 122 #define EPROXTTH 0x59
rmaran6 0:2b0c527942db 123 #define EPROXRTH 0x5A
rmaran6 0:2b0c527942db 124 // Debounce configuration
rmaran6 0:2b0c527942db 125 #define DEB_CFG 0x5B
rmaran6 0:2b0c527942db 126 // AFE- Analogue Front End configuration
rmaran6 0:2b0c527942db 127 #define AFE_CFG 0x5C
rmaran6 0:2b0c527942db 128 // Filter configuration
rmaran6 0:2b0c527942db 129 #define FIL_CFG 0x5D
rmaran6 0:2b0c527942db 130 // Electrode configuration - transistions to "active mode"
rmaran6 0:2b0c527942db 131 #define ELE_CFG 0x5E
rmaran6 0:2b0c527942db 132
rmaran6 0:2b0c527942db 133 #define GPIO_CTRL0 0x73
rmaran6 0:2b0c527942db 134 #define GPIO_CTRL1 0x74
rmaran6 0:2b0c527942db 135 #define GPIO_DATA 0x75
rmaran6 0:2b0c527942db 136 #define GPIO_DIR 0x76
rmaran6 0:2b0c527942db 137 #define GPIO_EN 0x77
rmaran6 0:2b0c527942db 138 #define GPIO_SET 0x78
rmaran6 0:2b0c527942db 139 #define GPIO_CLEAR 0x79
rmaran6 0:2b0c527942db 140 #define GPIO_TOGGLE 0x7A
rmaran6 0:2b0c527942db 141 // Auto configration registers
rmaran6 0:2b0c527942db 142 #define AUTO_CFG_0 0x7B
rmaran6 0:2b0c527942db 143 #define AUTO_CFG_U 0x7D
rmaran6 0:2b0c527942db 144 #define AUTO_CFG_L 0x7E
rmaran6 0:2b0c527942db 145 #define AUTO_CFG_T 0x7F
rmaran6 0:2b0c527942db 146
rmaran6 0:2b0c527942db 147 // Threshold defaults
rmaran6 0:2b0c527942db 148 // Electrode touch threshold
rmaran6 0:2b0c527942db 149 #define E_THR_T 0x0F
rmaran6 0:2b0c527942db 150 // Electrode release threshold
rmaran6 0:2b0c527942db 151 #define E_THR_R 0x0A
rmaran6 0:2b0c527942db 152 // Prox touch threshold
rmaran6 0:2b0c527942db 153 #define PROX_THR_T 0x02
rmaran6 0:2b0c527942db 154 // Prox release threshold
rmaran6 0:2b0c527942db 155 #define PROX_THR_R 0x02
rmaran6 0:2b0c527942db 156
rmaran6 0:2b0c527942db 157 #endif