Statistics
| Branch: | Revision:

adafruit_bno055 / Adafruit_BNO055.h @ 55e2f6d1

History | View | Annotate | Download (10.317 KB)

1
/*!
2
 *
3
 *  This is a library for the BNO055 orientation sensor
4
 *
5
 *  Designed specifically to work with the Adafruit BNO055 Breakout.
6
 *
7
 *  Pick one up today in the adafruit shop!
8
 *  ------> https://www.adafruit.com/product/2472
9
 *
10
 *  These sensors use I2C to communicate, 2 pins are required to interface.
11
 *
12
 *  Adafruit invests time and resources providing this open source code,
13
 *  please support Adafruit andopen-source hardware by purchasing products
14
 *  from Adafruit!
15
 *
16
 *  Written by KTOWN for Adafruit Industries.
17
 *
18
 *  MIT license, all text above must be included in any redistribution
19
 */
20

    
21
#ifndef __ADAFRUIT_BNO055_H__
22
#define __ADAFRUIT_BNO055_H__
23

    
24
#if (ARDUINO >= 100)
25
#include "Arduino.h"
26
#else
27
#include "WProgram.h"
28
#endif
29

    
30
#ifdef __AVR_ATtiny85__
31
#include <TinyWireM.h>
32
#define Wire TinyWireM
33
#else
34
#include <Wire.h>
35
#endif
36

    
37
#include <Adafruit_Sensor.h>
38
#include <utility/imumaths.h>
39

    
40
#define BNO055_ADDRESS_A (0x28)
41
#define BNO055_ADDRESS_B (0x29)
42
#define BNO055_ID (0xA0)
43

    
44
#define NUM_BNO055_OFFSET_REGISTERS (22)
45

    
46
/** A structure to represent offsets **/
47
typedef struct {
48
  int16_t accel_offset_x; /**< x acceleration offset */
49
  int16_t accel_offset_y; /**< y acceleration offset */
50
  int16_t accel_offset_z; /**< z acceleration offset */
51

    
52
  int16_t mag_offset_x; /**< x magnetometer offset */
53
  int16_t mag_offset_y; /**< y magnetometer offset */
54
  int16_t mag_offset_z; /**< z magnetometer offset */
55

    
56
  int16_t gyro_offset_x; /**< x gyroscrope offset */
57
  int16_t gyro_offset_y; /**< y gyroscrope offset */
58
  int16_t gyro_offset_z; /**< z gyroscrope offset */
59

    
60
  int16_t accel_radius; /**< acceleration radius */
61

    
62
  int16_t mag_radius; /**< magnetometer radius */
63
} adafruit_bno055_offsets_t;
64

    
65
/*!
66
 *  @brief  Class that stores state and functions for interacting with
67
 *          BNO055 Sensor
68
 */
69
class Adafruit_BNO055 : public Adafruit_Sensor {
70
public:
71
  /** BNO055 Registers **/
72
  typedef enum {
73
    /* Page id register definition */
74
    BNO055_PAGE_ID_ADDR = 0X07,
75

    
76
    /* PAGE0 REGISTER DEFINITION START*/
77
    BNO055_CHIP_ID_ADDR = 0x00,
78
    BNO055_ACCEL_REV_ID_ADDR = 0x01,
79
    BNO055_MAG_REV_ID_ADDR = 0x02,
80
    BNO055_GYRO_REV_ID_ADDR = 0x03,
81
    BNO055_SW_REV_ID_LSB_ADDR = 0x04,
82
    BNO055_SW_REV_ID_MSB_ADDR = 0x05,
83
    BNO055_BL_REV_ID_ADDR = 0X06,
84

    
85
    /* Accel data register */
86
    BNO055_ACCEL_DATA_X_LSB_ADDR = 0X08,
87
    BNO055_ACCEL_DATA_X_MSB_ADDR = 0X09,
88
    BNO055_ACCEL_DATA_Y_LSB_ADDR = 0X0A,
89
    BNO055_ACCEL_DATA_Y_MSB_ADDR = 0X0B,
90
    BNO055_ACCEL_DATA_Z_LSB_ADDR = 0X0C,
91
    BNO055_ACCEL_DATA_Z_MSB_ADDR = 0X0D,
92

    
93
    /* Mag data register */
94
    BNO055_MAG_DATA_X_LSB_ADDR = 0X0E,
95
    BNO055_MAG_DATA_X_MSB_ADDR = 0X0F,
96
    BNO055_MAG_DATA_Y_LSB_ADDR = 0X10,
97
    BNO055_MAG_DATA_Y_MSB_ADDR = 0X11,
98
    BNO055_MAG_DATA_Z_LSB_ADDR = 0X12,
99
    BNO055_MAG_DATA_Z_MSB_ADDR = 0X13,
100

    
101
    /* Gyro data registers */
102
    BNO055_GYRO_DATA_X_LSB_ADDR = 0X14,
103
    BNO055_GYRO_DATA_X_MSB_ADDR = 0X15,
104
    BNO055_GYRO_DATA_Y_LSB_ADDR = 0X16,
105
    BNO055_GYRO_DATA_Y_MSB_ADDR = 0X17,
106
    BNO055_GYRO_DATA_Z_LSB_ADDR = 0X18,
107
    BNO055_GYRO_DATA_Z_MSB_ADDR = 0X19,
108

    
109
    /* Euler data registers */
110
    BNO055_EULER_H_LSB_ADDR = 0X1A,
111
    BNO055_EULER_H_MSB_ADDR = 0X1B,
112
    BNO055_EULER_R_LSB_ADDR = 0X1C,
113
    BNO055_EULER_R_MSB_ADDR = 0X1D,
114
    BNO055_EULER_P_LSB_ADDR = 0X1E,
115
    BNO055_EULER_P_MSB_ADDR = 0X1F,
116

    
117
    /* Quaternion data registers */
118
    BNO055_QUATERNION_DATA_W_LSB_ADDR = 0X20,
119
    BNO055_QUATERNION_DATA_W_MSB_ADDR = 0X21,
120
    BNO055_QUATERNION_DATA_X_LSB_ADDR = 0X22,
121
    BNO055_QUATERNION_DATA_X_MSB_ADDR = 0X23,
122
    BNO055_QUATERNION_DATA_Y_LSB_ADDR = 0X24,
123
    BNO055_QUATERNION_DATA_Y_MSB_ADDR = 0X25,
124
    BNO055_QUATERNION_DATA_Z_LSB_ADDR = 0X26,
125
    BNO055_QUATERNION_DATA_Z_MSB_ADDR = 0X27,
126

    
127
    /* Linear acceleration data registers */
128
    BNO055_LINEAR_ACCEL_DATA_X_LSB_ADDR = 0X28,
129
    BNO055_LINEAR_ACCEL_DATA_X_MSB_ADDR = 0X29,
130
    BNO055_LINEAR_ACCEL_DATA_Y_LSB_ADDR = 0X2A,
131
    BNO055_LINEAR_ACCEL_DATA_Y_MSB_ADDR = 0X2B,
132
    BNO055_LINEAR_ACCEL_DATA_Z_LSB_ADDR = 0X2C,
133
    BNO055_LINEAR_ACCEL_DATA_Z_MSB_ADDR = 0X2D,
134

    
135
    /* Gravity data registers */
136
    BNO055_GRAVITY_DATA_X_LSB_ADDR = 0X2E,
137
    BNO055_GRAVITY_DATA_X_MSB_ADDR = 0X2F,
138
    BNO055_GRAVITY_DATA_Y_LSB_ADDR = 0X30,
139
    BNO055_GRAVITY_DATA_Y_MSB_ADDR = 0X31,
140
    BNO055_GRAVITY_DATA_Z_LSB_ADDR = 0X32,
141
    BNO055_GRAVITY_DATA_Z_MSB_ADDR = 0X33,
142

    
143
    /* Temperature data register */
144
    BNO055_TEMP_ADDR = 0X34,
145

    
146
    /* Status registers */
147
    BNO055_CALIB_STAT_ADDR = 0X35,
148
    BNO055_SELFTEST_RESULT_ADDR = 0X36,
149
    BNO055_INTR_STAT_ADDR = 0X37,
150

    
151
    BNO055_SYS_CLK_STAT_ADDR = 0X38,
152
    BNO055_SYS_STAT_ADDR = 0X39,
153
    BNO055_SYS_ERR_ADDR = 0X3A,
154

    
155
    /* Unit selection register */
156
    BNO055_UNIT_SEL_ADDR = 0X3B,
157
    BNO055_DATA_SELECT_ADDR = 0X3C,
158

    
159
    /* Mode registers */
160
    BNO055_OPR_MODE_ADDR = 0X3D,
161
    BNO055_PWR_MODE_ADDR = 0X3E,
162

    
163
    BNO055_SYS_TRIGGER_ADDR = 0X3F,
164
    BNO055_TEMP_SOURCE_ADDR = 0X40,
165

    
166
    /* Axis remap registers */
167
    BNO055_AXIS_MAP_CONFIG_ADDR = 0X41,
168
    BNO055_AXIS_MAP_SIGN_ADDR = 0X42,
169

    
170
    /* SIC registers */
171
    BNO055_SIC_MATRIX_0_LSB_ADDR = 0X43,
172
    BNO055_SIC_MATRIX_0_MSB_ADDR = 0X44,
173
    BNO055_SIC_MATRIX_1_LSB_ADDR = 0X45,
174
    BNO055_SIC_MATRIX_1_MSB_ADDR = 0X46,
175
    BNO055_SIC_MATRIX_2_LSB_ADDR = 0X47,
176
    BNO055_SIC_MATRIX_2_MSB_ADDR = 0X48,
177
    BNO055_SIC_MATRIX_3_LSB_ADDR = 0X49,
178
    BNO055_SIC_MATRIX_3_MSB_ADDR = 0X4A,
179
    BNO055_SIC_MATRIX_4_LSB_ADDR = 0X4B,
180
    BNO055_SIC_MATRIX_4_MSB_ADDR = 0X4C,
181
    BNO055_SIC_MATRIX_5_LSB_ADDR = 0X4D,
182
    BNO055_SIC_MATRIX_5_MSB_ADDR = 0X4E,
183
    BNO055_SIC_MATRIX_6_LSB_ADDR = 0X4F,
184
    BNO055_SIC_MATRIX_6_MSB_ADDR = 0X50,
185
    BNO055_SIC_MATRIX_7_LSB_ADDR = 0X51,
186
    BNO055_SIC_MATRIX_7_MSB_ADDR = 0X52,
187
    BNO055_SIC_MATRIX_8_LSB_ADDR = 0X53,
188
    BNO055_SIC_MATRIX_8_MSB_ADDR = 0X54,
189

    
190
    /* Accelerometer Offset registers */
191
    ACCEL_OFFSET_X_LSB_ADDR = 0X55,
192
    ACCEL_OFFSET_X_MSB_ADDR = 0X56,
193
    ACCEL_OFFSET_Y_LSB_ADDR = 0X57,
194
    ACCEL_OFFSET_Y_MSB_ADDR = 0X58,
195
    ACCEL_OFFSET_Z_LSB_ADDR = 0X59,
196
    ACCEL_OFFSET_Z_MSB_ADDR = 0X5A,
197

    
198
    /* Magnetometer Offset registers */
199
    MAG_OFFSET_X_LSB_ADDR = 0X5B,
200
    MAG_OFFSET_X_MSB_ADDR = 0X5C,
201
    MAG_OFFSET_Y_LSB_ADDR = 0X5D,
202
    MAG_OFFSET_Y_MSB_ADDR = 0X5E,
203
    MAG_OFFSET_Z_LSB_ADDR = 0X5F,
204
    MAG_OFFSET_Z_MSB_ADDR = 0X60,
205

    
206
    /* Gyroscope Offset register s*/
207
    GYRO_OFFSET_X_LSB_ADDR = 0X61,
208
    GYRO_OFFSET_X_MSB_ADDR = 0X62,
209
    GYRO_OFFSET_Y_LSB_ADDR = 0X63,
210
    GYRO_OFFSET_Y_MSB_ADDR = 0X64,
211
    GYRO_OFFSET_Z_LSB_ADDR = 0X65,
212
    GYRO_OFFSET_Z_MSB_ADDR = 0X66,
213

    
214
    /* Radius registers */
215
    ACCEL_RADIUS_LSB_ADDR = 0X67,
216
    ACCEL_RADIUS_MSB_ADDR = 0X68,
217
    MAG_RADIUS_LSB_ADDR = 0X69,
218
    MAG_RADIUS_MSB_ADDR = 0X6A
219
  } adafruit_bno055_reg_t;
220

    
221
  /** BNO055 power settings */
222
  typedef enum {
223
    POWER_MODE_NORMAL = 0X00,
224
    POWER_MODE_LOWPOWER = 0X01,
225
    POWER_MODE_SUSPEND = 0X02
226
  } adafruit_bno055_powermode_t;
227

    
228
  /** Operation mode settings **/
229
  typedef enum {
230
    OPERATION_MODE_CONFIG = 0X00,
231
    OPERATION_MODE_ACCONLY = 0X01,
232
    OPERATION_MODE_MAGONLY = 0X02,
233
    OPERATION_MODE_GYRONLY = 0X03,
234
    OPERATION_MODE_ACCMAG = 0X04,
235
    OPERATION_MODE_ACCGYRO = 0X05,
236
    OPERATION_MODE_MAGGYRO = 0X06,
237
    OPERATION_MODE_AMG = 0X07,
238
    OPERATION_MODE_IMUPLUS = 0X08,
239
    OPERATION_MODE_COMPASS = 0X09,
240
    OPERATION_MODE_M4G = 0X0A,
241
    OPERATION_MODE_NDOF_FMC_OFF = 0X0B,
242
    OPERATION_MODE_NDOF = 0X0C
243
  } adafruit_bno055_opmode_t;
244

    
245
  /** Remap settings **/
246
  typedef enum {
247
    REMAP_CONFIG_P0 = 0x21,
248
    REMAP_CONFIG_P1 = 0x24, // default
249
    REMAP_CONFIG_P2 = 0x24,
250
    REMAP_CONFIG_P3 = 0x21,
251
    REMAP_CONFIG_P4 = 0x24,
252
    REMAP_CONFIG_P5 = 0x21,
253
    REMAP_CONFIG_P6 = 0x21,
254
    REMAP_CONFIG_P7 = 0x24
255
  } adafruit_bno055_axis_remap_config_t;
256

    
257
  /** Remap Signs **/
258
  typedef enum {
259
    REMAP_SIGN_P0 = 0x04,
260
    REMAP_SIGN_P1 = 0x00, // default
261
    REMAP_SIGN_P2 = 0x06,
262
    REMAP_SIGN_P3 = 0x02,
263
    REMAP_SIGN_P4 = 0x03,
264
    REMAP_SIGN_P5 = 0x01,
265
    REMAP_SIGN_P6 = 0x07,
266
    REMAP_SIGN_P7 = 0x05
267
  } adafruit_bno055_axis_remap_sign_t;
268

    
269
  /** A structure to represent revisions **/
270
  typedef struct {
271
    uint8_t accel_rev; /**< acceleration rev */
272
    uint8_t mag_rev;   /**< magnetometer rev */
273
    uint8_t gyro_rev;  /**< gyroscrope rev */
274
    uint16_t sw_rev;   /**< SW rev */
275
    uint8_t bl_rev;    /**< bootloader rev */
276
  } adafruit_bno055_rev_info_t;
277

    
278
  /** Vector Mappings **/
279
  typedef enum {
280
    VECTOR_ACCELEROMETER = BNO055_ACCEL_DATA_X_LSB_ADDR,
281
    VECTOR_MAGNETOMETER = BNO055_MAG_DATA_X_LSB_ADDR,
282
    VECTOR_GYROSCOPE = BNO055_GYRO_DATA_X_LSB_ADDR,
283
    VECTOR_EULER = BNO055_EULER_H_LSB_ADDR,
284
    VECTOR_LINEARACCEL = BNO055_LINEAR_ACCEL_DATA_X_LSB_ADDR,
285
    VECTOR_GRAVITY = BNO055_GRAVITY_DATA_X_LSB_ADDR
286
  } adafruit_vector_type_t;
287

    
288
#if defined(ARDUINO_SAMD_ZERO) && !(ARDUINO_SAMD_FEATHER_M0)
289
#error                                                                         \
290
    "On an arduino Zero, BNO055's ADR pin must be high. Fix that, then delete \
291
         this line."
292
  Adafruit_BNO055(int32_t sensorID = -1, uint8_t address = BNO055_ADDRESS_B);
293
#else
294
  Adafruit_BNO055(int32_t sensorID = -1, uint8_t address = BNO055_ADDRESS_A);
295
#endif
296
  bool begin(adafruit_bno055_opmode_t mode = OPERATION_MODE_NDOF);
297
  void setMode(adafruit_bno055_opmode_t mode);
298
  void setAxisRemap(adafruit_bno055_axis_remap_config_t remapcode);
299
  void setAxisSign(adafruit_bno055_axis_remap_sign_t remapsign);
300
  void getRevInfo(adafruit_bno055_rev_info_t *);
301
  void setExtCrystalUse(boolean usextal);
302
  void getSystemStatus(uint8_t *system_status, uint8_t *self_test_result,
303
                       uint8_t *system_error);
304
  void getCalibration(uint8_t *system, uint8_t *gyro, uint8_t *accel,
305
                      uint8_t *mag);
306

    
307
  imu::Vector<3> getVector(adafruit_vector_type_t vector_type);
308
  imu::Quaternion getQuat();
309
  int8_t getTemp();
310

    
311
  /* Adafruit_Sensor implementation */
312
  bool getEvent(sensors_event_t *);
313
  void getSensor(sensor_t *);
314

    
315
  /* Functions to deal with raw calibration data */
316
  bool getSensorOffsets(uint8_t *calibData);
317
  bool getSensorOffsets(adafruit_bno055_offsets_t &offsets_type);
318
  void setSensorOffsets(const uint8_t *calibData);
319
  void setSensorOffsets(const adafruit_bno055_offsets_t &offsets_type);
320
  bool isFullyCalibrated();
321

    
322
private:
323
  byte read8(adafruit_bno055_reg_t);
324
  bool readLen(adafruit_bno055_reg_t, byte *buffer, uint8_t len);
325
  bool write8(adafruit_bno055_reg_t, byte value);
326

    
327
  uint8_t _address;
328
  int32_t _sensorID;
329
  adafruit_bno055_opmode_t _mode;
330
};
331

    
332
#endif