Adafruit LSM6DS Sensors Library
Public Member Functions | List of all members
Adafruit_LSM6DS3 Class Reference

Class that stores state and functions for interacting with the LSM6DS3. More...

#include <Adafruit_LSM6DS3.h>

Inheritance diagram for Adafruit_LSM6DS3:
Adafruit_LSM6DS

Public Member Functions

 Adafruit_LSM6DS3 ()
 Instantiates a new LSM6DS3 class.
 
void enableI2CMasterPullups (bool enable_pullups)
 Enables and disables the I2C master bus pulllups. More...
 
- Public Member Functions inherited from Adafruit_LSM6DS
 Adafruit_LSM6DS ()
 Instantiates a new LSM6DS class.
 
virtual ~Adafruit_LSM6DS ()
 Cleans up the LSM6DS.
 
bool begin_I2C (uint8_t i2c_addr=LSM6DS_I2CADDR_DEFAULT, TwoWire *wire=&Wire, int32_t sensorID=0)
 Sets up the hardware and initializes I2C. More...
 
bool begin_SPI (uint8_t cs_pin, SPIClass *theSPI=&SPI, int32_t sensorID=0, uint32_t frequency=1000000)
 Sets up the hardware and initializes hardware SPI. More...
 
bool begin_SPI (int8_t cs_pin, int8_t sck_pin, int8_t miso_pin, int8_t mosi_pin, int32_t sensorID=0, uint32_t frequency=1000000)
 Sets up the hardware and initializes software SPI. More...
 
bool getEvent (sensors_event_t *accel, sensors_event_t *gyro, sensors_event_t *temp)
 Gets the most recent sensor event, Adafruit Unified Sensor format. More...
 
lsm6ds_data_rate_t getAccelDataRate (void)
 Gets the accelerometer data rate. More...
 
void setAccelDataRate (lsm6ds_data_rate_t data_rate)
 Sets the accelerometer data rate. More...
 
lsm6ds_accel_range_t getAccelRange (void)
 Gets the accelerometer measurement range. More...
 
void setAccelRange (lsm6ds_accel_range_t new_range)
 Sets the accelerometer measurement range. More...
 
lsm6ds_data_rate_t getGyroDataRate (void)
 Gets the gyro data rate. More...
 
void setGyroDataRate (lsm6ds_data_rate_t data_rate)
 Sets the gyro data rate. More...
 
lsm6ds_gyro_range_t getGyroRange (void)
 Gets the gyro range. More...
 
void setGyroRange (lsm6ds_gyro_range_t new_range)
 Sets the gyro range. More...
 
void reset (void)
 Resets the sensor to its power-on state, clearing all registers and memory.
 
void configIntOutputs (bool active_low, bool open_drain)
 Sets the INT1 and INT2 pin activation mode. More...
 
void configInt1 (bool drdy_temp, bool drdy_g, bool drdy_xl, bool step_detect=false, bool wakeup=false)
 Enables and disables the data ready interrupt on INT 1. More...
 
void configInt2 (bool drdy_temp, bool drdy_g, bool drdy_xl)
 Enables and disables the data ready interrupt on INT 2. More...
 
void highPassFilter (bool enabled, lsm6ds_hp_filter_t filter)
 Enables the high pass filter and/or slope filter. More...
 
void enableWakeup (bool enable, uint8_t duration=0, uint8_t thresh=20)
 Enables and disables the wakeup function. More...
 
bool awake (void)
 Checks interrupt register to see if we have a wake signal. More...
 
bool shake (void)
 Simple shake detection. Must call enableWakeup() first. More...
 
void enablePedometer (bool enable)
 Enables and disables the pedometer function. More...
 
void resetPedometer (void)
 Reset the pedometer count.
 
uint16_t readPedometer (void)
 Read the 16-bit pedometer count. More...
 
int readAcceleration (float &x, float &y, float &z)
 Read accelerometer data. More...
 
float accelerationSampleRate (void)
 Gets the accelerometer data rate. More...
 
int accelerationAvailable (void)
 Check for available data from accelerometer. More...
 
int readGyroscope (float &x, float &y, float &z)
 Read gyroscope data. More...
 
float gyroscopeSampleRate (void)
 Get the gyroscope data rate. More...
 
int gyroscopeAvailable (void)
 Check for available data from gyroscope. More...
 
Adafruit_Sensor * getTemperatureSensor (void)
 Gets an Adafruit Unified Sensor object for the temp sensor component. More...
 
Adafruit_Sensor * getAccelerometerSensor (void)
 Gets an Adafruit Unified Sensor object for the accelerometer sensor component. More...
 
Adafruit_Sensor * getGyroSensor (void)
 Gets an Adafruit Unified Sensor object for the gyro sensor component. More...
 

Additional Inherited Members

- Public Attributes inherited from Adafruit_LSM6DS
int16_t rawAccX
 Last reading's raw accelerometer X axis.
 
int16_t rawAccY
 Last reading's raw accelerometer Y axis.
 
int16_t rawAccZ
 Last reading's raw accelerometer Z axis.
 
int16_t rawTemp
 Last reading's raw temperature reading.
 
int16_t rawGyroX
 Last reading's raw gyro X axis.
 
int16_t rawGyroY
 Last reading's raw gyro Y axis.
 
int16_t rawGyroZ
 Last reading's raw gyro Z axis.
 
float temperature
 Last reading's temperature (C)
 
float accX
 Last reading's accelerometer X axis m/s^2.
 
float accY
 Last reading's accelerometer Y axis m/s^2.
 
float accZ
 Last reading's accelerometer Z axis m/s^2.
 
float gyroX
 Last reading's gyro X axis in rad/s.
 
float gyroY
 Last reading's gyro Y axis in rad/s.
 
float gyroZ
 Last reading's gyro Z axis in rad/s.
 
- Protected Member Functions inherited from Adafruit_LSM6DS
uint8_t chipID (void)
 Read chip identification register. More...
 
uint8_t status (void)
 Read Status register. More...
 
virtual void _read (void)
 Updates the measurement data for all sensors simultaneously.
 
- Protected Attributes inherited from Adafruit_LSM6DS
uint16_t _sensorid_accel
 ID number for accelerometer.
 
uint16_t _sensorid_gyro
 ID number for gyro.
 
uint16_t _sensorid_temp
 ID number for temperature.
 
Adafruit_I2CDevice * i2c_dev = NULL
 Pointer to I2C bus interface.
 
Adafruit_SPIDevice * spi_dev = NULL
 Pointer to SPI bus interface.
 
float temperature_sensitivity
 Temp sensor sensitivity in LSB/degC. More...
 
Adafruit_LSM6DS_Temptemp_sensor = NULL
 Temp sensor data object.
 
Adafruit_LSM6DS_Accelerometeraccel_sensor
 Accelerometer data object. More...
 
Adafruit_LSM6DS_Gyrogyro_sensor = NULL
 Gyro data object.
 
lsm6ds_accel_range_t accelRangeBuffered = LSM6DS_ACCEL_RANGE_2_G
 buffer for the accelerometer range
 
lsm6ds_gyro_range_t gyroRangeBuffered = LSM6DS_GYRO_RANGE_250_DPS
 buffer for the gyroscope range
 

Detailed Description

Class that stores state and functions for interacting with the LSM6DS3.

Member Function Documentation

◆ enableI2CMasterPullups()

void Adafruit_LSM6DS3::enableI2CMasterPullups ( bool  enable_pullups)

Enables and disables the I2C master bus pulllups.

Parameters
enable_pullupstrue to enable the I2C pullups, false to disable.

The documentation for this class was generated from the following files: