Adafruit_LIS331.h

Go to the documentation of this file.

#ifndef ADAFRUIT_LIS331_H
#define ADAFRUIT_LIS331_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 LIS331_DEFAULT_ADDRESS (0x18)
#define LIS331_CHIP_ID                                                         \
  0x32 

#define LIS331_REG_WHOAMI                                                      \
  0x0F 
#define LIS331_REG_CTRL1 0x20 
#define LIS331_REG_CTRL2 0x21 
#define LIS331_REG_CTRL3                                                       \
  0x22 
#define LIS331_REG_CTRL4 0x23           
#define LIS331_REG_CTRL5 0x24           
#define LIS331_REG_HP_FILTER_RESET 0x25 
#define LIS331_REG_REFERENCE 0x26       
#define LIS331_REG_STATUS 0x27  
#define LIS331_REG_OUT_X_L 0x28 
#define LIS331_REG_OUT_X_H 0x29 
#define LIS331_REG_OUT_Y_L 0x2A 
#define LIS331_REG_OUT_Y_H 0x2B 
#define LIS331_REG_OUT_Z_L 0x2C 
#define LIS331_REG_OUT_Z_H 0x2D 
#define LIS331_REG_INT1CFG 0x30 
#define LIS331_REG_INT1SRC 0x31 
#define LIS331_REG_INT1THS 0x32 
#define LIS331_REG_INT1DUR 0x33 
#define LIS331_REG_INT2CFG 0x34 
#define LIS331_REG_INT2SRC 0x35 
#define LIS331_REG_INT2THS 0x36 
#define LIS331_REG_INT2DUR 0x37 


typedef enum hpf_cutoff {
  LIS331_HPF_0_02_ODR,   
  LIS331_HPF_0_01_ODR,   
  LIS331_HPF_0_005_ODR,  
  LIS331_HPF_0_0025_ODR, 
} lis331_hpf_cutoff_t;

typedef enum {
  LIS331_LPF_37_HZ,
  LIS331_LPF_74_HZ,
  LIS331_LPF_292_HZ,
  LIS331_LPF_780_HZ,

} lis331_lpf_cutoff_t;

typedef enum {
  LIS331_DATARATE_POWERDOWN = 0,
  LIS331_DATARATE_50_HZ = 0x4,
  LIS331_DATARATE_100_HZ = 0x5,
  LIS331_DATARATE_400_HZ = 0x6,
  LIS331_DATARATE_1000_HZ = 0x7,
  LIS331_DATARATE_LOWPOWER_0_5_HZ = 0x8,
  LIS331_DATARATE_LOWPOWER_1_HZ = 0xC,
  LIS331_DATARATE_LOWPOWER_2_HZ = 0x10,
  LIS331_DATARATE_LOWPOWER_5_HZ = 0x14,
  LIS331_DATARATE_LOWPOWER_10_HZ = 0x18,
} lis331_data_rate_t;

typedef enum {
  LIS331_AXIS_X = 0x0,
  LIS331_AXIS_Y = 0x1,
  LIS331_AXIS_Z = 0x2,
} lis331_axis_t;

typedef enum {
  LIS331_MODE_SHUTDOWN,
  LIS331_MODE_NORMAL,
  LIS331_MODE_LOW_POWER // Low power is from 2-6 so checks against this should
                        // be 'mode >=LIS331_MODE_LOW_POWER'
} lis331_mode_t;
class Adafruit_LIS331 : public Adafruit_Sensor {
public:
  Adafruit_LIS331(TwoWire *Wi = &Wire);
  Adafruit_LIS331(int8_t cspin, SPIClass *theSPI = &SPI);
  Adafruit_LIS331(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin);

  uint8_t getDeviceID(void);
  bool configIntDataReady(uint8_t irqnum = 1, bool activelow = true,
                          bool opendrain = true);

  void read(void);

  bool getEvent(sensors_event_t *event);
  void getSensor(sensor_t *sensor);
  void enableHighPassFilter(bool filter_enabled,
                            lis331_hpf_cutoff_t cutoff = LIS331_HPF_0_0025_ODR,
                            bool use_reference = false);
  void setHPFReference(int8_t reference);
  int8_t getHPFReference(void);
  void HPFReset(void);
  bool setLPFCutoff(lis331_lpf_cutoff_t cutoff);

  void setDataRate(lis331_data_rate_t dataRate);
  lis331_data_rate_t getDataRate(void);

  lis331_mode_t getMode(void);
  lis331_mode_t getMode(lis331_data_rate_t rate);
  int16_t x; 
  int16_t y; 
  int16_t z; 
protected:
  float x_g; 
  float y_g; 
  float z_g; 
  virtual void _scaleValues(void);

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

  void writeRange(uint8_t range);
  uint8_t readRange(void);

private:
  int32_t _sensorID;
};

#endif