Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
pmod:pmodenc:reference-manual [2022/09/13 17:07] – changed forum.digilentinc.com to forum.digilent.com jeff.greenberg_ni.compmod:pmodenc:reference-manual [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Pmod ENC Reference Manual ======
 +The Digilent Pmod ENC (Revision A) features a rotary shaft encoder with an integral push-button to provide multiple types of outputs. The module also includes a sliding switch that is commonly used as an on/off output. An encoder is commonly used in freely rotating volume knobs to detect how many “clicks” a knob has been rotated.
 +
 +{{Digilent Image Gallery 
 +| image = {{:reference:pmod:pmodenc:pmodenc-0.png?direct |}}
 +| image = {{:reference:pmod:pmodenc:pmodenc-1.png?direct |}}
 +| image = {{:reference:pmod:pmodenc:pmodenc-2.png?direct |}}
 +| image = {{:reference:pmod:pmodenc:pmodenc-3.png?direct |}}
 +}} 
 +
 +== Download This Reference Manual == 
 +  * {{:reference:pmod:pmodenc:pmodenc_rm.pdf| PDF}}
 +
 +----
 +
 +===== Features =====
 +  * Rotary push-button shaft encoder 
 +  * Add multiple types of user input to host board or project
 +  * Additional static slide switch
 +  * 6-pin Pmod port with GPIO interface
 +
 +----
 +=====Functional Description =====
 +The %%Pmod ENC%% utilizes a rotary shaft encoder as a way for users to quickly switch between multiple options such as choices shown on a screen or predefined motors speeds. An integral push-button on the shaft as well as a slide switch allows for a highly configurable Pmod.
 +
 +----
 +===== Interfacing with the Pmod=====
 +The %%Pmod ENC%% communicates with the host board via the [[pmod:communication_protocols:gpio|GPIO protocol]]. It provides four inputs to the system board; the two buttons internal to the encoder that are in quadrature with each other as well as the integral push button on the shaft and the slide switch. A system board will read the integral push button and the slide switch at a logic low voltage in their native (or off in the case of the switch) states.
 +
 +The two internal buttons are both natively pulled to a logic high level through a pull-up resistor. As the two buttons are located 90 degrees from each other (i.e. in quadrature), while the shaft is rotating one button will be pulled to a low logic level voltage before the other button. 
 +
 +{{  :pmod:pmod:enc:pmodenc_quadrature.png?300  |Buttons A and B are in quadrature}}
 +
 +Users can program their system boards to determine which button was pulled low last (within a small time frame to ensure additional "clicks" are not also captured) in order to figure out which direction the shaft is being rotated.
 +
 +{{  :pmod:pmod:enc:pmodenc_buttontiming.png?300  |An example timing diagram of buttons A and B}}
 +
 +
 +==== Pinout Description Table ====
 +^  Pin  ^  Signal  ^  Description                                              ^
 +|  1    |  A       |  Output of button A in the encoder shaft                  |
 +|  2    |  B       |  Output of button B in the encoder shaft                  |
 +|  3    |  BTN     |  Output of the integral push button in the encoder shaft  |
 +|  4    |  SWT     |  Output of the on board switch                            |
 +|  5    |  GND     |  Power Supply Ground                                      |
 +|  6    |  VCC     |  Positive Power Supply (3.3/5V)                           |
 +
 +
 +
 +It is recommended that Pmod is operated at 3.3V or 5V, although because there are no integrated circuits on the Pmod, any voltage that your system board can handle as a digital input will work fine.
 +
 +----
 +===== Physical Dimensions =====
 +The pins on the pin header are spaced 100 mil apart. The PCB is 1.5 inches long on the sides parallel to the pins on the pin header and 0.8 inches long on the sides perpendicular to the pin header.
 +
 +----
 +===== Additional Information =====
 +The schematics of the %%Pmod ENC%% are available {{reference:pmod:pmodenc:pmodenc_sch.pdf|here}}. 
 +
 +Example code demonstrating how to get information from the %%Pmod ENC%% can be found [[pmod:pmodenc:start#example_projects|here]]. 
 +
 +If you have any questions or comments about the %%Pmod ENC%%, feel free to post them under the appropriate section ("Add-on Boards") of the [[https://forum.digilentinc.com/|Digilent Forum]].