Component: Magnetometer 3-Axis (HMC5883L) (Movement Orientation): Difference between revisions

Revision as of 12:02, 3 February 2023

Author	Matrix TSL
Version	1.6
Category	Movement Orientation

Magnetometer 3-Axis (HMC5883L) component

HMC5883L 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_temp/Magnetometer_HMC5883.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Magnetometer_HMC5883.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.

HMC5883L Demo

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. Returns 0 for success and > 0 for fail.
- BYTE	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

	Measurement Mode
Continuous mode makes constant sensor readings setting the RDY pin when new data is available. Single mode does a single sensor read setting the RDY pin when done and then waits for data to be read.
	Num Samples
The number of samples that are averaged together to provide the readings.
	Compass Data Rate
Sets the output conversion rate.
	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 - Injector etc

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Magnetometer_HMC5883.fcfx FC_Comp_Source_Magnetometer_HMC5883.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Magnetometer_HMC5883.fcfx FC_Comp_Source_temp/Magnetometer_HMC5883.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Magnetometer_HMC5883.fcfx FC_Comp_Source_Magnetometer_HMC5883.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Magnetometer_HMC5883.fcfx FC_Comp_Source_temp/Magnetometer_HMC5883.fcfx]
 ==Detailed description==
@@ Line 76: / Line 76: @@
 {{Fcfile|HMC5883L.fcfx|HMC5883L Demo}}
@@ Line 83: / Line 85: @@
 ==Macro reference==
-===Read_Register===
+===CollectXYZData===
 {| 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;" | '''Read_Register'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CollectXYZData'''
 |-
-| colspan="2" | Reads a value from a register on the accelerometer.&nbsp;
+| 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%" | Reg
+| width="90%" | Axis
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
-===Write_Register===
+===Initialise===
 {| 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;" | '''Write_Register'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Writes a data value to a specific register on the accelerometer&nbsp;
+| 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" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Reg
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 126: / Line 118: @@
-===UpdateCompassData===
+===Read_Bearing===
 {| 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;" | '''UpdateCompassData'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 &nbsp;
+|-
 |-
-| colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumSamples
 |-
+| colspan="2" | The number of readings to base the bearing on&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===CollectXYZData===
+===Read_Register===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Read_Register'''
 |-
-| 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;
+| colspan="2" | Reads a value from a register on the accelerometer.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Axis
+| width="90%" | Reg
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| 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''
 |}
@@ Line 188: / Line 185: @@
-===Read_Bearing===
+===UpdateCompassData===
 {| 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;" | '''Read_Bearing'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UpdateCompassData'''
 |-
-| 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 &nbsp;
+| colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | NumSamples
-|-
-| colspan="2" | The number of readings to base the bearing on&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===Initialise===
+===Write_Register===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Write_Register'''
+|-
+| colspan="2" | Writes a data value to a specific register on the accelerometer&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Reg
+|-
+| colspan="2" | &nbsp;
 |-
-| 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" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE

Wiki bot (talk | contribs)