View source for Component: Magnetometer 3-Axis (HMC5883L) (Movement Orientation)

From Flowcode Help

← Component: Magnetometer 3-Axis (HMC5883L) (Movement Orientation)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.6 |- | width="20%" style="color:gray;" | 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: [https://www.flowcode.co.uk/wiki/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_Magnetometer_HMC5883.fcfx FC_Comp_Source_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. {{Fcfile|HMC5883L.fcfx|HMC5883L Demo}} ==Macro reference== ===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;" | '''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  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Axis |- | colspan="2" |   |- | 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'' |} ===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;" | '''Initialise''' |- | colspan="2" | Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.  |- |- | 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'' |} ===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;" | '''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   |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | NumSamples |- | colspan="2" | The number of readings to base the bearing on  |- | 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'' |} ===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;" | '''Read_Register''' |- | colspan="2" | Reads a value from a register on the accelerometer.  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Reg |- | colspan="2" |   |- | 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'' |} ===SimSetCompass=== {| 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;" | '''SimSetCompass''' |- | colspan="2" | Allows the XYZ slider values to be set via the simulation  |- |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | X |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Y |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | width="90%" | Z |- | colspan="2" |   |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===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;" | '''UpdateCompassData''' |- | colspan="2" | Reads from the compass and updates the local XYZ variables. Returns 1 for new data and 0 for no new data  |- |- | 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'' |} ===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;" | '''Write_Register''' |- | colspan="2" | Writes a data value to a specific register on the accelerometer  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Reg |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Data |- | colspan="2" |   |- | 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'' |} ==Property reference== {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |- | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' |- |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Bit Depth |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Measurement Mode |- | colspan="2" | 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.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Num Samples |- | colspan="2" | The number of samples that are averaged together to provide the readings.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Compass Data Rate |- | colspan="2" | Sets the output conversion rate.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Compass Scale |- | colspan="2" |   |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Channel |- | colspan="2" | Channel selection  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Baud Select |- | colspan="2" | Baud rate option selector  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Baud Rate |- | colspan="2" | Baud rate to be used  |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Stop Delay |- | colspan="2" | 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.   |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SDA |- | colspan="2" | Pin used for SDA (data signal)  |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SCL |- | colspan="2" | Pin used for SCL (clock signal)  |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Use RDY Pin |- | colspan="2" |   |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation |- |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Simulate Comms |- | colspan="2" | Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the I2C CAL component - Injector etc  |}

Return to Component: Magnetometer 3-Axis (HMC5883L) (Movement Orientation).