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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
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.
  
−
==[[File:Component Icon 0e4cb9c6_10d4_416f_bc27_5f8f7bc746b4.png|Image]] Grey Code Encoder component==
+
==Component Pack==
−
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==
+
MECHATRONICS
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>ReadAbsoluteAngle</tt></u></span>===
+
==Examples==
−
Reads the absolute angular position of the motor.
 
  
−
Returns a floating point value representing the angle of the encoder.
 
  
−
'''Parameters'''
+
''<span style="color:red;">No additional examples</span>''
  
−
:''This macro has no parameters''
 
  
 +
==Downloadable macro reference==
  
−
'''Return value'''
+
{| 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''
 +
|}
  
−
:[[Variable Types|FLOAT]]
 
  
 +
{| 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''
 +
|}
  
−
===<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.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAbsolutePosition'''
−
:''This macro has no parameters''
+
|-
−
 
+
| colspan="2" | Reads the absolute angular position of the motor. Returns an integer value representing the step position.&nbsp;
−
 
+
|-
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
−
:[[Variable Types|UINT]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
 
 
−
 
 
−
==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''
 
  
  
Line 77: Line 78:
  
 
==Property reference==
 
==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''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Number of unique output states
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<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''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Output States
−
The resolution of the encoder in degrees
+
|-
−
 
+
| colspan="2" | Number of unique output states&nbsp;
−
<span style="font-weight: normal;"><u>Number of Pins</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumPins''.
+
| width="90%" | Resolution
−
 
+
|-
−
Sets the number of output pins on the encoder and hence the resolution of the encoder.
+
| colspan="2" | The resolution of the encoder in degrees&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Pin0</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_0''.
+
|-
−
 
+
|-
−
Input pin 0
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Number of Pins
−
<span style="font-weight: normal;"><u>Pin1</u></span>
+
|-
−
 
+
| colspan="2" | Sets the number of output pins on the encoder and hence the resolution of the encoder.&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_1''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
Input Pin 1
+
| width="90%" | Pin0
−
 
+
|-
−
<span style="font-weight: normal;"><u>Pin2</u></span>
+
| colspan="2" | Input pin 0&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_2''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Pin1
−
Input Pin 2
+
|-
−
 
+
| colspan="2" | Input Pin 1&nbsp;
−
<span style="font-weight: normal;"><u>Repeat Rate</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''reprate''.
+
| width="90%" | Pin2
−
 
+
|-
−
Simulated repeat rate when clicking and rotating the encoder
+
| colspan="2" | Input Pin 2&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''.
+
|-
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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;
 +
|}

Revision as of 16:29, 7 January 2022

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 Pack

MECHATRONICS

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ReadAbsoluteAngle
Reads the absolute angular position of the motor. Returns a floating point value representing the angle of the encoder. 
Fc9-f32-icon.png - FLOAT Return


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


Fc9-comp-macro.png ReadAbsolutePosition
Reads the absolute angular position of the motor. Returns an integer value representing the step position. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Output States
Number of unique output states 
Fc9-type-15-icon.png Resolution
The resolution of the encoder in degrees 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Number of Pins
Sets the number of output pins on the encoder and hence the resolution of the encoder. 
Fc9-type-5-icon.png Pin0
Input pin 0 
Fc9-type-5-icon.png Pin1
Input Pin 1 
Fc9-type-5-icon.png Pin2
Input Pin 2 
Fc9-conn-icon.png Simulations
Fc9-type-16-icon.png Repeat Rate
Simulated repeat rate when clicking and rotating the encoder 
Fc9-type-7-icon.png Scope Traces
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Grey_Code_Encoder_(General_Input)&oldid=28111"