Component: Quadrature Encoder (EBM007) (EBM Modules): Difference between revisions

Latest revision as of 13:09, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	EBM Modules

Quadrature Encoder component

Provides a rotary encoder with dual digital outputs that provide rotation and direction information. When connected to two digital inputs of a microcontroller a “digital pot” can be implemented to convert to digital values.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

This example scans the encoder for changes and displays a counter on the LCD based on the movement of the encoder.

EBM007 Example

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

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.
	Connections
	A
Input pin A
	B
Input Pin B
	Simulation
	Repeat Rate
Simulated repeat rate when clicking and rotating the encoder
	Rotation Increment
Number of degrees to rotate when performing a single quadrature pin transition.
	Scope Traces

@@ Line 60: / Line 60: @@
 {{Fcfile|EBM007 - Test Program.fcfx|EBM007 Example}}
@@ Line 66: / Line 74: @@
 ==Macro reference==
+===CheckForChanges===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 79: / Line 88: @@
+===Disable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 92: / Line 102: @@
+===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 110: / Line 116: @@
+===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''
 |}
+===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;" | '''ReadCounter'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadCounter32'''
 |-
-| colspan="2" | Reads the current dial counter This is a counter from -32768 to 32767&nbsp;
+| 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-s16-icon.png]] - INT
+| 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;" | '''WriteCounter'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ResetCounter'''
 |-
-| colspan="2" | Sets the value of the internal count variable. Range: -32768 to 32767&nbsp;
+| colspan="2" | Resets the current dial counter to zero &nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Value
 |-
-| colspan="2" | Range: -32768 to 32767&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 154: / Line 158: @@
+===WriteCounter===
 {| 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;" | '''WriteCounter'''
+|-
+| colspan="2" | Sets the value of the internal count variable. Range: -32768 to 32767&nbsp;
+|-
 |-
-| colspan="2" | Resets the current dial counter to zero &nbsp;
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="90%" | Value
 |-
+| colspan="2" | Range: -32768 to 32767&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 167: / Line 177: @@
+===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;" | '''ReadCounter32'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteCounter32'''
+|-
+| colspan="2" | Sets the value of the internal count variable. Range: -2147483648 to 2147483647&nbsp;
+|-
 |-
-| 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" | [[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-s32-icon.png]] - LONG
+| 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''
 |}

Wiki bot (talk | contribs)