Bryce Williams / MPR121

Anthony Buckton's MPR121 Driver Library

Dependents:   DRV2605L_Haptic_Driver_Demo 3872_Project

mpr121.cpp@0:f0e656f25701, 2015-10-21 (annotated)

Committer:
electromotivated
Date:
Wed Oct 21 01:07:25 2015 +0000
Revision:
0:f0e656f25701
v1 upload;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
electromotivated 0:f0e656f25701 1 /*
electromotivated 0:f0e656f25701 2 Copyright (c) 2011 Anthony Buckton (abuckton [at] blackink [dot} net {dot} au)
electromotivated 0:f0e656f25701 3
electromotivated 0:f0e656f25701 4 Permission is hereby granted, free of charge, to any person obtaining a copy
electromotivated 0:f0e656f25701 5 of this software and associated documentation files (the "Software"), to deal
electromotivated 0:f0e656f25701 6 in the Software without restriction, including without limitation the rights
electromotivated 0:f0e656f25701 7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
electromotivated 0:f0e656f25701 8 copies of the Software, and to permit persons to whom the Software is
electromotivated 0:f0e656f25701 9 furnished to do so, subject to the following conditions:
electromotivated 0:f0e656f25701 10
electromotivated 0:f0e656f25701 11 The above copyright notice and this permission notice shall be included in
electromotivated 0:f0e656f25701 12 all copies or substantial portions of the Software.
electromotivated 0:f0e656f25701 13
electromotivated 0:f0e656f25701 14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
electromotivated 0:f0e656f25701 15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
electromotivated 0:f0e656f25701 16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
electromotivated 0:f0e656f25701 17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
electromotivated 0:f0e656f25701 18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
electromotivated 0:f0e656f25701 19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
electromotivated 0:f0e656f25701 20 THE SOFTWARE.
electromotivated 0:f0e656f25701 21 */
electromotivated 0:f0e656f25701 22
electromotivated 0:f0e656f25701 23 #include <mbed.h>
electromotivated 0:f0e656f25701 24 #include <sstream>
electromotivated 0:f0e656f25701 25 #include <string>
electromotivated 0:f0e656f25701 26 #include <list>
electromotivated 0:f0e656f25701 27
electromotivated 0:f0e656f25701 28 #include <mpr121.h>
electromotivated 0:f0e656f25701 29
electromotivated 0:f0e656f25701 30 Mpr121::Mpr121(I2C *i2c, Address i2cAddress)
electromotivated 0:f0e656f25701 31 {
electromotivated 0:f0e656f25701 32 this->i2c = i2c;
electromotivated 0:f0e656f25701 33
electromotivated 0:f0e656f25701 34 address = i2cAddress;
electromotivated 0:f0e656f25701 35
electromotivated 0:f0e656f25701 36 // Configure the MPR121 settings to default
electromotivated 0:f0e656f25701 37 this->configureSettings();
electromotivated 0:f0e656f25701 38 }
electromotivated 0:f0e656f25701 39
electromotivated 0:f0e656f25701 40
electromotivated 0:f0e656f25701 41 void Mpr121::configureSettings()
electromotivated 0:f0e656f25701 42 {
electromotivated 0:f0e656f25701 43 // Put the MPR into setup mode
electromotivated 0:f0e656f25701 44 this->write(ELE_CFG,0x00);
electromotivated 0:f0e656f25701 45
electromotivated 0:f0e656f25701 46 // Electrode filters for when data is > baseline
electromotivated 0:f0e656f25701 47 unsigned char gtBaseline[] = {
electromotivated 0:f0e656f25701 48 0x01, //MHD_R
electromotivated 0:f0e656f25701 49 0x01, //NHD_R
electromotivated 0:f0e656f25701 50 0x00, //NCL_R
electromotivated 0:f0e656f25701 51 0x00 //FDL_R
electromotivated 0:f0e656f25701 52 };
electromotivated 0:f0e656f25701 53
electromotivated 0:f0e656f25701 54 writeMany(MHD_R,gtBaseline,4);
electromotivated 0:f0e656f25701 55
electromotivated 0:f0e656f25701 56 // Electrode filters for when data is < baseline
electromotivated 0:f0e656f25701 57 unsigned char ltBaseline[] = {
electromotivated 0:f0e656f25701 58 0x01, //MHD_F
electromotivated 0:f0e656f25701 59 0x01, //NHD_F
electromotivated 0:f0e656f25701 60 0xFF, //NCL_F
electromotivated 0:f0e656f25701 61 0x02 //FDL_F
electromotivated 0:f0e656f25701 62 };
electromotivated 0:f0e656f25701 63
electromotivated 0:f0e656f25701 64 writeMany(MHD_F,ltBaseline,4);
electromotivated 0:f0e656f25701 65
electromotivated 0:f0e656f25701 66 // Electrode touch and release thresholds
electromotivated 0:f0e656f25701 67 unsigned char electrodeThresholds[] = {
electromotivated 0:f0e656f25701 68 E_THR_T, // Touch Threshhold
electromotivated 0:f0e656f25701 69 E_THR_R // Release Threshold
electromotivated 0:f0e656f25701 70 };
electromotivated 0:f0e656f25701 71
electromotivated 0:f0e656f25701 72 for(int i=0; i<12; i++){
electromotivated 0:f0e656f25701 73 int result = writeMany((ELE0_T+(i*2)),electrodeThresholds,2);
electromotivated 0:f0e656f25701 74 }
electromotivated 0:f0e656f25701 75
electromotivated 0:f0e656f25701 76 // Proximity Settings
electromotivated 0:f0e656f25701 77 unsigned char proximitySettings[] = {
electromotivated 0:f0e656f25701 78 0xff, //MHD_Prox_R
electromotivated 0:f0e656f25701 79 0xff, //NHD_Prox_R
electromotivated 0:f0e656f25701 80 0x00, //NCL_Prox_R
electromotivated 0:f0e656f25701 81 0x00, //FDL_Prox_R
electromotivated 0:f0e656f25701 82 0x01, //MHD_Prox_F
electromotivated 0:f0e656f25701 83 0x01, //NHD_Prox_F
electromotivated 0:f0e656f25701 84 0xFF, //NCL_Prox_F
electromotivated 0:f0e656f25701 85 0xff, //FDL_Prox_F
electromotivated 0:f0e656f25701 86 0x00, //NHD_Prox_T
electromotivated 0:f0e656f25701 87 0x00, //NCL_Prox_T
electromotivated 0:f0e656f25701 88 0x00 //NFD_Prox_T
electromotivated 0:f0e656f25701 89 };
electromotivated 0:f0e656f25701 90 writeMany(MHDPROXR,proximitySettings,11);
electromotivated 0:f0e656f25701 91
electromotivated 0:f0e656f25701 92 unsigned char proxThresh[] = {
electromotivated 0:f0e656f25701 93 PROX_THR_T, // Touch Threshold
electromotivated 0:f0e656f25701 94 PROX_THR_R // Release Threshold
electromotivated 0:f0e656f25701 95 };
electromotivated 0:f0e656f25701 96 writeMany(EPROXTTH,proxThresh,2);
electromotivated 0:f0e656f25701 97
electromotivated 0:f0e656f25701 98 this->write(FIL_CFG,0x04);
electromotivated 0:f0e656f25701 99
electromotivated 0:f0e656f25701 100 // Set the electrode config to transition to active mode
electromotivated 0:f0e656f25701 101 this->write(ELE_CFG,0x0c);
electromotivated 0:f0e656f25701 102 }
electromotivated 0:f0e656f25701 103
electromotivated 0:f0e656f25701 104 void Mpr121::setElectrodeThreshold(int electrode, unsigned char touch, unsigned char release){
electromotivated 0:f0e656f25701 105
electromotivated 0:f0e656f25701 106 if(electrode > 11) return;
electromotivated 0:f0e656f25701 107
electromotivated 0:f0e656f25701 108 // Get the current mode
electromotivated 0:f0e656f25701 109 unsigned char mode = this->read(ELE_CFG);
electromotivated 0:f0e656f25701 110
electromotivated 0:f0e656f25701 111 // Put the MPR into setup mode
electromotivated 0:f0e656f25701 112 this->write(ELE_CFG,0x00);
electromotivated 0:f0e656f25701 113
electromotivated 0:f0e656f25701 114 // Write the new threshold
electromotivated 0:f0e656f25701 115 this->write((ELE0_T+(electrode*2)), touch);
electromotivated 0:f0e656f25701 116 this->write((ELE0_T+(electrode*2)+1), release);
electromotivated 0:f0e656f25701 117
electromotivated 0:f0e656f25701 118 //Restore the operating mode
electromotivated 0:f0e656f25701 119 this->write(ELE_CFG, mode);
electromotivated 0:f0e656f25701 120 }
electromotivated 0:f0e656f25701 121
electromotivated 0:f0e656f25701 122
electromotivated 0:f0e656f25701 123 unsigned char Mpr121::read(int key){
electromotivated 0:f0e656f25701 124
electromotivated 0:f0e656f25701 125 unsigned char data[2];
electromotivated 0:f0e656f25701 126
electromotivated 0:f0e656f25701 127 //Start the command
electromotivated 0:f0e656f25701 128 i2c->start();
electromotivated 0:f0e656f25701 129
electromotivated 0:f0e656f25701 130 // Address the target (Write mode)
electromotivated 0:f0e656f25701 131 int ack1= i2c->write(address);
electromotivated 0:f0e656f25701 132
electromotivated 0:f0e656f25701 133 // Set the register key to read
electromotivated 0:f0e656f25701 134 int ack2 = i2c->write(key);
electromotivated 0:f0e656f25701 135
electromotivated 0:f0e656f25701 136 // Re-start for read of data
electromotivated 0:f0e656f25701 137 i2c->start();
electromotivated 0:f0e656f25701 138
electromotivated 0:f0e656f25701 139 // Re-send the target address in read mode
electromotivated 0:f0e656f25701 140 int ack3 = i2c->write(address+1);
electromotivated 0:f0e656f25701 141
electromotivated 0:f0e656f25701 142 // Read in the result
electromotivated 0:f0e656f25701 143 data[0] = i2c->read(0);
electromotivated 0:f0e656f25701 144
electromotivated 0:f0e656f25701 145 // Reset the bus
electromotivated 0:f0e656f25701 146 i2c->stop();
electromotivated 0:f0e656f25701 147
electromotivated 0:f0e656f25701 148 return data[0];
electromotivated 0:f0e656f25701 149 }
electromotivated 0:f0e656f25701 150
electromotivated 0:f0e656f25701 151
electromotivated 0:f0e656f25701 152 int Mpr121::write(int key, unsigned char value){
electromotivated 0:f0e656f25701 153
electromotivated 0:f0e656f25701 154 //Start the command
electromotivated 0:f0e656f25701 155 i2c->start();
electromotivated 0:f0e656f25701 156
electromotivated 0:f0e656f25701 157 // Address the target (Write mode)
electromotivated 0:f0e656f25701 158 int ack1= i2c->write(address);
electromotivated 0:f0e656f25701 159
electromotivated 0:f0e656f25701 160 // Set the register key to write
electromotivated 0:f0e656f25701 161 int ack2 = i2c->write(key);
electromotivated 0:f0e656f25701 162
electromotivated 0:f0e656f25701 163 // Read in the result
electromotivated 0:f0e656f25701 164 int ack3 = i2c->write(value);
electromotivated 0:f0e656f25701 165
electromotivated 0:f0e656f25701 166 // Reset the bus
electromotivated 0:f0e656f25701 167 i2c->stop();
electromotivated 0:f0e656f25701 168
electromotivated 0:f0e656f25701 169 return (ack1+ack2+ack3)-3;
electromotivated 0:f0e656f25701 170 }
electromotivated 0:f0e656f25701 171
electromotivated 0:f0e656f25701 172
electromotivated 0:f0e656f25701 173 int Mpr121::writeMany(int start, unsigned char* dataSet, int length){
electromotivated 0:f0e656f25701 174 //Start the command
electromotivated 0:f0e656f25701 175 i2c->start();
electromotivated 0:f0e656f25701 176
electromotivated 0:f0e656f25701 177 // Address the target (Write mode)
electromotivated 0:f0e656f25701 178 int ack= i2c->write(address);
electromotivated 0:f0e656f25701 179 if(ack!=1){
electromotivated 0:f0e656f25701 180 return -1;
electromotivated 0:f0e656f25701 181 }
electromotivated 0:f0e656f25701 182
electromotivated 0:f0e656f25701 183 // Set the register key to write
electromotivated 0:f0e656f25701 184 ack = i2c->write(start);
electromotivated 0:f0e656f25701 185 if(ack!=1){
electromotivated 0:f0e656f25701 186 return -1;
electromotivated 0:f0e656f25701 187 }
electromotivated 0:f0e656f25701 188
electromotivated 0:f0e656f25701 189 // Write the date set
electromotivated 0:f0e656f25701 190 int count = 0;
electromotivated 0:f0e656f25701 191 while(ack==1 && (count < length)){
electromotivated 0:f0e656f25701 192 ack = i2c->write(dataSet[count]);
electromotivated 0:f0e656f25701 193 count++;
electromotivated 0:f0e656f25701 194 }
electromotivated 0:f0e656f25701 195 // Stop the cmd
electromotivated 0:f0e656f25701 196 i2c->stop();
electromotivated 0:f0e656f25701 197
electromotivated 0:f0e656f25701 198 return count;
electromotivated 0:f0e656f25701 199 }
electromotivated 0:f0e656f25701 200
electromotivated 0:f0e656f25701 201
electromotivated 0:f0e656f25701 202 bool Mpr121::getProximityMode(){
electromotivated 0:f0e656f25701 203 if(this->read(ELE_CFG) > 0x0c)
electromotivated 0:f0e656f25701 204 return true;
electromotivated 0:f0e656f25701 205 else
electromotivated 0:f0e656f25701 206 return false;
electromotivated 0:f0e656f25701 207 }
electromotivated 0:f0e656f25701 208
electromotivated 0:f0e656f25701 209 void Mpr121::setProximityMode(bool mode){
electromotivated 0:f0e656f25701 210 this->write(ELE_CFG,0x00);
electromotivated 0:f0e656f25701 211 if(mode){
electromotivated 0:f0e656f25701 212 this->write(ELE_CFG,0x30); //Sense proximity from ALL pads
electromotivated 0:f0e656f25701 213 } else {
electromotivated 0:f0e656f25701 214 this->write(ELE_CFG,0x0c); //Sense touch, all 12 pads active.
electromotivated 0:f0e656f25701 215 }
electromotivated 0:f0e656f25701 216 }
electromotivated 0:f0e656f25701 217
electromotivated 0:f0e656f25701 218
electromotivated 0:f0e656f25701 219 int Mpr121::readTouchData(){
electromotivated 0:f0e656f25701 220 return this->read(0x00);
electromotivated 0:f0e656f25701 221 }