Component: Magnetic Encoder (AS5600) (Magnetic)

From Flowcode Help
Revision as of 13:59, 10 June 2024 by Wiki bot (talk | contribs) (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Author Matrix TSL
Version 1.0
Category Magnetic


Magnetic Encoder (AS5600) component

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetStatus

Fc9-comp-macro.png GetStatus
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  
Fc9-u8-icon.png - BYTE Return


Initialise

Fc9-comp-macro.png 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 
Fc9-u8-icon.png - BYTE Return


ReadAngle

Fc9-comp-macro.png ReadAngle
Returns the angle as a floating point value between 0 and 360 degrees.  
Fc9-f32-icon.png - FLOAT Return


ReadRawAngle

Fc9-comp-macro.png ReadRawAngle
Returns the angle as a raw value between 0 and 4095 representing 0 to 360 degrees.  
Fc9-u16-icon.png - UINT Return


SetPowerMode

Fc9-comp-macro.png SetPowerMode
Configures the power mode of the device. 
Fc9-u8-icon.png - BYTE Mode
0=Always On, 1=5ms Polling, 2=20ms Polling, 3=100ms Polling 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Settings
Fc9-type-16-icon.png Hysteresis
 
Fc9-type-16-icon.png Output Stage
Controls the functionality of the OUT pin. 
Fc9-type-16-icon.png Slow Filter
 
Fc9-type-16-icon.png Fast Filter Threshold
 
Fc9-type-7-icon.png Watchdog
 
Fc9-conn-icon.png I2C Settings
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-16-icon.png SDA Remap Pin
 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-16-icon.png SCL Remap Pin
 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Sim Comms
 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 

Component Source Code

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