Jump to content

Component: Grey Code Encoder 2D (General Input): Difference between revisions

From Flowcode Help
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(12 intermediate revisions by 2 users not shown)
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx FC_Comp_Source_Encoder_Grey_Code_2dgi.fcfx]


==Detailed description==
==Detailed description==




Line 28: Line 36:


==Examples==
==Examples==




Line 35: Line 49:
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Macro reference==


{| 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;" | '''ReadAbsoluteAngle'''
|-
| colspan="2" | Reads the absolute angular position of the motor. Returns a floating point value representing the angle of the encoder.&nbsp;
|-
|-
| 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''
|}




{| 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;" | '''Rotate'''
|-
| colspan="2" | Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Angle
|-
| colspan="2" | Amount to rotate the shaft input in degrees&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''
|}




{| 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;" | '''ReadAbsolutePosition'''
|-
| colspan="2" | Reads the absolute angular position of the motor. Returns an integer value representing the step position.&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''
|}








==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
==Macro reference==
 
===ReadAbsoluteAngle===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''ReadAbsoluteAngle'''
|-
|-
| colspan="2" | Reads the absolute angular position of the motor. Returns a floating point value representing the angle of the encoder.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Encoder Resolution
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | Output States
|}
|-
 
| colspan="2" | Number of unique output states&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Resolution
|-
| colspan="2" | The resolution of the encoder in degrees&nbsp;
|-
| 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%" | Number of Pins
|-
| colspan="2" | Sets the number of output pins on the encoder and hence the resolution of the encoder.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Pin0
|-
| colspan="2" | Input pin 0&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Pin1
|-
| colspan="2" | Input Pin 1&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Pin2
|-
| colspan="2" | Input Pin 2&nbsp;
|-
| 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-16-icon.png]]
| width="90%" | Repeat Rate
|-
| colspan="2" | Simulated repeat rate when clicking and rotating the encoder&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Poiner Style
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Style
|-
| colspan="2" | &nbsp;
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadAbsolutePosition===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAbsoluteAngle'''
| width="90%" class="mtx-class-macrohead" | '''ReadAbsolutePosition'''
|-
|-
| colspan="2" | Reads the absolute angular position of the motor. Returns a floating point value representing the angle of the encoder.&nbsp;
| colspan="2" | Reads the absolute angular position of the motor. Returns an integer value representing the step position.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Rotate===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Rotate'''
| width="90%" class="mtx-class-macrohead" | '''Rotate'''
|-
|-
| colspan="2" | Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component.&nbsp;
| colspan="2" | Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component.&nbsp;
Line 183: Line 106:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
{| 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;" | '''ReadAbsolutePosition'''
|-
| colspan="2" | Reads the absolute angular position of the motor. Returns an integer value representing the step position.&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''
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Encoder Resolution
| width="90%" class="mtx-class-propfolder" | Encoder Resolution
|-
|-
|-
|-
Line 222: Line 130:
| colspan="2" | The resolution of the encoder in degrees&nbsp;
| colspan="2" | The resolution of the encoder in degrees&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 246: Line 154:
| colspan="2" | Input Pin 2&nbsp;
| colspan="2" | Input Pin 2&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
|-
|-

Latest revision as of 14:37, 13 July 2026

Author Matrix TSL
Version 1.4
Category General Input


Grey Code Encoder 2D component

Grey Code Encoder component implements a rotary encoder connected to a defined number of pins Grey Code Encoders provide absolute positioning rather than incremental positioning.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

ReadAbsoluteAngle

ReadAbsoluteAngle
Reads the absolute angular position of the motor. Returns a floating point value representing the angle of the encoder. 
- FLOAT Return


ReadAbsolutePosition

ReadAbsolutePosition
Reads the absolute angular position of the motor. Returns an integer value representing the step position. 
- UINT Return


Rotate

Rotate
Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component. 
- FLOAT Angle
Amount to rotate the shaft input in degrees 
- VOID Return


Property reference

Properties
Encoder Resolution
Output States
Number of unique output states 
Resolution
The resolution of the encoder in degrees 
Connections
Number of Pins
Sets the number of output pins on the encoder and hence the resolution of the encoder. 
Pin0
Input pin 0 
Pin1
Input Pin 1 
Pin2
Input Pin 2 
Simulation
Repeat Rate
Simulated repeat rate when clicking and rotating the encoder 
Scope Traces
 
Poiner Style
 
Style