Statistics
| Branch: | Revision:

adafruit_bno055 / Adafruit_BNO055.cpp @ 94d672fd

History | View | Annotate | Download (13.365 KB)

1
/***************************************************************************
2
  This is a library for the BNO055 orientation sensor
3

4
  Designed specifically to work with the Adafruit BNO055 Breakout.
5

6
  Pick one up today in the adafruit shop!
7
  ------> http://www.adafruit.com/products
8

9
  These sensors use I2C to communicate, 2 pins are required to interface.
10

11
  Adafruit invests time and resources providing this open source code,
12
  please support Adafruit andopen-source hardware by purchasing products
13
  from Adafruit!
14

15
  Written by KTOWN for Adafruit Industries.
16

17
  MIT license, all text above must be included in any redistribution
18
 ***************************************************************************/
19

    
20
#if ARDUINO >= 100
21
 #include "Arduino.h"
22
#else
23
 #include "WProgram.h"
24
#endif
25

    
26
#include <math.h>
27
#include <limits.h>
28

    
29
#include "Adafruit_BNO055.h"
30

    
31
/***************************************************************************
32
 CONSTRUCTOR
33
 ***************************************************************************/
34

    
35
/**************************************************************************/
36
/*!
37
    @brief  Instantiates a new Adafruit_BNO055 class
38
*/
39
/**************************************************************************/
40
Adafruit_BNO055::Adafruit_BNO055(int32_t sensorID, uint8_t address)
41
{
42
  _sensorID = sensorID;
43
  _address = address;
44
}
45

    
46
/***************************************************************************
47
 PUBLIC FUNCTIONS
48
 ***************************************************************************/
49

    
50
/**************************************************************************/
51
/*!
52
    @brief  Sets up the HW
53
*/
54
/**************************************************************************/
55
bool Adafruit_BNO055::begin(adafruit_bno055_opmode_t mode)
56
{
57
  /* Enable I2C */
58
  Wire.begin();
59

    
60
  /* Make sure we have the right device */
61
  uint8_t id = read8(BNO055_CHIP_ID_ADDR);
62
  if(id != BNO055_ID)
63
  {
64
    delay(1000); // hold on for boot
65
    id = read8(BNO055_CHIP_ID_ADDR);
66
    if(id != BNO055_ID) {
67
      return false;  // still not? ok bail
68
    }
69
  }
70

    
71
  /* Switch to config mode (just in case since this is the default) */
72
  setMode(OPERATION_MODE_CONFIG);
73

    
74
  /* Reset */
75
  write8(BNO055_SYS_TRIGGER_ADDR, 0x20);
76
  while (read8(BNO055_CHIP_ID_ADDR) != BNO055_ID)
77
  {
78
    delay(10);
79
  }
80
  delay(50);
81

    
82
  /* Set to normal power mode */
83
  write8(BNO055_PWR_MODE_ADDR, POWER_MODE_NORMAL);
84
  delay(10);
85

    
86
  write8(BNO055_PAGE_ID_ADDR, 0);
87

    
88
  /* Set the output units */
89
  /*
90
  uint8_t unitsel = (0 << 7) | // Orientation = Android
91
                    (0 << 4) | // Temperature = Celsius
92
                    (0 << 2) | // Euler = Degrees
93
                    (1 << 1) | // Gyro = Rads
94
                    (0 << 0);  // Accelerometer = m/s^2
95
  write8(BNO055_UNIT_SEL_ADDR, unitsel);
96
  */
97

    
98
  write8(BNO055_SYS_TRIGGER_ADDR, 0x0);
99
  delay(10);
100
  /* Set the requested operating mode (see section 3.3) */
101
  setMode(mode);
102
  delay(20);
103

    
104
  return true;
105
}
106

    
107
/**************************************************************************/
108
/*!
109
    @brief  Puts the chip in the specified operating mode
110
*/
111
/**************************************************************************/
112
void Adafruit_BNO055::setMode(adafruit_bno055_opmode_t mode)
113
{
114
  _mode = mode;
115
  write8(BNO055_OPR_MODE_ADDR, _mode);
116
  delay(30);
117
}
118

    
119
/**************************************************************************/
120
/*!
121
    @brief  Use the external 32.768KHz crystal
122
*/
123
/**************************************************************************/
124
void Adafruit_BNO055::setExtCrystalUse(boolean usextal)
125
{
126
  adafruit_bno055_opmode_t modeback = _mode;
127

    
128
  /* Switch to config mode (just in case since this is the default) */
129
  setMode(OPERATION_MODE_CONFIG);
130
  delay(25);
131
  write8(BNO055_PAGE_ID_ADDR, 0);
132
  if (usextal) {
133
    write8(BNO055_SYS_TRIGGER_ADDR, 0x80);
134
  } else {
135
    write8(BNO055_SYS_TRIGGER_ADDR, 0x00);
136
  }
137
  delay(10);
138
  /* Set the requested operating mode (see section 3.3) */
139
  setMode(modeback);
140
  delay(20);
141
}
142

    
143

    
144
/**************************************************************************/
145
/*!
146
    @brief  Gets the latest system status info
147
*/
148
/**************************************************************************/
149
void Adafruit_BNO055::getSystemStatus(uint8_t *system_status, uint8_t *self_test_result, uint8_t *system_error)
150
{
151
  write8(BNO055_PAGE_ID_ADDR, 0);
152

    
153
  /* System Status (see section 4.3.58)
154
     ---------------------------------
155
     0 = Idle
156
     1 = System Error
157
     2 = Initializing Peripherals
158
     3 = System Iniitalization
159
     4 = Executing Self-Test
160
     5 = Sensor fusio algorithm running
161
     6 = System running without fusion algorithms */
162

    
163
  if (system_status != 0)
164
    *system_status    = read8(BNO055_SYS_STAT_ADDR);
165

    
166
  /* Self Test Results (see section )
167
     --------------------------------
168
     1 = test passed, 0 = test failed
169

170
     Bit 0 = Accelerometer self test
171
     Bit 1 = Magnetometer self test
172
     Bit 2 = Gyroscope self test
173
     Bit 3 = MCU self test
174

175
     0x0F = all good! */
176

    
177
  if (self_test_result != 0)
178
    *self_test_result = read8(BNO055_SELFTEST_RESULT_ADDR);
179

    
180
  /* System Error (see section 4.3.59)
181
     ---------------------------------
182
     0 = No error
183
     1 = Peripheral initialization error
184
     2 = System initialization error
185
     3 = Self test result failed
186
     4 = Register map value out of range
187
     5 = Register map address out of range
188
     6 = Register map write error
189
     7 = BNO low power mode not available for selected operat ion mode
190
     8 = Accelerometer power mode not available
191
     9 = Fusion algorithm configuration error
192
     A = Sensor configuration error */
193

    
194
  if (system_error != 0)
195
    *system_error     = read8(BNO055_SYS_ERR_ADDR);
196

    
197
  delay(200);
198
}
199

    
200
/**************************************************************************/
201
/*!
202
    @brief  Gets the chip revision numbers
203
*/
204
/**************************************************************************/
205
void Adafruit_BNO055::getRevInfo(adafruit_bno055_rev_info_t* info)
206
{
207
  uint8_t a, b;
208

    
209
  memset(info, 0, sizeof(adafruit_bno055_rev_info_t));
210

    
211
  /* Check the accelerometer revision */
212
  info->accel_rev = read8(BNO055_ACCEL_REV_ID_ADDR);
213

    
214
  /* Check the magnetometer revision */
215
  info->mag_rev   = read8(BNO055_MAG_REV_ID_ADDR);
216

    
217
  /* Check the gyroscope revision */
218
  info->gyro_rev  = read8(BNO055_GYRO_REV_ID_ADDR);
219

    
220
  /* Check the SW revision */
221
  info->bl_rev    = read8(BNO055_BL_REV_ID_ADDR);
222

    
223
  a = read8(BNO055_SW_REV_ID_LSB_ADDR);
224
  b = read8(BNO055_SW_REV_ID_MSB_ADDR);
225
  info->sw_rev = (((uint16_t)b) << 8) | ((uint16_t)a);
226
}
227

    
228
/**************************************************************************/
229
/*!
230
    @brief  Gets current calibration state.  Each value should be a uint8_t
231
            pointer and it will be set to 0 if not calibrated and 3 if
232
            fully calibrated.
233
*/
234
/**************************************************************************/
235
void Adafruit_BNO055::getCalibration(uint8_t* sys, uint8_t* gyro, uint8_t* accel, uint8_t* mag) {
236
  uint8_t calData = read8(BNO055_CALIB_STAT_ADDR);
237
  if (sys != NULL) {
238
    *sys = (calData >> 6) & 0x03;
239
  }
240
  if (gyro != NULL) {
241
    *gyro = (calData >> 4) & 0x03;
242
  }
243
  if (accel != NULL) {
244
    *accel = (calData >> 2) & 0x03;
245
  }
246
  if (mag != NULL) {
247
    *mag = calData & 0x03;
248
  }
249
}
250

    
251
/**************************************************************************/
252
/*!
253
    @brief  Gets the temperature in degrees celsius
254
*/
255
/**************************************************************************/
256
int8_t Adafruit_BNO055::getTemp(void)
257
{
258
  int8_t temp = (int8_t)(read8(BNO055_TEMP_ADDR));
259
  return temp;
260
}
261

    
262
/**************************************************************************/
263
/*!
264
    @brief  Gets a vector reading from the specified source
265
*/
266
/**************************************************************************/
267
imu::Vector<3> Adafruit_BNO055::getVector(adafruit_vector_type_t vector_type)
268
{
269
  imu::Vector<3> xyz;
270
  uint8_t buffer[6];
271
  memset (buffer, 0, 6);
272

    
273
  int16_t x, y, z;
274
  x = y = z = 0;
275

    
276
  /* Read vector data (6 bytes) */
277
  readLen((adafruit_bno055_reg_t)vector_type, buffer, 6);
278

    
279
  x = ((int16_t)buffer[0]) | (((int16_t)buffer[1]) << 8);
280
  y = ((int16_t)buffer[2]) | (((int16_t)buffer[3]) << 8);
281
  z = ((int16_t)buffer[4]) | (((int16_t)buffer[5]) << 8);
282

    
283
  /* Convert the value to an appropriate range (section 3.6.4) */
284
  /* and assign the value to the Vector type */
285
  switch(vector_type)
286
  {
287
    case VECTOR_MAGNETOMETER:
288
      /* 1uT = 16 LSB */
289
      xyz[0] = ((double)x)/16.0;
290
      xyz[1] = ((double)y)/16.0;
291
      xyz[2] = ((double)z)/16.0;
292
      break;
293
    case VECTOR_GYROSCOPE:
294
      /* 1rps = 900 LSB */
295
      xyz[0] = ((double)x)/900.0;
296
      xyz[1] = ((double)y)/900.0;
297
      xyz[2] = ((double)z)/900.0;
298
      break;
299
    case VECTOR_EULER:
300
      /* 1 degree = 16 LSB */
301
      xyz[0] = ((double)x)/16.0;
302
      xyz[1] = ((double)y)/16.0;
303
      xyz[2] = ((double)z)/16.0;
304
      break;
305
    case VECTOR_ACCELEROMETER:
306
    case VECTOR_LINEARACCEL:
307
    case VECTOR_GRAVITY:
308
      /* 1m/s^2 = 100 LSB */
309
      xyz[0] = ((double)x)/100.0;
310
      xyz[1] = ((double)y)/100.0;
311
      xyz[2] = ((double)z)/100.0;
312
      break;
313
  }
314

    
315
  return xyz;
316
}
317

    
318
/**************************************************************************/
319
/*!
320
    @brief  Gets a quaternion reading from the specified source
321
*/
322
/**************************************************************************/
323
imu::Quaternion Adafruit_BNO055::getQuat(void)
324
{
325
  uint8_t buffer[8];
326
  memset (buffer, 0, 8);
327

    
328
  int16_t x, y, z, w;
329
  x = y = z = w = 0;
330

    
331
  /* Read quat data (8 bytes) */
332
  readLen(BNO055_QUATERNION_DATA_W_LSB_ADDR, buffer, 8);
333
  w = (((uint16_t)buffer[1]) << 8) | ((uint16_t)buffer[0]);
334
  x = (((uint16_t)buffer[3]) << 8) | ((uint16_t)buffer[2]);
335
  y = (((uint16_t)buffer[5]) << 8) | ((uint16_t)buffer[4]);
336
  z = (((uint16_t)buffer[7]) << 8) | ((uint16_t)buffer[6]);
337

    
338
  /* Assign to Quaternion */
339
  /* See http://ae-bst.resource.bosch.com/media/products/dokumente/bno055/BST_BNO055_DS000_12~1.pdf
340
     3.6.5.5 Orientation (Quaternion)  */
341
  const double scale = (1.0 / (1<<14));
342
  imu::Quaternion quat(scale * w, scale * x, scale * y, scale * z);
343
  return quat;
344
}
345

    
346
/**************************************************************************/
347
/*!
348
    @brief  Provides the sensor_t data for this sensor
349
*/
350
/**************************************************************************/
351
void Adafruit_BNO055::getSensor(sensor_t *sensor)
352
{
353
  /* Clear the sensor_t object */
354
  memset(sensor, 0, sizeof(sensor_t));
355

    
356
  /* Insert the sensor name in the fixed length char array */
357
  strncpy (sensor->name, "BNO055", sizeof(sensor->name) - 1);
358
  sensor->name[sizeof(sensor->name)- 1] = 0;
359
  sensor->version     = 1;
360
  sensor->sensor_id   = _sensorID;
361
  sensor->type        = SENSOR_TYPE_ORIENTATION;
362
  sensor->min_delay   = 0;
363
  sensor->max_value   = 0.0F;
364
  sensor->min_value   = 0.0F;
365
  sensor->resolution  = 0.01F;
366
}
367

    
368
/**************************************************************************/
369
/*!
370
    @brief  Reads the sensor and returns the data as a sensors_event_t
371
*/
372
/**************************************************************************/
373
bool Adafruit_BNO055::getEvent(sensors_event_t *event)
374
{
375
  /* Clear the event */
376
  memset(event, 0, sizeof(sensors_event_t));
377

    
378
  event->version   = sizeof(sensors_event_t);
379
  event->sensor_id = _sensorID;
380
  event->type      = SENSOR_TYPE_ORIENTATION;
381
  event->timestamp = millis();
382

    
383
  /* Get a Euler angle sample for orientation */
384
  imu::Vector<3> euler = getVector(Adafruit_BNO055::VECTOR_EULER);
385
  event->orientation.x = euler.x();
386
  event->orientation.y = euler.y();
387
  event->orientation.z = euler.z();
388

    
389
  return true;
390
}
391

    
392
/***************************************************************************
393
 PRIVATE FUNCTIONS
394
 ***************************************************************************/
395

    
396
/**************************************************************************/
397
/*!
398
    @brief  Writes an 8 bit value over I2C
399
*/
400
/**************************************************************************/
401
bool Adafruit_BNO055::write8(adafruit_bno055_reg_t reg, byte value)
402
{
403
  Wire.beginTransmission(_address);
404
  #if ARDUINO >= 100
405
    Wire.write((uint8_t)reg);
406
    Wire.write((uint8_t)value);
407
  #else
408
    Wire.send(reg);
409
    Wire.send(value);
410
  #endif
411
  Wire.endTransmission();
412

    
413
  /* ToDo: Check for error! */
414
  return true;
415
}
416

    
417
/**************************************************************************/
418
/*!
419
    @brief  Reads an 8 bit value over I2C
420
*/
421
/**************************************************************************/
422
byte Adafruit_BNO055::read8(adafruit_bno055_reg_t reg )
423
{
424
  byte value = 0;
425

    
426
  Wire.beginTransmission(_address);
427
  #if ARDUINO >= 100
428
    Wire.write((uint8_t)reg);
429
  #else
430
    Wire.send(reg);
431
  #endif
432
  Wire.endTransmission();
433
  Wire.requestFrom(_address, (byte)1);
434
  #if ARDUINO >= 100
435
    value = Wire.read();
436
  #else
437
    value = Wire.receive();
438
  #endif
439

    
440
  return value;
441
}
442

    
443
/**************************************************************************/
444
/*!
445
    @brief  Reads the specified number of bytes over I2C
446
*/
447
/**************************************************************************/
448
bool Adafruit_BNO055::readLen(adafruit_bno055_reg_t reg, byte * buffer, uint8_t len)
449
{
450
  Wire.beginTransmission(_address);
451
  #if ARDUINO >= 100
452
    Wire.write((uint8_t)reg);
453
  #else
454
    Wire.send(reg);
455
  #endif
456
  Wire.endTransmission();
457
  Wire.requestFrom(_address, (byte)len);
458

    
459
  for (uint8_t i = 0; i < len; i++)
460
  {
461
    #if ARDUINO >= 100
462
      buffer[i] = Wire.read();
463
    #else
464
      buffer[i] = Wire.receive();
465
    #endif
466
  }
467

    
468
  /* ToDo: Check for errors! */
469
  return true;
470
}