Danny Eldering / Mbed 2 deprecated KXTJ3

KX022 Accelerometer library

Dependencies:   mbed

Dependents:   SP_BEUNBOX_code

Fork of KX022 by Rohm

KXTJ3.h@5:9519f53d9965, 2019-02-05 (annotated)

Committer:
deldering95
Date:
Tue Feb 05 15:23:38 2019 +0000
Revision:
5:9519f53d9965
Parent:
4:4038b02c530d 
Changed Initialization code to check whether it is needed to initialize

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 *
deldering95 4:4038b02c530d 19 * KXTJ3 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 *
deldering95 4:4038b02c530d 25 * Library for "KXTJ3 Accelerometer library" from Kionix a Rohm group
deldering95 4:4038b02c530d 26 * http://www.kionix.com/product/KXTJ3-1020
MACRUM 0:e642dd732c4b 27 *
MACRUM 0:e642dd732c4b 28 */
MACRUM 0:e642dd732c4b 29
deldering95 4:4038b02c530d 30 #ifndef KXTJ3_H
deldering95 4:4038b02c530d 31 #define KXTJ3_H
MACRUM 0:e642dd732c4b 32
MACRUM 0:e642dd732c4b 33 #include "mbed.h"
MACRUM 0:e642dd732c4b 34
deldering95 4:4038b02c530d 35 #define KXTJ3_DEFAULT_SLAVE_ADDRESS (0x0f << 1)
deldering95 4:4038b02c530d 36 #define KXTJ3_WAI_VAL (0x35)
MACRUM 0:e642dd732c4b 37
deldering95 4:4038b02c530d 38 #define KXTJ3_XOUT_L (0x06)
deldering95 4:4038b02c530d 39 #define KXTJ3_XOUT_H (0x07)
deldering95 4:4038b02c530d 40 #define KXTJ3_YOUT_L (0x08)
deldering95 4:4038b02c530d 41 #define KXTJ3_YOUT_H (0x09)
deldering95 4:4038b02c530d 42 #define KXTJ3_ZOUT_L (0x0A)
deldering95 4:4038b02c530d 43 #define KXTJ3_ZOUT_H (0x0B)
deldering95 4:4038b02c530d 44 #define KXTJ3_WHO_AM_I (0x0F)
deldering95 4:4038b02c530d 45 #define KXTJ3_CNTL1 (0x1B)
deldering95 4:4038b02c530d 46 #define KXTJ3_CNTL3 (0x1A)
deldering95 4:4038b02c530d 47 #define KXTJ3_ODCNTL (0x21)
deldering95 4:4038b02c530d 48 #define KXTJ3_TILT_TIMER (0x22)
MACRUM 0:e642dd732c4b 49
MikkoZ 3:e2d1659fe67e 50 #define _DEBUG
MACRUM 0:e642dd732c4b 51 #ifdef _DEBUG
MACRUM 0:e642dd732c4b 52 extern Serial pc;
MACRUM 0:e642dd732c4b 53 #define DEBUG_PRINT(...) pc.printf(__VA_ARGS__)
MACRUM 0:e642dd732c4b 54 #else
MACRUM 0:e642dd732c4b 55 #define DEBUG_PRINT(...)
MACRUM 0:e642dd732c4b 56 #endif
MACRUM 0:e642dd732c4b 57
MACRUM 0:e642dd732c4b 58 /**
deldering95 4:4038b02c530d 59 * KXTJ3 accelerometer example
MACRUM 0:e642dd732c4b 60 *
MACRUM 0:e642dd732c4b 61 * @code
MACRUM 0:e642dd732c4b 62 * #include "mbed.h"
deldering95 4:4038b02c530d 63 * #include "KXTJ3.h"
MACRUM 0:e642dd732c4b 64 *
MACRUM 0:e642dd732c4b 65 * int main(void) {
MACRUM 0:e642dd732c4b 66 *
deldering95 4:4038b02c530d 67 * KXTJ3 acc(I2C_SDA, I2C_SCL);
MACRUM 0:e642dd732c4b 68 * PwmOut rled(LED_RED);
MACRUM 0:e642dd732c4b 69 * PwmOut gled(LED_GREEN);
MACRUM 0:e642dd732c4b 70 * PwmOut bled(LED_BLUE);
MACRUM 0:e642dd732c4b 71 *
MACRUM 0:e642dd732c4b 72 * while (true) {
MACRUM 0:e642dd732c4b 73 * rled = 1.0 - abs(acc.getAccX());
MACRUM 0:e642dd732c4b 74 * gled = 1.0 - abs(acc.getAccY());
MACRUM 0:e642dd732c4b 75 * bled = 1.0 - abs(acc.getAccZ());
MACRUM 0:e642dd732c4b 76 * wait(0.1);
MACRUM 0:e642dd732c4b 77 * }
MACRUM 0:e642dd732c4b 78 * }
MACRUM 0:e642dd732c4b 79 * @endcode
MACRUM 0:e642dd732c4b 80 */
deldering95 4:4038b02c530d 81 class KXTJ3
MACRUM 0:e642dd732c4b 82 {
MACRUM 0:e642dd732c4b 83 public:
MACRUM 0:e642dd732c4b 84 /**
deldering95 4:4038b02c530d 85 * KXTJ3 constructor
MACRUM 0:e642dd732c4b 86 *
MACRUM 0:e642dd732c4b 87 * @param sda SDA pin
MACRUM 0:e642dd732c4b 88 * @param sdl SCL pin
MACRUM 0:e642dd732c4b 89 * @param addr slave address of the I2C peripheral (default: 0x3C)
MACRUM 0:e642dd732c4b 90 */
deldering95 4:4038b02c530d 91 // KXTJ3(PinName sda, PinName scl, int addr = KXTJ3_DEFAULT_SLAVE_ADDRESS);
MACRUM 0:e642dd732c4b 92
MACRUM 0:e642dd732c4b 93 /**
deldering95 4:4038b02c530d 94 * Create a KXTJ3 instance which is connected to specified I2C pins
MACRUM 0:e642dd732c4b 95 * with specified address
MACRUM 0:e642dd732c4b 96 *
MACRUM 0:e642dd732c4b 97 * @param i2c_obj I2C object (instance)
MACRUM 0:e642dd732c4b 98 * @param addr slave address of the I2C-bus peripheral (default: 0x3C)
MACRUM 0:e642dd732c4b 99 */
deldering95 4:4038b02c530d 100 KXTJ3(I2C* i2c_obj, int addr = KXTJ3_DEFAULT_SLAVE_ADDRESS);
MACRUM 0:e642dd732c4b 101
MACRUM 0:e642dd732c4b 102 /**
deldering95 4:4038b02c530d 103 * KXTJ3 destructor
MACRUM 0:e642dd732c4b 104 */
deldering95 4:4038b02c530d 105 ~KXTJ3();
MACRUM 0:e642dd732c4b 106
deldering95 4:4038b02c530d 107 /** Initializa KXTJ3 sensor
MACRUM 0:e642dd732c4b 108 *
MACRUM 0:e642dd732c4b 109 * Configure sensor setting
MACRUM 0:e642dd732c4b 110 *
MACRUM 0:e642dd732c4b 111 */
MACRUM 0:e642dd732c4b 112 void initialize(void);
MACRUM 0:e642dd732c4b 113
MACRUM 0:e642dd732c4b 114 /**
MACRUM 0:e642dd732c4b 115 * Get X axis acceleration
MACRUM 0:e642dd732c4b 116 *
MACRUM 0:e642dd732c4b 117 * @returns X axis acceleration
MACRUM 0:e642dd732c4b 118 */
MACRUM 0:e642dd732c4b 119 float getAccX();
MACRUM 0:e642dd732c4b 120
MACRUM 0:e642dd732c4b 121 /**
MACRUM 0:e642dd732c4b 122 * Get Y axis acceleration
MACRUM 0:e642dd732c4b 123 *
MACRUM 0:e642dd732c4b 124 * @returns Y axis acceleration
MACRUM 0:e642dd732c4b 125 */
MACRUM 0:e642dd732c4b 126 float getAccY();
MACRUM 0:e642dd732c4b 127
MACRUM 0:e642dd732c4b 128 /**
MACRUM 0:e642dd732c4b 129 * Get Z axis acceleration
MACRUM 0:e642dd732c4b 130 *
MACRUM 0:e642dd732c4b 131 * @returns Z axis acceleration
MACRUM 0:e642dd732c4b 132 */
MACRUM 0:e642dd732c4b 133 float getAccZ();
MACRUM 0:e642dd732c4b 134
MACRUM 0:e642dd732c4b 135 /**
MACRUM 0:e642dd732c4b 136 * Get XYZ axis acceleration
MACRUM 0:e642dd732c4b 137 *
MACRUM 0:e642dd732c4b 138 * @param res array where acceleration data will be stored
MACRUM 0:e642dd732c4b 139 */
MACRUM 0:e642dd732c4b 140 void getAccAllAxis(float * res);
MACRUM 0:e642dd732c4b 141
MACRUM 0:e642dd732c4b 142 private:
deldering95 4:4038b02c530d 143 I2C* m_i2c;
MACRUM 0:e642dd732c4b 144 int m_addr;
MACRUM 0:e642dd732c4b 145 void readRegs(int addr, uint8_t * data, int len);
MACRUM 0:e642dd732c4b 146 void writeRegs(uint8_t * data, int len);
MACRUM 0:e642dd732c4b 147 int16_t getAccAxis(uint8_t addr);
MACRUM 0:e642dd732c4b 148
MACRUM 0:e642dd732c4b 149 };
MACRUM 0:e642dd732c4b 150
MACRUM 0:e642dd732c4b 151 #endif