Component: Accel / Gyro / Mag 9-Axis (LSM9DS1) (Movement Orientation)

Author	Matrix TSL
Version	1.1
Category	Movement Orientation

Accel / Gyro / Mag 9-Axis (LSM9DS1) component

LSM9DS1 Combined 9-Axis Accelerometer, Gyroscope and Magnetometer sensors Useful for working out orientation data such as Pitch, Yaw and Roll.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_AccelMagGyro_LSM9DS1.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_AccelMagGyro_LSM9DS1.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	Read_Register
Reads a value from a register on the accelerometer.
- BYTE	Reg
- BYTE	Return

	ReadTemperature
Reads the temperature from the sensor and returns the value as an integer.
- INT	Return

	SimSetTemperature
Allows the XYZ slider values to be set via the simulation
- INT	Temp
- VOID	Return

	SimReset1G
- VOID	Return

	UpdateGyroData
Reads from the gyroscope and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	Write_Register
Writes a data value to a specific register on the accelerometer
- BYTE	Reg
- BYTE	Data
- BYTE	Return

	UpdateCompassData
Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetAccelerometer
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	CollectXYZData
Collect the data from the local accelerometer buffers. The Axis parameter specifies the Axis to be read. 0 / 'x' / 'X' - X axis 1 / 'y' / 'Y' - Y axis 2 / 'z' / 'Z' - Z axis
- BYTE	Axis
- INT	Return

	SimSetGyro
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	UpdateAccelerometerData
Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetCompass
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	Read_Bearing
Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit
- BYTE	NumSamples
The number of readings to base the bearing on
- UINT	Return

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.
- BYTE	Return

Property reference

	Properties
	Connections
	Accel Gryo SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Magnetometer SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Sensor Properties
	Accel Scale
Sets the output range of the accelerometer sensor
	Accel Data Rate
Sets the accelerometer data rate and bandwidth
	Gyro Scale
Sets the output scale of the gyro, measured in degrees per second
	Gyro Data Rate
Sets the accelerometer data rate and bandwidth
	Compass Scale
Sets the magnetometer full scale range - fixed at +/- 4800 uT
	Compass Data Rate
Sets the accelerometer data rate and bandwidth
	Simulation
	Simulation Type

==Macro reference==

	Read_Register
Reads a value from a register on the accelerometer.
- BYTE	Reg
- BYTE	Return

	ReadTemperature
Reads the temperature from the sensor and returns the value as an integer.
- INT	Return

	SimSetTemperature
Allows the XYZ slider values to be set via the simulation
- INT	Temp
- VOID	Return

	SimReset1G
- VOID	Return

	UpdateGyroData
Reads from the gyroscope and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	Write_Register
Writes a data value to a specific register on the accelerometer
- BYTE	Reg
- BYTE	Data
- BYTE	Return

	UpdateCompassData
Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetAccelerometer
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	CollectXYZData
Collect the data from the local accelerometer buffers. The Axis parameter specifies the Axis to be read. 0 / 'x' / 'X' - X axis 1 / 'y' / 'Y' - Y axis 2 / 'z' / 'Z' - Z axis
- BYTE	Axis
- INT	Return

	SimSetGyro
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	UpdateAccelerometerData
Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetCompass
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	Read_Bearing
Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit
- BYTE	NumSamples
The number of readings to base the bearing on
- UINT	Return

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.
- BYTE	Return

Property reference

	Properties
	Connections
	Accel Gryo SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Magnetometer SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Sensor Properties
	Accel Scale
Sets the output range of the accelerometer sensor
	Accel Data Rate
Sets the accelerometer data rate and bandwidth
	Gyro Scale
Sets the output scale of the gyro, measured in degrees per second
	Gyro Data Rate
Sets the accelerometer data rate and bandwidth
	Compass Scale
Sets the magnetometer full scale range - fixed at +/- 4800 uT
	Compass Data Rate
Sets the accelerometer data rate and bandwidth
	Simulation
	Simulation Type

==Macro reference==

	Read_Register
Reads a value from a register on the accelerometer.
- BYTE	Reg
- BYTE	Return

	ReadTemperature
Reads the temperature from the sensor and returns the value as an integer.
- INT	Return

	SimSetTemperature
Allows the XYZ slider values to be set via the simulation
- INT	Temp
- VOID	Return

	SimReset1G
- VOID	Return

	UpdateGyroData
Reads from the gyroscope and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	Write_Register
Writes a data value to a specific register on the accelerometer
- BYTE	Reg
- BYTE	Data
- BYTE	Return

	UpdateCompassData
Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetAccelerometer
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	CollectXYZData
Collect the data from the local accelerometer buffers. The Axis parameter specifies the Axis to be read. 0 / 'x' / 'X' - X axis 1 / 'y' / 'Y' - Y axis 2 / 'z' / 'Z' - Z axis
- BYTE	Axis
- INT	Return

	SimSetGyro
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	UpdateAccelerometerData
Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetCompass
Allows the XYZ slider values to be set via the simulation
- INT	X
- INT	Y
- INT	Z
- VOID	Return

	Read_Bearing
Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit
- BYTE	NumSamples
The number of readings to base the bearing on
- UINT	Return

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.
- BYTE	Return

Property reference

	Properties
	Connections
	Accel Gryo SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Magnetometer SA0 Pin
Determines the LSB of the I2C device address to allow up to two sensors to work together.
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Sensor Properties
	Accel Scale
Sets the output range of the accelerometer sensor
	Accel Data Rate
Sets the accelerometer data rate and bandwidth
	Gyro Scale
Sets the output scale of the gyro, measured in degrees per second
	Gyro Data Rate
Sets the accelerometer data rate and bandwidth
	Compass Scale
Sets the magnetometer full scale range - fixed at +/- 4800 uT
	Compass Data Rate
Sets the accelerometer data rate and bandwidth
	Simulation
	Simulation Type