Difference between revisions of "Component: Quadrature Encoder 2D (General Input)"

Revision as of 12:00, 3 February 2023

Author	Matrix TSL
Version	1.4
Category	General Input

Quadrature Encoder 2D component

Quadrature Encoder component implements a rotary encoder connected to two pins. Quadrature Encoders provides incremental positioning rather than absolute positioning.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

CheckForChanges

	CheckForChanges
Polling function to check changes Returns 1 for chaged, 0 for no change, 255 for error
- BYTE	Return

Disable

	Disable
Disables the use of the quad encoder Once this ist called, the read functions will return zeros until the next Enable() call
- VOID	Return

Enable

	Enable
Enables the use of the quad encoder If this is not called, the read functions will return zeros
- VOID	Return

ReadCounter

	ReadCounter
Reads the current dial counter This is a counter from -32768 to 32767
- INT	Return

ReadCounter32

	ReadCounter32
Reads the current dial counter as a 32-bit value This is a counter from -2147483648 to 2147483647
- LONG	Return

ResetCounter

	ResetCounter
Resets the current dial counter to zero
- VOID	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

WriteCounter

	WriteCounter
Sets the value of the internal count variable. Range: -32768 to 32767
- INT	Value
Range: -32768 to 32767
- VOID	Return

WriteCounter32

	WriteCounter32
Sets the value of the internal count variable. Range: -2147483648 to 2147483647
- LONG	Value
Range: -2147483648 to 2147483647
- VOID	Return

Property reference

	Properties
	Count Variable
	Variable Type
Selects the size of the encoder count variable depending on the number of encoder counts required to be stored. The 16 bit variable counter is accessed via the ReadCounter and WriteCounter functions. The 32 bit variable counter is accessed via the ReadCounter32 and WriteCounter32 functions.
	Encoder Resolution
	Post Scaler
Encoders with a mechanical click will often have 4 transitions per click. 1:1 would provide the maximum output resolution. 1:4 would provide the encoder click count.
	Edges Per Revolution
Number of signal transitions per revolution. E.g. for a 360 degree encoder you would likely get 360 x 4 = 1440 transitions and an accuracy of 0.25 degrees.
	Resolution
The resolution of the encoder in degrees
	Connections
	A
Input pin A
	B
Input Pin B
	Simulation
	Repeat Rate
Simulated repeat rate when clicking and rotating the encoder
	Scope Traces

	Poiner Style

	Style

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Encoder_Quadrature_2dgi.fcfx FC_Comp_Source_Encoder_Quadrature_2dgi.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Encoder_Quadrature_2dgi.fcfx FC_Comp_Source_Encoder_Quadrature_2dgi.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx FC_Comp_Source_temp/Encoder_Quadrature_2dgi.fcfx]
 ==Detailed description==
@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 83: / Line 85: @@
-===WriteCounter32===
+===Enable===
 {| 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;" | '''WriteCounter32'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Enable'''
 |-
-| colspan="2" | Sets the value of the internal count variable. Range: -2147483648 to 2147483647&nbsp;
+| colspan="2" | Enables the use of the quad encoder If this is not called, the read functions will return zeros&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | Value
 |-
-| colspan="2" | Range: -2147483648 to 2147483647&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 102: / Line 99: @@
-===Enable===
+===ReadCounter===
 {| 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;" | '''Enable'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadCounter'''
 |-
-| colspan="2" | Enables the use of the quad encoder If this is not called, the read functions will return zeros&nbsp;
+| colspan="2" | Reads the current dial counter This is a counter from -32768 to 32767&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===Rotate===
+===ReadCounter32===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadCounter32'''
+|-
+| colspan="2" | Reads the current dial counter as a 32-bit value This is a counter from -2147483648 to 2147483647&nbsp;
+|-
 |-
-| 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" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ResetCounter===
+{| 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;" | '''ResetCounter'''
 |-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| colspan="2" | Resets the current dial counter to zero &nbsp;
-| 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
@@ Line 135: / Line 141: @@
-===ReadCounter===
+===Rotate===
 {| 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;" | '''ReadCounter'''
+| 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;
+|-
 |-
-| colspan="2" | Reads the current dial counter This is a counter from -32768 to 32767&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-s16-icon.png]] - INT
+| 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''
 |}
@@ Line 168: / Line 179: @@
-===ResetCounter===
+===WriteCounter32===
 {| 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;" | '''ResetCounter'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteCounter32'''
 |-
-| colspan="2" | Resets the current dial counter to zero &nbsp;
+| colspan="2" | Sets the value of the internal count variable. Range: -2147483648 to 2147483647&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Value
-|}
-===ReadCounter32===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | Range: -2147483648 to 2147483647&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadCounter32'''
 |-
-| colspan="2" | Reads the current dial counter as a 32-bit value This is a counter from -2147483648 to 2147483647&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}