Jump to content

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

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix TSL
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.4 (Release)
| 1.4
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| General Input
| General Input
|}
|}




==Grey Code Encoder 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: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Encoder_Grey_Code.fcfx FC_Comp_Source_Encoder_Grey_Code.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.fcfx FC_Comp_Source_Encoder_Grey_Code.fcfx]


==[[File:Component Icon 0e4cb9c6_10d4_416f_bc27_5f8f7bc746b4.png|Image]] Grey Code Encoder component==
==Detailed description==
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.


==Examples==
''<span style="color:red;">No additional examples</span>''




==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>ReadAbsoluteAngle</tt></u></span>===
Reads the absolute angular position of the motor.


Returns a floating point value representing the angle of the encoder.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|FLOAT]]




===<span style="font-weight: normal;"><u><tt>ReadAbsolutePosition</tt></u></span>===
Reads the absolute angular position of the motor.


Returns an integer value representing the step position.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|UINT]]


''No detailed description exists yet for this component''
==Examples==




==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>Rotate</tt></u></span>===
Simulation Rotate function to allow accurate rotation during simulation.


Automatically called by any attached coupling or gearbox component.


'''Parameters'''


:[[Variable Types|FLOAT]] ''Angle''
::Amount to rotate the shaft input in degrees




'''Return value'''


:''This call does not return a value''








==Property reference==
<span style="font-weight: normal;"><u>Output States</u></span>


This property is of type ''Unsigned integer'' and can be referenced with the variable name ''OutputStates''.


Number of unique output states


<span style="font-weight: normal;"><u>Resolution</u></span>


This property is of type ''Floating point'' and can be referenced with the variable name ''Resolution''.


The resolution of the encoder in degrees


<span style="font-weight: normal;"><u>Number of Pins</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumPins''.
''<span style="color:red;">No additional examples</span>''


Sets the number of output pins on the encoder and hence the resolution of the encoder.


<span style="font-weight: normal;"><u>Pin0</u></span>


This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_0''.


Input pin 0


<span style="font-weight: normal;"><u>Pin1</u></span>


This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_1''.


Input Pin 1


<span style="font-weight: normal;"><u>Pin2</u></span>


This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_2''.


Input Pin 2


<span style="font-weight: normal;"><u>Repeat Rate</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''reprate''.
==Macro reference==


Simulated repeat rate when clicking and rotating the encoder
===ReadAbsoluteAngle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| 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="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===ReadAbsolutePosition===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}
 
 
===Rotate===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| 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;
|-
|-
| 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''
|}


<span style="font-weight: normal;"><u>Scope Traces</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''.
==Property reference==


''<span style="color:red;">No additional information</span>''
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''Properties'''
|-
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Encoder Resolution
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| 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" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | 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" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | 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;
|}

Latest revision as of 14:37, 13 July 2026

Author Matrix TSL
Version 1.4
Category General Input


Grey Code Encoder 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.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Encoder_Grey_Code.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
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Grey_Code_Encoder_(General_Input)&oldid=48114"