Component: Accel / Gyro / Mag 9-Axis (LSM9DS1) (Movement Orientation)
From Flowcode Help
(Redirected from Component: ID 20699a0c 0925 40c4 8aa1 35f294e225e6)
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.1 |
| Category | Movement Orientation |
Contents
- 1 Accel / Gyro / Mag 9-Axis (LSM9DS1) component
- 2 Detailed description
- 3 Examples
- 4 Macro reference
- 4.1 CollectXYZData
- 4.2 Initialise
- 4.3 ReadTemperature
- 4.4 Read_Bearing
- 4.5 Read_N_Registers
- 4.6 Read_Register
- 4.7 SetAddress
- 4.8 SimReset1G
- 4.9 SimSetAccelerometer
- 4.10 SimSetCompass
- 4.11 SimSetGyro
- 4.12 SimSetTemperature
- 4.13 UpdateAccelerometerData
- 4.14 UpdateCompassData
- 4.15 UpdateGyroData
- 4.16 Write_N_Registers
- 4.17 Write_Register
- 5 Property reference
- 6 Component Source Code
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.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
CollectXYZData
|
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 |
Initialise
|
|
Initialise |
| Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail. | |
| - BYTE
|
Return |
ReadTemperature
|
|
ReadTemperature |
| Reads the temperature from the sensor and returns the value as an integer. | |
| - INT
|
Return |
Read_Bearing
|
|
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 |
Read_N_Registers
|
|
Read_N_Registers |
| Reads a set of data values from sequential registers on the accelerometer | |
| - BYTE
|
Start_Reg |
| - BYTE
|
Num_Regs |
| - BYTE
|
Data |
 - VOID
|
Return |
Read_Register
|
|
Read_Register |
| Reads a value from a register on the accelerometer. | |
| - BYTE
|
Reg |
| - BYTE
|
Return |
SetAddress
|
|
SetAddress |
 - BOOL
|
Address |
| 0=Accelerometer, 1=Magnetometer | |
| - VOID
|
Return |
SimReset1G
|
|
SimReset1G |
| - VOID
|
Return |
SimSetAccelerometer
|
|
SimSetAccelerometer |
| Allows the XYZ slider values to be set via the simulation | |
| - INT
|
X |
| - INT
|
Y |
| - INT
|
Z |
| - VOID
|
Return |
SimSetCompass
|
|
SimSetCompass |
| Allows the XYZ slider values to be set via the simulation | |
| - INT
|
X |
| - INT
|
Y |
| - INT
|
Z |
| - VOID
|
Return |
SimSetGyro
|
|
SimSetGyro |
| Allows the XYZ slider values to be set via the simulation | |
| - INT
|
X |
| - INT
|
Y |
| - INT
|
Z |
| - VOID
|
Return |
SimSetTemperature
|
|
SimSetTemperature |
| Allows the XYZ slider values to be set via the simulation | |
| - INT
|
Temp |
| - VOID
|
Return |
UpdateAccelerometerData
|
|
UpdateAccelerometerData |
| Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data | |
| - BYTE
|
Return |
UpdateCompassData
|
|
UpdateCompassData |
| Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data | |
| - BYTE
|
Return |
UpdateGyroData
|
|
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_N_Registers
|
|
Write_N_Registers |
| Writes a set of data values to a sequential registers on the accelerometer | |
| - BYTE
|
Start_Reg |
| - BYTE
|
Num_Regs |
 - STRING
|
Data |
| - VOID
|
Return |
Write_Register
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
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
