Isaac Khader / MPL3115A2_for_weather_shield

MPL3115A2_for_weather_shield

Dependents:   SPARKFUN_WEATHER_SHIELD

Fork of MPL3115A2 by Michael Lange

MPL3115A2.cpp@4:9ba8fde79093, 2016-10-20 (annotated)

Committer:
isaackod
Date:
Thu Oct 20 16:47:25 2016 +0000
Revision:
4:9ba8fde79093
Parent:
0:beb43bc3d6d4 
Some changes to work with the weather shield;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sophtware 0:beb43bc3d6d4 1 #include "MPL3115A2.h"
sophtware 0:beb43bc3d6d4 2 #include "mbed.h"
sophtware 0:beb43bc3d6d4 3
sophtware 0:beb43bc3d6d4 4 #include "stdarg.h" // For debugOut use of the ... parameter and va_list
sophtware 0:beb43bc3d6d4 5
sophtware 0:beb43bc3d6d4 6 MPL3115A2::MPL3115A2(I2C *i2c, Serial *pc) : _i2c(i2c), _debug(pc)
sophtware 0:beb43bc3d6d4 7 {
sophtware 0:beb43bc3d6d4 8 }
sophtware 0:beb43bc3d6d4 9
isaackod 4:9ba8fde79093 10 //Barometer mode default
sophtware 0:beb43bc3d6d4 11 void MPL3115A2::init()
sophtware 0:beb43bc3d6d4 12 {
sophtware 0:beb43bc3d6d4 13 setModeStandby();
sophtware 0:beb43bc3d6d4 14 wait_ms(1);
isaackod 4:9ba8fde79093 15 setModeBarometer();
sophtware 0:beb43bc3d6d4 16 wait_ms(1);
sophtware 0:beb43bc3d6d4 17 setOversampleRate(7);
sophtware 0:beb43bc3d6d4 18 wait_ms(1);
sophtware 0:beb43bc3d6d4 19 enableEventFlags();
sophtware 0:beb43bc3d6d4 20 wait_ms(1);
sophtware 0:beb43bc3d6d4 21 setModeActive();
sophtware 0:beb43bc3d6d4 22 wait_ms(1);
sophtware 0:beb43bc3d6d4 23 }
sophtware 0:beb43bc3d6d4 24
sophtware 0:beb43bc3d6d4 25 // This method wait for a specified amount of time for one of the data
sophtware 0:beb43bc3d6d4 26 // ready flags to be set. You need to pass in the correct data ready
sophtware 0:beb43bc3d6d4 27 // mask for this to work. See page 22 of the datasheet.
sophtware 0:beb43bc3d6d4 28 int MPL3115A2::dataReady(const char mask)
sophtware 0:beb43bc3d6d4 29 {
sophtware 0:beb43bc3d6d4 30 int attempts = 0;
sophtware 0:beb43bc3d6d4 31
sophtware 0:beb43bc3d6d4 32 while ((i2cRead(STATUS) & mask) == 0)
sophtware 0:beb43bc3d6d4 33 {
sophtware 0:beb43bc3d6d4 34 attempts++;
sophtware 0:beb43bc3d6d4 35
sophtware 0:beb43bc3d6d4 36 if(attempts > MAX_DATA_READY_ATTEMPTS)
sophtware 0:beb43bc3d6d4 37 return 0; // Failed
sophtware 0:beb43bc3d6d4 38
sophtware 0:beb43bc3d6d4 39 wait_ms(1);
sophtware 0:beb43bc3d6d4 40 }
sophtware 0:beb43bc3d6d4 41
sophtware 0:beb43bc3d6d4 42 return 1; // Success
sophtware 0:beb43bc3d6d4 43 }
sophtware 0:beb43bc3d6d4 44
sophtware 0:beb43bc3d6d4 45 Altitude* MPL3115A2::readAltitude(Altitude* a)
sophtware 0:beb43bc3d6d4 46 {
sophtware 0:beb43bc3d6d4 47 // Force the sensor to take a new reading.
sophtware 0:beb43bc3d6d4 48 toggleOneShot();
sophtware 0:beb43bc3d6d4 49
sophtware 0:beb43bc3d6d4 50 // Wait for the data to be ready.
sophtware 0:beb43bc3d6d4 51 if (!pressureDataReady())
sophtware 0:beb43bc3d6d4 52 {
sophtware 0:beb43bc3d6d4 53 debugOut("MPL3115A2::readAltitude: Sensor failed to generate an altitude reading in a reasonable time.\r\n");
sophtware 0:beb43bc3d6d4 54
sophtware 0:beb43bc3d6d4 55 // We leave the altitude object as is if we encounter an error.
sophtware 0:beb43bc3d6d4 56 return a;
sophtware 0:beb43bc3d6d4 57 }
sophtware 0:beb43bc3d6d4 58
sophtware 0:beb43bc3d6d4 59 // Get the new data from the sensor.
sophtware 0:beb43bc3d6d4 60 _i2c->start(); // Start
sophtware 0:beb43bc3d6d4 61 if (_i2c->write(MPL3115A2_ADDRESS) != 1) // A write to device
sophtware 0:beb43bc3d6d4 62 debugOut("MPL3115A2::readAltitude: Sensor failed to respond to write request at address 0x%X\r\n", MPL3115A2_ADDRESS);
sophtware 0:beb43bc3d6d4 63
sophtware 0:beb43bc3d6d4 64 if (_i2c->write(OUT_P_MSB) != 1) // Register to read
sophtware 0:beb43bc3d6d4 65 debugOut("MPL3115A2::readAltitude: Sensor at address 0x%X did not acknowledge register 0x%X\r\n", MPL3115A2_ADDRESS, OUT_P_MSB);
sophtware 0:beb43bc3d6d4 66
sophtware 0:beb43bc3d6d4 67 // Write the data directly into our Altitude object. This object
sophtware 0:beb43bc3d6d4 68 // takes care of converting the compressed data from the sensor, and
sophtware 0:beb43bc3d6d4 69 // provides functions to get the data in various units. And it also
sophtware 0:beb43bc3d6d4 70 // has a print function to output the data as a string.
sophtware 0:beb43bc3d6d4 71 _i2c->read(MPL3115A2_ADDRESS, (*a), Altitude::size);
sophtware 0:beb43bc3d6d4 72 a->setAltitude();
sophtware 0:beb43bc3d6d4 73
sophtware 0:beb43bc3d6d4 74 return a;
sophtware 0:beb43bc3d6d4 75 }
sophtware 0:beb43bc3d6d4 76
sophtware 0:beb43bc3d6d4 77 // See readAltitude for comments about this function.
sophtware 0:beb43bc3d6d4 78 Pressure* MPL3115A2::readPressure(Pressure* p)
sophtware 0:beb43bc3d6d4 79 {
sophtware 0:beb43bc3d6d4 80 toggleOneShot();
sophtware 0:beb43bc3d6d4 81
sophtware 0:beb43bc3d6d4 82 if (!pressureDataReady())
sophtware 0:beb43bc3d6d4 83 {
sophtware 0:beb43bc3d6d4 84 debugOut("MPL3115A2::readPressure: Sensor failed to generate a pressure reading in a reasonable time.\r\n");
sophtware 0:beb43bc3d6d4 85 return p;
sophtware 0:beb43bc3d6d4 86 }
sophtware 0:beb43bc3d6d4 87
sophtware 0:beb43bc3d6d4 88 _i2c->start();
sophtware 0:beb43bc3d6d4 89 if (_i2c->write(MPL3115A2_ADDRESS) != 1)
sophtware 0:beb43bc3d6d4 90 debugOut("MPL3115A2::readPressure: Sensor failed to respond to write request at address 0x%X\r\n", MPL3115A2_ADDRESS);
sophtware 0:beb43bc3d6d4 91
sophtware 0:beb43bc3d6d4 92 if (_i2c->write(OUT_P_MSB) != 1)
sophtware 0:beb43bc3d6d4 93 debugOut("MPL3115A2::readPressure: Sensor at address 0x%X did not acknowledge register 0x%X\r\n", MPL3115A2_ADDRESS, OUT_P_MSB);
sophtware 0:beb43bc3d6d4 94
sophtware 0:beb43bc3d6d4 95 _i2c->read(MPL3115A2_ADDRESS, (*p), Pressure::size);
sophtware 0:beb43bc3d6d4 96 p->setPressure();
sophtware 0:beb43bc3d6d4 97
sophtware 0:beb43bc3d6d4 98 return p;
sophtware 0:beb43bc3d6d4 99 }
sophtware 0:beb43bc3d6d4 100
sophtware 0:beb43bc3d6d4 101 // See readAltitude for comments about this function.
sophtware 0:beb43bc3d6d4 102 Temperature* MPL3115A2::readTemperature(Temperature* t)
sophtware 0:beb43bc3d6d4 103 {
sophtware 0:beb43bc3d6d4 104 toggleOneShot();
sophtware 0:beb43bc3d6d4 105
sophtware 0:beb43bc3d6d4 106 if (!temperatureDataReady())
sophtware 0:beb43bc3d6d4 107 {
sophtware 0:beb43bc3d6d4 108 debugOut("MPL3115A2::readTemperature: Sensor failed to generate a temperature reading in a reasonable time.\r\n");
sophtware 0:beb43bc3d6d4 109 return t;
sophtware 0:beb43bc3d6d4 110 }
sophtware 0:beb43bc3d6d4 111
sophtware 0:beb43bc3d6d4 112 _i2c->start();
sophtware 0:beb43bc3d6d4 113 if (_i2c->write(MPL3115A2_ADDRESS) != 1)
sophtware 0:beb43bc3d6d4 114 debugOut("MPL3115A2::readTemperature: Sensor failed to respond to write request at address 0x%X\r\n", MPL3115A2_ADDRESS);
sophtware 0:beb43bc3d6d4 115
sophtware 0:beb43bc3d6d4 116 if (_i2c->write(OUT_T_MSB) != 1)
sophtware 0:beb43bc3d6d4 117 debugOut("MPL3115A2::readTemperature: Sensor at address 0x%X did not acknowledge register 0x%X\r\n", MPL3115A2_ADDRESS, OUT_P_MSB);
sophtware 0:beb43bc3d6d4 118
sophtware 0:beb43bc3d6d4 119 _i2c->read(MPL3115A2_ADDRESS, (*t), Temperature::size);
sophtware 0:beb43bc3d6d4 120 t->setTemperature();
sophtware 0:beb43bc3d6d4 121
sophtware 0:beb43bc3d6d4 122 return t;
sophtware 0:beb43bc3d6d4 123 }
sophtware 0:beb43bc3d6d4 124
sophtware 0:beb43bc3d6d4 125 void MPL3115A2::setModeAltimeter()
sophtware 0:beb43bc3d6d4 126 {
sophtware 0:beb43bc3d6d4 127 setRegisterBit(CTRL_REG1, 0x80); // Set ALT bit
sophtware 0:beb43bc3d6d4 128 }
sophtware 0:beb43bc3d6d4 129
sophtware 0:beb43bc3d6d4 130 void MPL3115A2::setModeBarometer()
sophtware 0:beb43bc3d6d4 131 {
sophtware 0:beb43bc3d6d4 132 clearRegisterBit(CTRL_REG1, 0x80); // Clear ALT bit
sophtware 0:beb43bc3d6d4 133 }
sophtware 0:beb43bc3d6d4 134
sophtware 0:beb43bc3d6d4 135 void MPL3115A2::setModeStandby()
sophtware 0:beb43bc3d6d4 136 {
sophtware 0:beb43bc3d6d4 137 clearRegisterBit(CTRL_REG1, 0x01); // Clear SBYB bit for Standby mode
sophtware 0:beb43bc3d6d4 138 }
sophtware 0:beb43bc3d6d4 139 void MPL3115A2::setModeActive()
sophtware 0:beb43bc3d6d4 140 {
sophtware 0:beb43bc3d6d4 141 setRegisterBit(CTRL_REG1, 0x01); // Set SBYB bit for Active mode
sophtware 0:beb43bc3d6d4 142 }
sophtware 0:beb43bc3d6d4 143
sophtware 0:beb43bc3d6d4 144 void MPL3115A2::setOversampleRate(char sampleRate)
sophtware 0:beb43bc3d6d4 145 {
sophtware 0:beb43bc3d6d4 146 if(sampleRate > 7)
sophtware 0:beb43bc3d6d4 147 sampleRate = 7; // OS cannot be larger than 0b.0111
sophtware 0:beb43bc3d6d4 148
sophtware 0:beb43bc3d6d4 149 sampleRate <<= 3; // Align it for the CTRL_REG1 register
sophtware 0:beb43bc3d6d4 150
sophtware 0:beb43bc3d6d4 151 char temp = i2cRead(CTRL_REG1); // Read current settings
sophtware 0:beb43bc3d6d4 152 temp &= 0xC7; // Clear out old OS bits
sophtware 0:beb43bc3d6d4 153 temp |= sampleRate; // Mask in new OS bits
sophtware 0:beb43bc3d6d4 154 i2cWrite(CTRL_REG1, temp);
sophtware 0:beb43bc3d6d4 155 }
sophtware 0:beb43bc3d6d4 156
sophtware 0:beb43bc3d6d4 157 void MPL3115A2::enableEventFlags()
sophtware 0:beb43bc3d6d4 158 {
sophtware 0:beb43bc3d6d4 159 i2cWrite(PT_DATA_CFG, 0x07); // Enable all three pressure and temp event flags
sophtware 0:beb43bc3d6d4 160 }
sophtware 0:beb43bc3d6d4 161
sophtware 0:beb43bc3d6d4 162 void MPL3115A2::toggleOneShot(void)
sophtware 0:beb43bc3d6d4 163 {
sophtware 0:beb43bc3d6d4 164 clearRegisterBit(CTRL_REG1, 0x02); // Clear OST bit
sophtware 0:beb43bc3d6d4 165 setRegisterBit(CTRL_REG1, 0x02); // Set the OST bit.
sophtware 0:beb43bc3d6d4 166 }
sophtware 0:beb43bc3d6d4 167
sophtware 0:beb43bc3d6d4 168 void MPL3115A2::clearRegisterBit(const char regAddr, const char bitMask)
sophtware 0:beb43bc3d6d4 169 {
sophtware 0:beb43bc3d6d4 170 char temp = i2cRead(regAddr); // Read the current register value
sophtware 0:beb43bc3d6d4 171 temp &= ~bitMask; // Clear the bit from the value
sophtware 0:beb43bc3d6d4 172 i2cWrite(regAddr, temp); // Write register value back
sophtware 0:beb43bc3d6d4 173 }
sophtware 0:beb43bc3d6d4 174
sophtware 0:beb43bc3d6d4 175 void MPL3115A2::setRegisterBit(const char regAddr, const char bitMask)
sophtware 0:beb43bc3d6d4 176 {
sophtware 0:beb43bc3d6d4 177 char temp = i2cRead(regAddr); // Read the current register value
sophtware 0:beb43bc3d6d4 178 temp |= bitMask; // Set the bit in the value
sophtware 0:beb43bc3d6d4 179 i2cWrite(regAddr, temp); // Write register value back
sophtware 0:beb43bc3d6d4 180 }
sophtware 0:beb43bc3d6d4 181
sophtware 0:beb43bc3d6d4 182 char MPL3115A2::i2cRead(char regAddr)
sophtware 0:beb43bc3d6d4 183 {
sophtware 0:beb43bc3d6d4 184 _i2c->start(); // Start
sophtware 0:beb43bc3d6d4 185 if (_i2c->write(MPL3115A2_ADDRESS)!=1) // A write to device
sophtware 0:beb43bc3d6d4 186 debugOut("MPL3115A2::i2cRead: Sensor failed to respond to write request at address 0x%X\r\n", MPL3115A2_ADDRESS);
sophtware 0:beb43bc3d6d4 187
sophtware 0:beb43bc3d6d4 188 if (_i2c->write(regAddr)!=1) // Register to read
sophtware 0:beb43bc3d6d4 189 debugOut("MPL3115A2::i2cRead: Sensor at address 0x%X did not acknowledge register 0x%X\r\n", MPL3115A2_ADDRESS, regAddr);
sophtware 0:beb43bc3d6d4 190
sophtware 0:beb43bc3d6d4 191 _i2c->start();
sophtware 0:beb43bc3d6d4 192 if (_i2c->write(MPL3115A2_ADDRESS|0x01)!=1) // Read from device
sophtware 0:beb43bc3d6d4 193 debugOut("MPL3115A2::i2cRead: Sensor failed to respond to read request at address 0x%X\r\n", MPL3115A2_ADDRESS);
sophtware 0:beb43bc3d6d4 194
sophtware 0:beb43bc3d6d4 195 char result = _i2c->read(READ_NAK); // Read the data
sophtware 0:beb43bc3d6d4 196 _i2c->stop();
sophtware 0:beb43bc3d6d4 197
sophtware 0:beb43bc3d6d4 198 return result;
sophtware 0:beb43bc3d6d4 199 }
sophtware 0:beb43bc3d6d4 200
sophtware 0:beb43bc3d6d4 201 void MPL3115A2::i2cWrite(char regAddr, char value)
sophtware 0:beb43bc3d6d4 202 {
sophtware 0:beb43bc3d6d4 203 char cmd[2];
sophtware 0:beb43bc3d6d4 204 cmd[0] = regAddr;
sophtware 0:beb43bc3d6d4 205 cmd[1] = value;
sophtware 0:beb43bc3d6d4 206 if (_i2c->write(MPL3115A2_ADDRESS, cmd, 2) != 0)
sophtware 0:beb43bc3d6d4 207 debugOut("MPL3115A2::i2cWrite: Failed writing value (%d, 0x%X) to register 0x%X\r\n", value, regAddr);
sophtware 0:beb43bc3d6d4 208 }
sophtware 0:beb43bc3d6d4 209
sophtware 0:beb43bc3d6d4 210 void MPL3115A2::debugOut(const char * format, ...)
sophtware 0:beb43bc3d6d4 211 {
sophtware 0:beb43bc3d6d4 212 if (_debug == NULL)
sophtware 0:beb43bc3d6d4 213 return;
sophtware 0:beb43bc3d6d4 214
sophtware 0:beb43bc3d6d4 215 va_list arg;
sophtware 0:beb43bc3d6d4 216 _debug->printf(format, arg);
sophtware 0:beb43bc3d6d4 217 }