Difference between revisions of "Component: Magnetometer (SM324) (Movement Orientation)"

Latest revision as of 13:12, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	Movement Orientation

Magnetometer (SM324) component

SM324 ultraprecise 24-bit smart magnetometer capable of distance measurement using a magnet. Controlled via I2C bus communications.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Initialise

	Initialise
Sets up the I2C bus ready to communicate with the sensor IC. Sets the address variable back to the Address property value.
- VOID	Return

ReadMagneticFieldRaw

	ReadMagneticFieldRaw
Reads the magnetic field from the last succesful data read.
- LONG	Return

ReadMagneticFieldReal

	ReadMagneticFieldReal
Reads the magnetic field from the last succesful data read as a float in Oersted Oe.
- LONG	Return

ReadStatus

	ReadStatus
Reads the status byte from the sensor IC. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation
- BYTE	Return

ReadTemperatureRaw

	ReadTemperatureRaw
Reads the temperature from the last succesful data read.
- LONG	Return

ReadTemperatureReal

	ReadTemperatureReal
Reads the temperature from the last succesful data read as an float in degrees C.
- FLOAT	Return

RequestData

	RequestData
Requests temperature and magnetic data from the device, returns status. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation
- BYTE	Return

SetAddress

	SetAddress
Configures the device address used to communicate with sensor IC. Optionally writes the new address to the sensor IC NVM.
- BYTE	Address
The new address of the sensor IC, Range 8-127
- BOOL	WriteToIC
Writes the new address to the IC NVM 1=Write, 0=Don't Write
- VOID	Return

WriteCommand

	WriteCommand
Sends a command to the sensor IC.
- BYTE	Command

- VOID	Return

WriteMemory

	WriteMemory
Writes a 16-bit value to the specified memory location
- BYTE	Address
Internal memory address
- UINT	Value

- VOID	Return

Property reference

	Properties
	Sensor Properties
	Cyclic Mode

	I2C Properties
	Channel
Channel selection
	Address
Address of the SM324 IC, Default address is 16. Valid Address range = 8 to 127
	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.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Threshold Output
	Threshold Pin
The pins used to check the DOUT pin on the SM324,
	Threshold Setting
Controls the function of the sensor IC DOUT pin.
	Threshold1
Threshold 1 Value
	Threshold2
Threshold 2 value. If Thresh1 > Thresh2 1: Measurement > Thresh1 OR Measurement < Thresh2 0: Thresh1 > Measurement > Thresh2 If Thresh2 > Thresh1 1: Thresh1 > Measurement > Thresh2 0: Measurement > Thresh2 OR Measurement < Thresh1
	Simulation
	Simulate Comms

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Magnetometer_SM324.fcfx FC_Comp_Source_Magnetometer_SM324.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Magnetometer_SM324.fcfx FC_Comp_Source_Magnetometer_SM324.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Magnetometer_SM324.fcfx FC_Comp_Source_Magnetometer_SM324.fcfx]
 ==Detailed description==
@@ Line 36: / Line 48: @@
 ==Examples==
@@ Line 53: / Line 75: @@
-==Downloadable macro reference==
+==Macro reference==
+===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;" | '''ReadStatus'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Reads the status byte from the sensor IC. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation&nbsp;
+| colspan="2" | Sets up the I2C bus ready to communicate with the sensor IC. Sets the address variable back to the Address property value.&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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadMagneticFieldRaw===
 {| 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;" | '''WriteMemory'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadMagneticFieldRaw'''
 |-
-| colspan="2" | Writes a 16-bit value to the specified memory location&nbsp;
+| colspan="2" | Reads the magnetic field from the last succesful data read.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Address
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ReadMagneticFieldReal===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Internal memory address&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadMagneticFieldReal'''
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| colspan="2" | Reads the magnetic field from the last succesful data read as a float in Oersted Oe.&nbsp;
-| width="90%" | Value
 |-
-| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadStatus===
 {| 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;" | '''RequestData'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadStatus'''
 |-
-| colspan="2" | Requests temperature and magnetic data from the device, returns status. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation&nbsp;
+| colspan="2" | Reads the status byte from the sensor IC. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation&nbsp;
 |-
 |-
@@ Line 104: / Line 143: @@
+===ReadTemperatureRaw===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 117: / Line 157: @@
+===ReadTemperatureReal===
 {| 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;" | '''ReadMagneticFieldRaw'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTemperatureReal'''
 |-
-| colspan="2" | Reads the magnetic field from the last succesful data read.&nbsp;
+| colspan="2" | Reads the temperature from the last succesful data read as an float in degrees C.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===RequestData===
 {| 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;" | '''ReadMagneticFieldReal'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RequestData'''
 |-
-| colspan="2" | Reads the magnetic field from the last succesful data read as a float in Oersted Oe.&nbsp;
+| colspan="2" | Requests temperature and magnetic data from the device, returns status. Bit 6 = Voltage OK Bit 5 = Busy Bit 2 = Memory Error Bit 0 = Saturation&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| 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''
 |}
+===SetAddress===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 166: / Line 209: @@
+===WriteCommand===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 184: / Line 228: @@
+===WriteMemory===
 {| 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;" | '''ReadTemperatureReal'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteMemory'''
 |-
-| colspan="2" | Reads the temperature from the last succesful data read as an float in degrees C.&nbsp;
+| colspan="2" | Writes a 16-bit value to the specified memory location&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Address
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Internal memory address&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Sets up the I2C bus ready to communicate with the sensor IC. Sets the address variable back to the Address property value.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Value
 |-
+| colspan="2" | &nbsp;
 |-
 | 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''
 |}