Difference between revisions of "Component: Magnetic Encoder (AS5600) (Magnetic)"

Latest revision as of 11:42, 26 November 2024

A precise magnetic encoder featuring 12-bit resolution and interfaced via an I2C bus.

No detailed description exists yet for this component

No additional examples

	GetStatus
Reads the status register testing for if the magnet is detected and in range. Bit2 = Magnet Detected, Bit1 = Magnet too weak, Bit0 = Magnet too strong Ideally the best response is 4, magnet detected and in range.
- BYTE	Return

	Initialise
Configures the I2C bus ready for communications and applies the settings defined in the properties. Also sets the default power level to always on. Returns 1 if the module is detected 0 if the module is not found
- BYTE	Return

	ReadAngle
Returns the angle as a floating point value between 0 and 360 degrees.
- FLOAT	Return

	ReadRawAngle
Returns the angle as a raw value between 0 and 4095 representing 0 to 360 degrees.
- UINT	Return

	SetPowerMode
Configures the power mode of the device.
- BYTE	Mode
0=Always On, 1=5ms Polling, 2=20ms Polling, 3=100ms Polling
- VOID	Return

	Properties
	Settings
	Hysteresis

	Output Stage
Controls the functionality of the OUT pin.
	Slow Filter

	Fast Filter Threshold

	Watchdog

	I2C Settings
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Connections
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin

	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin

	Simulation
	Sim Comms

	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API

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

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

@@ Line 31: / Line 31: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStatus'''
 |-
-| colspan="2" | Reads the status register testing for if the magnet is detected and in range. Bit0 = Magnet Detected Bit1 = Magnet too weak Bit2 = Magnet too strong &nbsp;
+| colspan="2" | Reads the status register testing for if the magnet is detected and in range. Bit2 = Magnet Detected, Bit1 = Magnet too weak, Bit0 = Magnet too strong Ideally the best response is 4, magnet detected and in range. &nbsp;
 |-
 |-