Component: Magnetometer 3-Axis (QMC5883L) (Movement Orientation): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 92: | Line 92: | ||
===CollectXYZData=== | ===CollectXYZData=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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 | | 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 | ||
| Line 111: | Line 111: | ||
===Initialise=== | ===Initialise=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Initialise''' | ||
|- | |- | ||
| colspan="2" | Sets up up the communication bus and initialises the accelerometer module. | | colspan="2" | Sets up up the communication bus and initialises the accelerometer module. | ||
| Line 125: | Line 125: | ||
===Read_Bearing=== | ===Read_Bearing=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Read_Bearing''' | ||
|- | |- | ||
| colspan="2" | 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 | | colspan="2" | 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 | ||
| Line 144: | Line 144: | ||
===Read_Register=== | ===Read_Register=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Read_Register''' | ||
|- | |- | ||
| colspan="2" | Reads a value from a register on the accelerometer. | | colspan="2" | Reads a value from a register on the accelerometer. | ||
| Line 163: | Line 163: | ||
===SimSetCompass=== | ===SimSetCompass=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SimSetCompass''' | ||
|- | |- | ||
| colspan="2" | Allows the XYZ slider values to be set via the simulation | | colspan="2" | Allows the XYZ slider values to be set via the simulation | ||
| Line 192: | Line 192: | ||
===UpdateCompassData=== | ===UpdateCompassData=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''UpdateCompassData''' | ||
|- | |- | ||
| colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data | | colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data | ||
| Line 206: | Line 206: | ||
===Write_Register=== | ===Write_Register=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Write_Register''' | ||
|- | |- | ||
| colspan="2" | Writes a data value to a specific register on the accelerometer | | colspan="2" | Writes a data value to a specific register on the accelerometer | ||
| Line 231: | Line 231: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 257: | Line 257: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 296: | Line 296: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix TSL |
| Version | 1.6 |
| Category | Movement Orientation |
Magnetometer 3-Axis (QMC5883L) component
QMC5883L 3-Axis Magnetometer sensor Useful for working out data such as compass orientation.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Magnetometer_QMC5883.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Magnetometer_QMC5883.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Here is a very simple demonstration on how to use the sensor to read X, Y, Z magnetometer data from the sensor.
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. | |
 - VOID
|
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_Register
|
|
Read_Register |
| Reads a value from a register on the accelerometer. | |
| - BYTE
|
Reg |
| - BYTE
|
Return |
SimSetCompass
|
|
SimSetCompass |
| Allows the XYZ slider values to be set via the simulation | |
| - INT
|
X |
| - INT
|
Y |
| - INT
|
Z |
| - VOID
|
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 |
Write_Register
|
|
Write_Register |
| Writes a data value to a specific register on the accelerometer | |
| - BYTE
|
Reg |
| - BYTE
|
Data |
| - BYTE
|
Return |
Property reference
|
Properties |
|
Bit Depth |
|
Compass Data Rate |
| Sets the output conversion rate. | |
|
|
Oversample Ratio |
|
|
Compass Scale |
|
Connections |
|
|
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) | |
|
|
Use RDY Pin |
|
|
Simulation |
|
|
Simulate Comms |
| Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the I2C CAL component - API etc | |