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

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 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

	Read_Register
Reads a value from a register on the accelerometer.
- BYTE	Reg
Register address to read from
- BYTE	Return

	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
Register Address to Write to
- BYTE	Data
Value to write to the register
- 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

	Read_N_Registers
Reads a set of data values from sequential registers on the accelerometer
- BYTE	Start_Reg
First address to read data from
- BYTE	Num_Regs
Number of registers to read
- BYTE	data
Data variable to populate with the register values
- VOID	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.
	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
	Data Rate
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Connections
	Device Address
	I2C Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin
	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin
	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.
	Simulation
	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

==Macro reference==

	Read_Register
Reads a value from a register on the accelerometer.
- BYTE	Reg
Register address to read from
- BYTE	Return

	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
Register Address to Write to
- BYTE	Data
Value to write to the register
- 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

	Read_N_Registers
Reads a set of data values from sequential registers on the accelerometer
- BYTE	Start_Reg
First address to read data from
- BYTE	Num_Regs
Number of registers to read
- BYTE	data
Data variable to populate with the register values
- VOID	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.
	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
	Data Rate
	Int Option
Sets if we use the interrupt pin to check if new data is available
	Connections
	Device Address
	I2C Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin
	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin
	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.
	Simulation
	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