accelerometer
Dependents: embedded_answ_2 embedded_answ_2_
Diff: MMA7660.h
- Revision:
- 2:a8e20db7901e
- Parent:
- 1:8997a1b348dd
--- a/MMA7660.h Tue Oct 16 19:42:19 2012 +0000 +++ b/MMA7660.h Wed Oct 17 16:38:05 2012 +0000 @@ -1,3 +1,21 @@ +/* Copyright (c) <year> <copyright holders>, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + #include "mbed.h" @@ -16,30 +34,57 @@ #define MMA7660_SR_R 0x08 +/** An interface for the MMA7660 triple axis accelerometer + * + * @code + * //Uses the measured z-acceleration to drive leds 2 and 3 of the mbed + * + * #include "mbed.h" + * #include "MMA7660.h" + * + * MMA7660 MMA(p28, p27); + * + * DigitalOut connectionLed(LED1); + * PwmOut Zaxis_p(LED2); + * PwmOut Zaxis_n(LED3); + * + * int main() { + * if (MMA.testConnection()) + * connectionLed = 1; + * + * while(1) { + * Zaxis_p = MMA.z(); + * Zaxis_n = -MMA.z(); + * } + * + * } + * @endcode + */ class MMA7660 { public: - /** + /** * The 6 different orientations and unknown * * Up & Down = X-axis * Right & Left = Y-axis * Back & Front = Z-axis - * + * */ - enum Orientation{Up, Down, - Right, Left, - Back, Front, - Unknown}; - + enum Orientation {Up, Down, + Right, Left, + Back, Front, + Unknown + }; + /** * Creates a new MMA7660 object * * @param sda - I2C data pin * @param scl - I2C clock pin - * @param interrupt - Interrupt pin (default = NC) + * @param active - true (default) to enable the device, false to keep it standby */ - MMA7660(PinName sda, PinName scl, PinName interrupt = NC); + MMA7660(PinName sda, PinName scl, bool active = true); /** * Tests if communication is possible with the MMA7660 @@ -50,7 +95,7 @@ * @param return - true for successfull connection, false for no connection */ bool testConnection( void ); - + /** * Sets the active state of the MMA7660 * @@ -59,40 +104,40 @@ * @param state - true for active, false for standby */ void setActive( bool state); - + /** * Reads acceleration data from the sensor * - * When the parameter is a pointer to an integer array it will be the raw data. + * When the parameter is a pointer to an integer array it will be the raw data. * When it is a pointer to a float array it will be the acceleration in g's - * - * @param data - pointer to array with length 3 where the acceleration data will be stores, X-Y-Z + * + * @param data - pointer to array with length 3 where the acceleration data will be stored, X-Y-Z */ void readData( int *data); void readData( float *data); - - /** + + /** * Get X-data * * @param return - X-acceleration in g's */ - float getX( void ); - - /** + float x( void ); + + /** * Get Y-data * * @param return - Y-acceleration in g's */ - float getY( void ); - - /** + float y( void ); + + /** * Get Z-data * * @param return - Z-acceleration in g's */ - float getZ( void ); - - /** + float z( void ); + + /** * Sets the active samplerate * * The entered samplerate will be rounded to nearest supported samplerate. @@ -100,16 +145,9 @@ * * @param samplerate - the samplerate that will be set */ - void setSampleRate(int samplerate); + void setSampleRate(int samplerate); /** - * Returns which side is pointing down - * - * @param return - Orientation which is closest to down - */ - Orientation getGlobalOrientation( void ); - - /** * Returns if it is on its front, back, or unknown side * * This is read from MMA7760s registers, page 12 of datasheet @@ -117,7 +155,7 @@ * @param return - Front, Back or Unknown orientation */ Orientation getSide( void ); - + /** * Returns if it is on it left, right, down or up side * @@ -126,14 +164,6 @@ * @param return - Left, Right, Down, Up or Unknown orientation */ Orientation getOrientation ( void ); - - /** - * Returns if since last check there has been a tap - * - * @param return - bool that is true when a tap has been detected - */ - bool isTapped( void ); - private: @@ -153,24 +183,23 @@ * @return - data from the register specified by RA */ char read( char adress); - + /** - * Read multiple regigsters from the device, more efficient than using multiple normal reads. + * Read multiple regigsters from the device, more efficient than using multiple normal reads. * * @param adress - register address to write to * @param length - number of bytes to read - * @param data - pointer where the data needs to be written to + * @param data - pointer where the data needs to be written to */ - void read( char adress, char *data, int length); - - /** - * Reads single axis - */ - float getSingle(int number); + void read( char adress, char *data, int length); + + /** + * Reads single axis + */ + float getSingle(int number); I2C _i2c; bool active; - PinName _interrupt; float samplerate; };