Martin Sturm / Mbed 2 deprecated Project

Dependencies:   mbed

mpr121.h@1:44f0b9d5883b, 2011-12-14 (annotated)

Committer:
XkLi
Date:
Wed Dec 14 02:46:16 2011 +0000
Revision:
1:44f0b9d5883b
Parent:
0:2fab16867d73 

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


XkLi

0:2fab16867d73


     1

/*





XkLi

0:2fab16867d73


     2

Copyright (c) 2011 Anthony Buckton (abuckton [at] blackink [dot} net {dot} au)





XkLi

0:2fab16867d73


     3







XkLi

0:2fab16867d73


     4

 





XkLi

0:2fab16867d73


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





XkLi

0:2fab16867d73


     6

of this software and associated documentation files (the "Software"), to deal





XkLi

0:2fab16867d73


     7

in the Software without restriction, including without limitation the rights





XkLi

0:2fab16867d73


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





XkLi

0:2fab16867d73


     9

copies of the Software, and to permit persons to whom the Software is





XkLi

0:2fab16867d73


    10

furnished to do so, subject to the following conditions:





XkLi

0:2fab16867d73


    11

 





XkLi

0:2fab16867d73


    12

The above copyright notice and this permission notice shall be included in





XkLi

0:2fab16867d73


    13

all copies or substantial portions of the Software.





XkLi

0:2fab16867d73


    14

 





XkLi

0:2fab16867d73


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





XkLi

0:2fab16867d73


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





XkLi

0:2fab16867d73


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





XkLi

0:2fab16867d73


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





XkLi

0:2fab16867d73


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





XkLi

0:2fab16867d73


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





XkLi

0:2fab16867d73


    21

THE SOFTWARE.





XkLi

0:2fab16867d73


    22







XkLi

0:2fab16867d73


    23

   Parts written by Jim Lindblom of Sparkfun





XkLi

0:2fab16867d73


    24

   Ported to mbed by A.Buckton, Feb 2011





XkLi

0:2fab16867d73


    25

*/





XkLi

0:2fab16867d73


    26







XkLi

0:2fab16867d73


    27

#ifndef MPR121_H





XkLi

0:2fab16867d73


    28

#define MPR121_H





XkLi

0:2fab16867d73


    29







XkLi

0:2fab16867d73


    30

//using namespace std;





XkLi

0:2fab16867d73


    31







XkLi

0:2fab16867d73


    32

class Mpr121 





XkLi

0:2fab16867d73


    33

{





XkLi

0:2fab16867d73


    34







XkLi

0:2fab16867d73


    35

public:





XkLi

0:2fab16867d73


    36

    // i2c Addresses, bit-shifted





XkLi

0:2fab16867d73


    37

    enum Address { ADD_VSS = 0xb4,// 





XkLi

0:2fab16867d73


    38

                   //ADD_VSS = 0x5a,// <-wiring on Sparkfun board





XkLi

0:2fab16867d73


    39

                   ADD_VDD = 0xb6,// 





XkLi

0:2fab16867d73


    40

                   //ADD_VDD = 0x5b,





XkLi

0:2fab16867d73


    41

                   ADD_SCL = 0xb8,// 





XkLi

0:2fab16867d73


    42

                   //ADD_SDA = 0x5c,





XkLi

0:2fab16867d73


    43

                   ADD_SDA = 0xba //





XkLi

0:2fab16867d73


    44

                   //ADD_SCL = 0x5d





XkLi

0:2fab16867d73


    45

                 };





XkLi

0:2fab16867d73


    46







XkLi

0:2fab16867d73


    47

    // Real initialiser, takes the i2c address of the device.





XkLi

0:2fab16867d73


    48

    Mpr121(I2C *i2c, Address i2cAddress);





XkLi

0:2fab16867d73


    49

    





XkLi

0:2fab16867d73


    50

    bool getProximityMode();





XkLi

0:2fab16867d73


    51

    





XkLi

0:2fab16867d73


    52

    void setProximityMode(bool mode);





XkLi

0:2fab16867d73


    53

    





XkLi

0:2fab16867d73


    54

    int readTouchData();





XkLi

0:2fab16867d73


    55

               





XkLi

0:2fab16867d73


    56

    unsigned char read(int key);





XkLi

0:2fab16867d73


    57

    





XkLi

0:2fab16867d73


    58

    int write(int address, unsigned char value);





XkLi

0:2fab16867d73


    59

    int writeMany(int start, unsigned char* dataSet, int length);





XkLi

0:2fab16867d73


    60







XkLi

0:2fab16867d73


    61

    void setElectrodeThreshold(int electrodeId, unsigned char touchThreshold, unsigned char releaseThreshold);





XkLi

0:2fab16867d73


    62

        





XkLi

0:2fab16867d73


    63

protected:





XkLi

0:2fab16867d73


    64

    // Configures the MPR with standard settings. This is permitted to be overwritten by sub-classes.





XkLi

0:2fab16867d73


    65

    void configureSettings();





XkLi

0:2fab16867d73


    66

    





XkLi

0:2fab16867d73


    67

private:





XkLi

0:2fab16867d73


    68

    // The I2C bus instance.





XkLi

0:2fab16867d73


    69

    I2C *i2c;





XkLi

0:2fab16867d73


    70







XkLi

0:2fab16867d73


    71

    // i2c address of this mpr121





XkLi

0:2fab16867d73


    72

    Address address;





XkLi

0:2fab16867d73


    73

};





XkLi

0:2fab16867d73


    74







XkLi

0:2fab16867d73


    75







XkLi

0:2fab16867d73


    76

// MPR121 Register Defines





XkLi

0:2fab16867d73


    77

#define    MHD_R        0x2B





XkLi

0:2fab16867d73


    78

#define    NHD_R        0x2C





XkLi

0:2fab16867d73


    79

#define    NCL_R        0x2D





XkLi

0:2fab16867d73


    80

#define    FDL_R        0x2E





XkLi

0:2fab16867d73


    81

#define    MHD_F        0x2F





XkLi

0:2fab16867d73


    82

#define    NHD_F        0x30





XkLi

0:2fab16867d73


    83

#define    NCL_F        0x31





XkLi

0:2fab16867d73


    84

#define    FDL_F        0x32





XkLi

0:2fab16867d73


    85

#define    NHDT         0x33





XkLi

0:2fab16867d73


    86

#define    NCLT         0x34





XkLi

0:2fab16867d73


    87

#define    FDLT         0x35





XkLi

0:2fab16867d73


    88

// Proximity sensing controls





XkLi

0:2fab16867d73


    89

#define    MHDPROXR     0x36





XkLi

0:2fab16867d73


    90

#define    NHDPROXR     0x37





XkLi

0:2fab16867d73


    91

#define    NCLPROXR     0x38





XkLi

0:2fab16867d73


    92

#define    FDLPROXR     0x39





XkLi

0:2fab16867d73


    93

#define    MHDPROXF     0x3A





XkLi

0:2fab16867d73


    94

#define    NHDPROXF     0x3B





XkLi

0:2fab16867d73


    95

#define    NCLPROXF     0x3C





XkLi

0:2fab16867d73


    96

#define    FDLPROXF     0x3D





XkLi

0:2fab16867d73


    97

#define    NHDPROXT     0x3E





XkLi

0:2fab16867d73


    98

#define    NCLPROXT     0x3F





XkLi

0:2fab16867d73


    99

#define    FDLPROXT     0x40





XkLi

0:2fab16867d73


   100

// Electrode Touch/Release thresholds





XkLi

0:2fab16867d73


   101

#define    ELE0_T       0x41





XkLi

0:2fab16867d73


   102

#define    ELE0_R       0x42





XkLi

0:2fab16867d73


   103

#define    ELE1_T       0x43





XkLi

0:2fab16867d73


   104

#define    ELE1_R       0x44





XkLi

0:2fab16867d73


   105

#define    ELE2_T       0x45





XkLi

0:2fab16867d73


   106

#define    ELE2_R       0x46





XkLi

0:2fab16867d73


   107

#define    ELE3_T       0x47





XkLi

0:2fab16867d73


   108

#define    ELE3_R       0x48





XkLi

0:2fab16867d73


   109

#define    ELE4_T       0x49





XkLi

0:2fab16867d73


   110

#define    ELE4_R       0x4A





XkLi

0:2fab16867d73


   111

#define    ELE5_T       0x4B





XkLi

0:2fab16867d73


   112

#define    ELE5_R       0x4C





XkLi

0:2fab16867d73


   113

#define    ELE6_T       0x4D





XkLi

0:2fab16867d73


   114

#define    ELE6_R       0x4E





XkLi

0:2fab16867d73


   115

#define    ELE7_T       0x4F





XkLi

0:2fab16867d73


   116

#define    ELE7_R       0x50





XkLi

0:2fab16867d73


   117

#define    ELE8_T       0x51





XkLi

0:2fab16867d73


   118

#define    ELE8_R       0x52





XkLi

0:2fab16867d73


   119

#define    ELE9_T       0x53





XkLi

0:2fab16867d73


   120

#define    ELE9_R       0x54





XkLi

0:2fab16867d73


   121

#define    ELE10_T      0x55





XkLi

0:2fab16867d73


   122

#define    ELE10_R      0x56





XkLi

0:2fab16867d73


   123

#define    ELE11_T      0x57





XkLi

0:2fab16867d73


   124

#define    ELE11_R      0x58





XkLi

0:2fab16867d73


   125

// Proximity Touch/Release thresholds





XkLi

0:2fab16867d73


   126

#define    EPROXTTH     0x59





XkLi

0:2fab16867d73


   127

#define    EPROXRTH     0x5A





XkLi

0:2fab16867d73


   128

// Debounce configuration





XkLi

0:2fab16867d73


   129

#define    DEB_CFG      0x5B





XkLi

0:2fab16867d73


   130

// AFE- Analogue Front End configuration





XkLi

0:2fab16867d73


   131

#define    AFE_CFG      0x5C 





XkLi

0:2fab16867d73


   132

// Filter configuration





XkLi

0:2fab16867d73


   133

#define    FIL_CFG      0x5D





XkLi

0:2fab16867d73


   134

// Electrode configuration - transistions to "active mode"





XkLi

0:2fab16867d73


   135

#define    ELE_CFG      0x5E





XkLi

0:2fab16867d73


   136







XkLi

0:2fab16867d73


   137

#define GPIO_CTRL0      0x73





XkLi

0:2fab16867d73


   138

#define GPIO_CTRL1      0x74





XkLi

0:2fab16867d73


   139

#define GPIO_DATA       0x75





XkLi

0:2fab16867d73


   140

#define    GPIO_DIR     0x76





XkLi

0:2fab16867d73


   141

#define    GPIO_EN      0x77





XkLi

0:2fab16867d73


   142

#define    GPIO_SET     0x78





XkLi

0:2fab16867d73


   143

#define GPIO_CLEAR      0x79





XkLi

0:2fab16867d73


   144

#define GPIO_TOGGLE     0x7A





XkLi

0:2fab16867d73


   145

// Auto configration registers





XkLi

0:2fab16867d73


   146

#define    AUTO_CFG_0   0x7B





XkLi

0:2fab16867d73


   147

#define    AUTO_CFG_U   0x7D





XkLi

0:2fab16867d73


   148

#define    AUTO_CFG_L   0x7E





XkLi

0:2fab16867d73


   149

#define    AUTO_CFG_T   0x7F





XkLi

0:2fab16867d73


   150







XkLi

0:2fab16867d73


   151

// Threshold defaults





XkLi

0:2fab16867d73


   152

// Electrode touch threshold





XkLi

0:2fab16867d73


   153

#define    E_THR_T      0x2F//0x0F   





XkLi

0:2fab16867d73


   154

// Electrode release threshold 





XkLi

0:2fab16867d73


   155

#define    E_THR_R      0x12//0x0A    





XkLi

0:2fab16867d73


   156

// Prox touch threshold





XkLi

0:2fab16867d73


   157

#define    PROX_THR_T   0x02





XkLi

0:2fab16867d73


   158

// Prox release threshold





XkLi

0:2fab16867d73


   159

#define    PROX_THR_R   0x02





XkLi

0:2fab16867d73


   160







XkLi

0:2fab16867d73


   161

#endif