lsm6ds3

Connect to LSM6DS3 sensor on Arduino hardware I2C bus

Description

The lsm6ds3 object reads acceleration, angular velocity, and temperature using the LSM6DS3 sensor connected to the I2C bus of the hardware. The LSM6DS3 is an inertial measurement unit (IMU) used to read acceleration and angular velocity in all three dimensions. The LSM6DS3 also has an embedded temperature sensor. Attach an LSM6DS3 sensor to the I2C pins on the hardware. You can read the data from your sensor in MATLAB^® using the Object Functions.

Creation

Syntax

imu = lsm6ds3(a)

imu = lsm6ds3(a,Name,Value)

Description

imu = lsm6ds3(a) creates a sensor object with default property values.

Example: imu = lsm6ds3(a);.

imu = lsm6ds3(a,Name,Value) creates a sensor object with properties using one or more Name,Value pair arguments.

Example: imu = lsm6ds3(a,'I2CAddress',0x6A);.

Input Arguments

a — Connection to the hardware

object

Connection to the hardware specified as an object.

Example: imu = lsm6ds3(a) creates a connection to the LSM6DS3 sensor on the hardware represented as an object, a.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'I2CAddress' — Specify I2C address of sensor

0x6A | 0x6B

Specify the I2C address of the sensors when multiple I2C devices with the expected address for LSM6DS3 are connected to the same hardware board. LSM6DS3 can have two I2C addresses depending on the logic level on pin SDO/SA0 of the sensor.

Pin Name	Pin State	I2C Address
SDO/SA0	Low	0x6A
	High	0x6B

You can specify the I2C address in:

• Hexadecimal, decimal, or binary format

• String of hexadecimal value of I2C Address

• Character vector of hexadecimal value of I2C Address

Example: imu = lsm6ds3(a,'I2CAddress',0x6A)

0x6A is the I2C address of the accelerometer and gyroscope of LSM6DS3 connected to Arduino board.

If not specified, the object will be created with one of the available I2C device address in the table. Availability of I2C device with the expected address will be determined by using scanI2CBus.

'Bus' — I2C Bus Number

0 (default) | 1

I2C bus number, specified as 0 or 1. The default value is 0.

Example: imu = lsm6ds3(a, 'Bus', 1) creates the sensor object on Bus 1 of the hardware.

Data Types: double

Properties

Note

The properties SampleRate, SamplesPerRead, ReadMode, OutputFormat, TimeFormat, SamplesAvailable, and SamplesRead are available only with the Sensor Fusion and Tracking Toolbox™ and Navigation Toolbox™. These properties can be set while you create the sensor object.

Except for TimeFormat, all the other properties are non-tunable, which means you cannot change their values once the object is locked. Objects are locked when you call the read function, and the release function unlocks them. If a property is tunable, you can change its value at any time.

SampleRate — Rate at which sample is read

100 (default) | positive integer in the range [12.5, 200]

The rate in samples/s at which data is read from the sensor.

Data Types: double

SamplesPerRead — Number of samples read in a single execution of the read function

10 (default) | [1 500]

Number of samples read from the sensor in a single execution of the read function.

Data Types: double

ReadMode — Specify which data samples to be returned

'latest' (default) | 'oldest'

Specify whether to return the latest or the oldest data samples. The number of samples depends on the SamplesPerRead value. The data read from the sensor is stored in the MATLAB buffer.

• latest —

  Provides the latest data samples available in the buffer. All previous data samples in the buffer are discarded. For example, if SamplesPerRead = 3, the latest three data samples read by the sensor are returned.

  The following figure illustrates how latest data samples are returned assuming S1 is the first sensor data stored in the buffer, S2 is the second data and so on and Sn is the last data stored in the buffer and SamplesPerRead property is set to 3 during sensor object creation.

  

• oldest —

  Provides the oldest data samples available in the buffer. In this case, no data samples are discarded. For example, if SamplesPerRead = 3, the first three data samples read are returned for the first read, the next three data samples are returned for the second read, and so on.

  The following figure illustrates how oldest data samples are returned assuming S1 is the first sensor data stored in the buffer, S2 is the second data and so on and Sn is the last data stored in the buffer and SamplesPerRead property is set to 3 during sensor object creation.

  

Data Types: character vector | string

SamplesRead — Samples read

double

This property is read-only.

Samplesread property outputs the values of samples read so far by executing read function. Samplesread is set to 0, when the object is created or when you release the object.

Data Types: double

SamplesAvailable — Samples in the host buffer

double

This property is read-only.

Samples available in the host buffer. The data read from the sensor is stored in the MATLAB buffer. SamplesAvailable property shows the number of SamplesAvailable in this host buffer. When you release the object, SamplesAvailable is set to 0. When the ReadMode of sensor is set as latest, SamplesAvailable will always be 0.

Data Types: double

OutputFormat — Set output format

'timetable' (default) | 'matrix'

Set the output format of the data returned by executing the read function.

When the OutputFormat is set to timetable, the data returned has the following fields:

• Time — Time stamps in datetime or duration format

• Acceleration — N-by-3 array in units of m/s²

• AngularVelocity — N-by-3 array in units of rad/s

• Temperature — N-by-1 array in units of degree Celsius

When the OutputFormat is set to matrix, the data is returned as matrices of acceleration, angular velocity, temperature, and time stamps. The units and size for the sensor readings are the same as the timetable format.

N is the number of samples per read specified by SamplesPerRead. The three columns of each field represent the measurements in x, y, and z axes.

Data Types: character vector | string

TimeFormat — Set time format

'datetime' (default) | 'duration'

Set the format of the time displayed when the sensor data is read.

• datetime — Displays the date and time at which the data is read.

• duration — Displays the time elapsed in seconds after the sensor object is locked. The sensor object gets locked at the first call of the read function either after the object creation or after the execution of the release function.

Data Types: character vector | string

Object Functions

readAcceleration	Read one sample of acceleration from sensor
readAngularVelocity	Read one sample of angular velocity from sensor
readTemperature	Read one sample of temperature from sensor
read	Read real-time sensor data at a specified rate using Sensor Fusion and Tracking Toolbox or Navigation Toolbox
release	Release the sensor object
flush	Flush the host buffer
info	Read information related to sensor

Examples

Create Connection to LSM6DS3 Sensor

Create an arduino object with the I2C library.

a = arduino('COM4', 'Uno', 'Libraries', 'I2C');

Create the sensor object.

imu = lsm6ds3(a)

imu = 

  lsm6ds3 with properties: 

                 I2CAddress: 106  ("0x6B")
                     SCLPin: "A5" 
                     SDAPin: "A4" 

Create LSM6DS3 Sensor Connection (with Sensor Fusion and Tracking Toolbox or Navigation Toolbox)

Create a sensor object with properties available only with the Sensor Fusion and Tracking Toolbox or Navigation Toolbox.

clear imu;
imu = lsm6ds3(a,'SampleRate',110,'SamplesPerRead',3,'ReadMode','Latest')

imu =

  lsm6ds3 with properties:

                         I2CAddress: 107 ("0x6B")
                                Bus: 0
                             SCLPin: "A5"
                             SDAPin: "A4"

                         SampleRate: 110 (samples/s)
                     SamplesPerRead: 3
                           ReadMode: "latest"
                        SamplesRead: 0
                   SamplesAvailable: 0

Show all properties all functions

More About

Code Generation Using MATLAB Function Block

• Use lsm6ds3 in a MATLAB Function block with the Simulink^® Support Package for Arduino^® Hardware to generate code that can be deployed on Arduino Hardware.

• The property ReadMode cannot be changed and is always set to latest.

• The property SamplesPerRead cannot be changed and is always set to 1. So, no framing is provided.

• The property OutputFormat is always set to matrix.

• The property TimeFormat is always set to duration.

• The property SamplesAvailable is not accessible from sensor object.

• The default value of I2C address will be taken as 0x6A. Specify I2C address if the sensor has a different I2C address. The possible values of I2C Addresses are mentioned in the table under I2Caddress section in this page.