Component: Accelerometer 3-Axis (MMA8452Q) (Movement Orientation)

From Flowcode Help
Jump to navigationJump to search
Author Matrix Ltd.
Version 2.0
Category Movement Orientation


Accelerometer 3-Axis (MMA8452Q) component

MMA8452Q Accelerometer sensor with I2C. Useful for approximating Pitch and Roll or for detecting acceleration.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

CollectXYZData

Fc9-comp-macro.png 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 
Fc9-u8-icon.png - BYTE Axis
 
Fc9-s16-icon.png - INT Return


Initialise

Fc9-comp-macro.png Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail. 
Fc9-u8-icon.png - BYTE Return


Read_N_Registers

Fc9-comp-macro.png Read_N_Registers
Reads a set of data values from sequential registers on the accelerometer 
Fc9-u8-icon.png - BYTE Start_Reg
First address to read data from 
Fc9-u8-icon.png - BYTE Num_Regs
Number of registers to read 
Fc9-u8-icon.png - BYTE data
Data variable to populate with the register values 
Fc9-void-icon.png - VOID Return


Read_Register

Fc9-comp-macro.png Read_Register
Reads a value from a register on the accelerometer. 
Fc9-u8-icon.png - BYTE Reg
Register address to read from 
Fc9-u8-icon.png - BYTE Return


SimReset1G

Fc9-comp-macro.png SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal. 
Fc9-void-icon.png - VOID Return


SimSetXYZ

Fc9-comp-macro.png SimSetXYZ
Allows the XYZ slider values to be set via the simulation 
Fc9-s16-icon.png - INT X
 
Fc9-s16-icon.png - INT Y
 
Fc9-s16-icon.png - INT Z
 
Fc9-void-icon.png - VOID Return


UpdateXYZData

Fc9-comp-macro.png UpdateXYZData
Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data 
Fc9-u8-icon.png - BYTE Return


Write_Register

Fc9-comp-macro.png Write_Register
Writes a data value to a specific register on the accelerometer 
Fc9-u8-icon.png - BYTE Reg
Register Address to Write to 
Fc9-u8-icon.png - BYTE Data
Value to write to the register 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-14-icon.png Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings. 
Fc9-type-16-icon.png 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 
Fc9-type-16-icon.png Data Rate
 
Fc9-type-16-icon.png Int Option
Sets if we use the interrupt pin to check if new data is available 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Device Address
 
Fc9-conn-icon.png I2C Connections
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-16-icon.png SDA Remap Pin
 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-16-icon.png SCL Remap Pin
 
Fc9-type-7-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulate Comms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc