Component: Accelerometer (EB068) (E-blocks 1)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 2.0 |
| Category | E-blocks 1 |
Contents
Accelerometer 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_EB068.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Accelerometer_EB068.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 |
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
 - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
|
Interrupt Pin |
| Interrupt pin from the sensor, checked when performing an update to see if the sensor has new data available. | |
|
|
Power Pin |
| Power pin if the sensor is powered from an I/O pin. | |
|
|
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 - Injector 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 |
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
|
|
Interrupt Pin |
| Interrupt pin from the sensor, checked when performing an update to see if the sensor has new data available. | |
|
|
Power Pin |
| Power pin if the sensor is powered from an I/O pin. | |
|
|
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 - Injector 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 |
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
|
|
Interrupt Pin |
| Interrupt pin from the sensor, checked when performing an update to see if the sensor has new data available. | |
|
|
Power Pin |
| Power pin if the sensor is powered from an I/O pin. | |
|
|
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 - Injector 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 |
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
|
|
Interrupt Pin |
| Interrupt pin from the sensor, checked when performing an update to see if the sensor has new data available. | |
|
|
Power Pin |
| Power pin if the sensor is powered from an I/O pin. | |
|
|
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 - Injector 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 |
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - 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 |
|
|
Interrupt Pin |
| Interrupt pin from the sensor, checked when performing an update to see if the sensor has new data available. | |
|
|
Power Pin |
| Power pin if the sensor is powered from an I/O pin. | |
|
|
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 - Injector etc | |
