Rohm / KX022

KX022 Accelerometer library

Dependents:   LazuriteGraph_Hello KX022_Hello GR-PEACH_IoT_Platform_HTTP_sample

KX022.h@0:e642dd732c4b, 2015-12-30 (annotated)

Committer:
MACRUM
Date:
Wed Dec 30 16:16:32 2015 +0000
Revision:
0:e642dd732c4b
Child:
1:23bfc18affd9
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MACRUM 0:e642dd732c4b 1 /* Copyright (c) 2015 ARM Ltd., MIT License
MACRUM 0:e642dd732c4b 2 *
MACRUM 0:e642dd732c4b 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
MACRUM 0:e642dd732c4b 4 * and associated documentation files (the "Software"), to deal in the Software without
MACRUM 0:e642dd732c4b 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
MACRUM 0:e642dd732c4b 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
MACRUM 0:e642dd732c4b 7 * Software is furnished to do so, subject to the following conditions:
MACRUM 0:e642dd732c4b 8 *
MACRUM 0:e642dd732c4b 9 * The above copyright notice and this permission notice shall be included in all copies or
MACRUM 0:e642dd732c4b 10 * substantial portions of the Software.
MACRUM 0:e642dd732c4b 11 *
MACRUM 0:e642dd732c4b 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
MACRUM 0:e642dd732c4b 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
MACRUM 0:e642dd732c4b 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
MACRUM 0:e642dd732c4b 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
MACRUM 0:e642dd732c4b 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
MACRUM 0:e642dd732c4b 17 *
MACRUM 0:e642dd732c4b 18 *
MACRUM 0:e642dd732c4b 19 * KX022 Accelerometer library
MACRUM 0:e642dd732c4b 20 *
MACRUM 0:e642dd732c4b 21 * @author Toyomasa Watarai
MACRUM 0:e642dd732c4b 22 * @version 1.0
MACRUM 0:e642dd732c4b 23 * @date 30-December-2015
MACRUM 0:e642dd732c4b 24 *
MACRUM 0:e642dd732c4b 25 * Library for "KX022 Accelerometer library" from Kionix a Rohm group
MACRUM 0:e642dd732c4b 26 * http://www.kionix.com/product/KX022-1020
MACRUM 0:e642dd732c4b 27 *
MACRUM 0:e642dd732c4b 28 */
MACRUM 0:e642dd732c4b 29
MACRUM 0:e642dd732c4b 30 #ifndef KX022_H
MACRUM 0:e642dd732c4b 31 #define KX022_H
MACRUM 0:e642dd732c4b 32
MACRUM 0:e642dd732c4b 33 #include "mbed.h"
MACRUM 0:e642dd732c4b 34
MACRUM 0:e642dd732c4b 35 #define DEFAULT_SLAVE_ADDRESS (0x1E << 1)
MACRUM 0:e642dd732c4b 36 #define KX022_WAI_VAL (0x14)
MACRUM 0:e642dd732c4b 37
MACRUM 0:e642dd732c4b 38 #define KX022_XOUT_L (0x06)
MACRUM 0:e642dd732c4b 39 #define KX022_XOUT_H (0x07)
MACRUM 0:e642dd732c4b 40 #define KX022_YOUT_L (0x08)
MACRUM 0:e642dd732c4b 41 #define KX022_YOUT_H (0x09)
MACRUM 0:e642dd732c4b 42 #define KX022_ZOUT_L (0x0A)
MACRUM 0:e642dd732c4b 43 #define KX022_ZOUT_H (0x0B)
MACRUM 0:e642dd732c4b 44 #define KX022_WHO_AM_I (0x0F)
MACRUM 0:e642dd732c4b 45 #define KX022_CNTL1 (0x18)
MACRUM 0:e642dd732c4b 46 #define KX022_CNTL3 (0x1A)
MACRUM 0:e642dd732c4b 47 #define KX022_ODCNTL (0x1B)
MACRUM 0:e642dd732c4b 48 #define KX022_TILT_TIMER (0x22)
MACRUM 0:e642dd732c4b 49
MACRUM 0:e642dd732c4b 50 #ifdef _DEBUG
MACRUM 0:e642dd732c4b 51 extern Serial pc;
MACRUM 0:e642dd732c4b 52 #define DEBUG_PRINT(...) pc.printf(__VA_ARGS__)
MACRUM 0:e642dd732c4b 53 #else
MACRUM 0:e642dd732c4b 54 #define DEBUG_PRINT(...)
MACRUM 0:e642dd732c4b 55 #endif
MACRUM 0:e642dd732c4b 56
MACRUM 0:e642dd732c4b 57 /**
MACRUM 0:e642dd732c4b 58 * KX022 accelerometer example
MACRUM 0:e642dd732c4b 59 *
MACRUM 0:e642dd732c4b 60 * @code
MACRUM 0:e642dd732c4b 61 * #include "mbed.h"
MACRUM 0:e642dd732c4b 62 * #include "KX022.h"
MACRUM 0:e642dd732c4b 63 *
MACRUM 0:e642dd732c4b 64 * int main(void) {
MACRUM 0:e642dd732c4b 65 *
MACRUM 0:e642dd732c4b 66 * KX022 acc(I2C_SDA, I2C_SCL);
MACRUM 0:e642dd732c4b 67 * PwmOut rled(LED_RED);
MACRUM 0:e642dd732c4b 68 * PwmOut gled(LED_GREEN);
MACRUM 0:e642dd732c4b 69 * PwmOut bled(LED_BLUE);
MACRUM 0:e642dd732c4b 70 *
MACRUM 0:e642dd732c4b 71 * while (true) {
MACRUM 0:e642dd732c4b 72 * rled = 1.0 - abs(acc.getAccX());
MACRUM 0:e642dd732c4b 73 * gled = 1.0 - abs(acc.getAccY());
MACRUM 0:e642dd732c4b 74 * bled = 1.0 - abs(acc.getAccZ());
MACRUM 0:e642dd732c4b 75 * wait(0.1);
MACRUM 0:e642dd732c4b 76 * }
MACRUM 0:e642dd732c4b 77 * }
MACRUM 0:e642dd732c4b 78 * @endcode
MACRUM 0:e642dd732c4b 79 */
MACRUM 0:e642dd732c4b 80 class KX022
MACRUM 0:e642dd732c4b 81 {
MACRUM 0:e642dd732c4b 82 public:
MACRUM 0:e642dd732c4b 83 /**
MACRUM 0:e642dd732c4b 84 * KX022 constructor
MACRUM 0:e642dd732c4b 85 *
MACRUM 0:e642dd732c4b 86 * @param sda SDA pin
MACRUM 0:e642dd732c4b 87 * @param sdl SCL pin
MACRUM 0:e642dd732c4b 88 * @param addr slave address of the I2C peripheral (default: 0x3C)
MACRUM 0:e642dd732c4b 89 */
MACRUM 0:e642dd732c4b 90 KX022(PinName sda, PinName scl, int addr = DEFAULT_SLAVE_ADDRESS);
MACRUM 0:e642dd732c4b 91
MACRUM 0:e642dd732c4b 92 /**
MACRUM 0:e642dd732c4b 93 * Create a KX022 instance which is connected to specified I2C pins
MACRUM 0:e642dd732c4b 94 * with specified address
MACRUM 0:e642dd732c4b 95 *
MACRUM 0:e642dd732c4b 96 * @param i2c_obj I2C object (instance)
MACRUM 0:e642dd732c4b 97 * @param addr slave address of the I2C-bus peripheral (default: 0x3C)
MACRUM 0:e642dd732c4b 98 */
MACRUM 0:e642dd732c4b 99 KX022(I2C &i2c_obj, int addr = DEFAULT_SLAVE_ADDRESS);
MACRUM 0:e642dd732c4b 100
MACRUM 0:e642dd732c4b 101 /**
MACRUM 0:e642dd732c4b 102 * KX022 destructor
MACRUM 0:e642dd732c4b 103 */
MACRUM 0:e642dd732c4b 104 ~KX022();
MACRUM 0:e642dd732c4b 105
MACRUM 0:e642dd732c4b 106 /** Initializa KX022 sensor
MACRUM 0:e642dd732c4b 107 *
MACRUM 0:e642dd732c4b 108 * Configure sensor setting
MACRUM 0:e642dd732c4b 109 *
MACRUM 0:e642dd732c4b 110 */
MACRUM 0:e642dd732c4b 111 void initialize(void);
MACRUM 0:e642dd732c4b 112
MACRUM 0:e642dd732c4b 113 /**
MACRUM 0:e642dd732c4b 114 * Get X axis acceleration
MACRUM 0:e642dd732c4b 115 *
MACRUM 0:e642dd732c4b 116 * @returns X axis acceleration
MACRUM 0:e642dd732c4b 117 */
MACRUM 0:e642dd732c4b 118 float getAccX();
MACRUM 0:e642dd732c4b 119
MACRUM 0:e642dd732c4b 120 /**
MACRUM 0:e642dd732c4b 121 * Get Y axis acceleration
MACRUM 0:e642dd732c4b 122 *
MACRUM 0:e642dd732c4b 123 * @returns Y axis acceleration
MACRUM 0:e642dd732c4b 124 */
MACRUM 0:e642dd732c4b 125 float getAccY();
MACRUM 0:e642dd732c4b 126
MACRUM 0:e642dd732c4b 127 /**
MACRUM 0:e642dd732c4b 128 * Get Z axis acceleration
MACRUM 0:e642dd732c4b 129 *
MACRUM 0:e642dd732c4b 130 * @returns Z axis acceleration
MACRUM 0:e642dd732c4b 131 */
MACRUM 0:e642dd732c4b 132 float getAccZ();
MACRUM 0:e642dd732c4b 133
MACRUM 0:e642dd732c4b 134 /**
MACRUM 0:e642dd732c4b 135 * Get XYZ axis acceleration
MACRUM 0:e642dd732c4b 136 *
MACRUM 0:e642dd732c4b 137 * @param res array where acceleration data will be stored
MACRUM 0:e642dd732c4b 138 */
MACRUM 0:e642dd732c4b 139 void getAccAllAxis(float * res);
MACRUM 0:e642dd732c4b 140
MACRUM 0:e642dd732c4b 141 private:
MACRUM 0:e642dd732c4b 142 I2C m_i2c;
MACRUM 0:e642dd732c4b 143 int m_addr;
MACRUM 0:e642dd732c4b 144 void readRegs(int addr, uint8_t * data, int len);
MACRUM 0:e642dd732c4b 145 void writeRegs(uint8_t * data, int len);
MACRUM 0:e642dd732c4b 146 int16_t getAccAxis(uint8_t addr);
MACRUM 0:e642dd732c4b 147
MACRUM 0:e642dd732c4b 148 };
MACRUM 0:e642dd732c4b 149
MACRUM 0:e642dd732c4b 150 #endif