Adafruit_LIS3DH.h

Go to the documentation of this file.

#ifndef ADAFRUIT_LIS3DH_H
#define ADAFRUIT_LIS3DH_H

#include "Arduino.h"

#include <SPI.h>
#include <Wire.h>

#include <Adafruit_BusIO_Register.h>
#include <Adafruit_I2CDevice.h>
#include <Adafruit_SPIDevice.h>
#include <Adafruit_Sensor.h>

#define LIS3DH_DEFAULT_ADDRESS (0x18) // if SDO/SA0 is 3V, its 0x19

#define LIS3DH_REG_STATUS1 0x07
#define LIS3DH_REG_OUTADC1_L 0x08 
#define LIS3DH_REG_OUTADC1_H 0x09 
#define LIS3DH_REG_OUTADC2_L 0x0A 
#define LIS3DH_REG_OUTADC2_H 0x0B 
#define LIS3DH_REG_OUTADC3_L 0x0C 
#define LIS3DH_REG_OUTADC3_H 0x0D 
#define LIS3DH_REG_INTCOUNT                                                    \
  0x0E 
#define LIS3DH_REG_WHOAMI                                                      \
  0x0F 
#define LIS3DH_REG_TEMPCFG 0x1F

#define LIS3DH_REG_CTRL1 0x20

#define LIS3DH_REG_CTRL2 0x21

#define LIS3DH_REG_CTRL3 0x22

#define LIS3DH_REG_CTRL4 0x23

#define LIS3DH_REG_CTRL5 0x24

#define LIS3DH_REG_CTRL6 0x25
#define LIS3DH_REG_REFERENCE 0x26 
#define LIS3DH_REG_STATUS2 0x27
#define LIS3DH_REG_OUT_X_L 0x28 
#define LIS3DH_REG_OUT_X_H 0x29 
#define LIS3DH_REG_OUT_Y_L 0x2A 
#define LIS3DH_REG_OUT_Y_H 0x2B 
#define LIS3DH_REG_OUT_Z_L 0x2C 
#define LIS3DH_REG_OUT_Z_H 0x2D 
#define LIS3DH_REG_FIFOCTRL 0x2E
#define LIS3DH_REG_FIFOSRC                                                     \
  0x2F 
#define LIS3DH_REG_INT1CFG 0x30

#define LIS3DH_REG_INT1SRC 0x31
#define LIS3DH_REG_INT1THS                                                     \
  0x32 
#define LIS3DH_REG_INT1DUR                                                     \
  0x33 
#define LIS3DH_REG_CLICKCFG 0x38

#define LIS3DH_REG_CLICKSRC 0x39

#define LIS3DH_REG_CLICKTHS 0x3A

#define LIS3DH_REG_TIMELIMIT 0x3B

#define LIS3DH_REG_TIMELATENCY 0x3C

#define LIS3DH_REG_TIMEWINDOW 0x3D

#define LIS3DH_LSB16_TO_KILO_LSB10                                             \
  64000 
#define LIS3DH_LSB16_TO_KILO_LSB12                                             \
  16000 
#define LIS3DH_LSB16_TO_KILO_LSB8                                              \
  256000 

#define LIS3DH_DEFAULT_SPIFREQ 500000 


typedef enum {
  LIS3DH_RANGE_16_G = 0b11, // +/- 16g
  LIS3DH_RANGE_8_G = 0b10,  // +/- 8g
  LIS3DH_RANGE_4_G = 0b01,  // +/- 4g
  LIS3DH_RANGE_2_G = 0b00   // +/- 2g (default value)
} lis3dh_range_t;

typedef enum {
  LIS3DH_AXIS_X = 0x0,
  LIS3DH_AXIS_Y = 0x1,
  LIS3DH_AXIS_Z = 0x2,
} lis3dh_axis_t;

typedef enum {
  LIS3DH_MODE_LOW_POWER = 0x0,
  LIS3DH_MODE_NORMAL = 0x1,
  LIS3DH_MODE_HIGH_RESOLUTION = 0x2,
} lis3dh_mode_t;

typedef enum {
  LIS3DH_DATARATE_400_HZ = 0b0111, //  400Hz
  LIS3DH_DATARATE_200_HZ = 0b0110, //  200Hz
  LIS3DH_DATARATE_100_HZ = 0b0101, //  100Hz
  LIS3DH_DATARATE_50_HZ = 0b0100,  //   50Hz
  LIS3DH_DATARATE_25_HZ = 0b0011,  //   25Hz
  LIS3DH_DATARATE_10_HZ = 0b0010,  // 10 Hz
  LIS3DH_DATARATE_1_HZ = 0b0001,   // 1 Hz
  LIS3DH_DATARATE_POWERDOWN = 0,
  LIS3DH_DATARATE_LOWPOWER_1K6HZ = 0b1000,
  LIS3DH_DATARATE_LOWPOWER_5KHZ = 0b1001,

} lis3dh_dataRate_t;

class Adafruit_LIS3DH : public Adafruit_Sensor {
public:
  Adafruit_LIS3DH(TwoWire *Wi = &Wire);
  Adafruit_LIS3DH(int8_t cspin, SPIClass *theSPI = &SPI,
                  uint32_t frequency = LIS3DH_DEFAULT_SPIFREQ);
  Adafruit_LIS3DH(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin,
                  uint32_t frequency = LIS3DH_DEFAULT_SPIFREQ);

  bool begin(uint8_t addr = LIS3DH_DEFAULT_ADDRESS, uint8_t nWAI = 0x33);

  uint8_t getDeviceID(void);
  bool haveNewData(void);
  bool enableDRDY(bool enable_drdy = true, uint8_t int_pin = 1);

  void read(void);
  int16_t readADC(uint8_t a);

  lis3dh_mode_t getPerformanceMode(void);
  void setPerformanceMode(lis3dh_mode_t mode);

  void setRange(lis3dh_range_t range);
  lis3dh_range_t getRange(void);

  void setDataRate(lis3dh_dataRate_t dataRate);
  lis3dh_dataRate_t getDataRate(void);

  bool getEvent(sensors_event_t *event);
  void getSensor(sensor_t *sensor);

  void setClick(uint8_t c, uint8_t clickthresh, uint8_t timelimit = 10,
                uint8_t timelatency = 20, uint8_t timewindow = 255);
  uint8_t getClick(void);

  uint8_t readAndClearInterrupt(void);

  int16_t x; 
  int16_t y; 
  int16_t z; 
  float x_g; 
  float y_g; 
  float z_g; 
private:
  TwoWire *I2Cinterface;
  SPIClass *SPIinterface;

  Adafruit_I2CDevice *i2c_dev = NULL; 
  Adafruit_SPIDevice *spi_dev = NULL; 

  uint8_t _wai;

  int8_t _cs, _mosi, _miso, _sck;

  int8_t _i2caddr;

  int32_t _sensorID;
  uint32_t _frequency = LIS3DH_DEFAULT_SPIFREQ;
};

#endif