Difference between revisions of "Component: Accelerometer 3-Axis (LIS3LV02DQ) (Movement Orientation)"

Revision as of 09:54, 27 January 2023

Author	Matrix Ltd.
Version	2.0
Category	Movement Orientation

Accelerometer 3-Axis (LIS3LV02DQ) component

LIS3LV02DQ Accelerometer sensor with options for I2C or SPI communications. Useful for approximating Pitch and Roll or for detecting acceleration. Also available in the form of the EB068 Accelerometer E-block.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- 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

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

	SimSetXYZ
Allows the XYZ slider values to be set via the simulation
- INT	X

- INT	Y

- INT	Z

- VOID	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
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Bus Type
The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS
	Data Rate
Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results
	Scale
The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Power Option
Sets if the sensor is always powered or powered via a microcontroller output pin.
	Connections
	SPI Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulation Coms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

==Macro reference==

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- 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

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

	SimSetXYZ
Allows the XYZ slider values to be set via the simulation
- INT	X

- INT	Y

- INT	Z

- VOID	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
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Bus Type
The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS
	Data Rate
Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results
	Scale
The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Power Option
Sets if the sensor is always powered or powered via a microcontroller output pin.
	Connections
	SPI Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulation Coms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

==Macro reference==

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- 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

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

	SimSetXYZ
Allows the XYZ slider values to be set via the simulation
- INT	X

- INT	Y

- INT	Z

- VOID	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
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Bus Type
The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS
	Data Rate
Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results
	Scale
The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Power Option
Sets if the sensor is always powered or powered via a microcontroller output pin.
	Connections
	SPI Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulation Coms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

==Macro reference==

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- 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

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

	SimSetXYZ
Allows the XYZ slider values to be set via the simulation
- INT	X

- INT	Y

- INT	Z

- VOID	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
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Bus Type
The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS
	Data Rate
Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results
	Scale
The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Power Option
Sets if the sensor is always powered or powered via a microcontroller output pin.
	Connections
	SPI Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulation Coms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

==Macro reference==

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- 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

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

	SimSetXYZ
Allows the XYZ slider values to be set via the simulation
- INT	X

- INT	Y

- INT	Z

- VOID	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
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Bus Type
The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS
	Data Rate
Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results
	Scale
The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Power Option
Sets if the sensor is always powered or powered via a microcontroller output pin.
	Connections
	SPI Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulation Coms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

@@ Line 22: / Line 22: @@
 ==Detailed description==
@@ Line 56: / Line 58: @@
 ==Examples==
@@ Line 92: / Line 96: @@
 ==Macro reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SimReset1G'''
+|-
+| colspan="2" | Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CollectXYZData'''
+|-
+| colspan="2" | 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&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Axis
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UpdateXYZData'''
+|-
+| colspan="2" | Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SimSetXYZ'''
+|-
+| colspan="2" | Allows the XYZ slider values to be set via the simulation&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" | X
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" | Y
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" | Z
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | Sets up up the communication bus and initialises the accelerometer module.  Returns 0 for success and > 0 for fail.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Bit Depth
+|-
+| colspan="2" | The number of binary bits used to store the sensor's X,Y,Z readings.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Bus Type
+|-
+| colspan="2" | The interface used to talk to the accelerometer. I2C - Two Wire Interface SDA / SCL SPI - Four Wire Interface MISO / MOSI / SCK / CS&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Data Rate
+|-
+| colspan="2" | Configures how often the sensor collects a new reading. More often = better instant reaction to new events Less often = more stable results&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Scale
+|-
+| colspan="2" | The accelerometer readings are scaled based on the maximum amount of G force the sensor can represent. 6G = Bigger gravitational force 2G = Higher resolution&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Int Option
+|-
+| colspan="2" | Sets if we use the interrupt pin to check if new data is available&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Power Option
+|-
+| colspan="2" | Sets if the sensor is always powered or powered via a microcontroller output pin.&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+|-
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Connections
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Channel
+|-
+| colspan="2" | SPI Channel selector&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Prescale
+|-
+| colspan="2" | Prescale option selector&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | MOSI
+|-
+| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | MISO
+|-
+| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | CLK
+|-
+| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | CS / SS
+|-
+| colspan="2" | Chip Select / Slave Select Pin  Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. &nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Simulation Coms
+|-
+| colspan="2" | Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc&nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Difference between revisions of "Component: Accelerometer 3-Axis (LIS3LV02DQ) (Movement Orientation)"

Revision as of 09:54, 27 January 2023

Contents

Accelerometer 3-Axis (LIS3LV02DQ) component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools