Max Brown / Mbed 2 deprecated Capacitive_Touch_Sensor_MP3_Player

Capacitive Touch Sensor Controlling an MP3 Player

Dependencies:   4DGL-uLCD-SE SDFileSystem TextLCD mbed wave_player

mpr121.h@0:1cb83aab3f9a, 2016-12-08 (annotated)

Committer:
maxmbrown
Date:
Thu Dec 08 20:20:09 2016 +0000
Revision:
0:1cb83aab3f9a
Capacitive Touch Sensor Controlling an MP3 Player

Who changed what in which revision?

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