ahmsville/Magnetic_rotary_encoding131A library for setting up magnetic rotary encoding in C/C++ & MicroPython, The library also features a haptics controller which allows you to connect and control a vibration motor as a step count haptic feedback.
PICO DEV M3 KEYPAD is an open-source printed circuit board by ahmsville, from the ahmsville/Magnetic_rotary_encoding repository on GitHub, published under the GPL-3.0 licence. It is a 2-layer board of 147.8 × 133.6 mm with 50 parts on 41 nets, routed with 672 tracks and 52 vias.
Its parts include 15 resistors, 12 capacitors, 5 connectors and 1 IC. It belongs with the keyboards and input boards and the RP2040 boards of this library.
This is standalone encoder made to connect to a seperate microcontroller like an Arduino board, this version has a base resolution of 72, extendable up to 72000 steps per revolution.
This is standalone encoder similar to the first option, only with a small form factor, this version has a base resolution of 36, extendable up to 36000 steps per revolution.
This is a full fledged development board combined with the magnetic rotary encoder, its built with the Raspberry Pi RP2040 microcontroller chip with a base resolution of 36, extendable up to 36000 steps per revolution.
There are three ways to connect the magnetic rotary encoder, all with their benefits and draw backs.
in this mode the library uses just the signals from the hall effect sensors to make sense of the rotation of the encoder. the benefit of this mode is that you only need two analog pins to do all the rotation encoding, also been analog means you can use the libraries built in interpolation mode for an extremely high and granular resolution. The drawback is, this mode requires constant polling of the sensors which is not ideal for a complex system, also if the board does not have analog pins or if your setup cannot spare any of them, then you cannot use this mode.
To use this mode, simply connect ENC-1 and ENC-2 to two analog input pins, you may also connect the LED pin to any available pin on the board. VCC should be connected to the same voltage level used by the microcontroller on the boards, so power the encoder with 5v if the board uses 5v, and power it with 3.3v it the board uses 3.3v, you should offcus also connect the GND pin.
To test the example code, all you have to do is activate the analog only mode and change the pin assignment according to your connections. For the mode, you have the option to choose continuous rotation detection which returns a continuous count in either direction, or absolute positioning, which returns a value within the encoder’s base resolution, you can also choose the extended interpolated resolution mode for a super-duper high resolution.
#define ENCMODE 1 // BASE RESOLUTION ANALOG ONLY
//#define ENCMODE 2 // BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
//#define ENCMODE 3 // EXTENDED RESOLUTION ANALOG ONLY
//#define ENCMODE 4 // BASE RESOLUTION ANALOG AND DIGITAL
//#define ENCMODE 5 // BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
//#define ENCMODE 6 // EXTENDED RESOLUTION ANALOG AND DIGITAL
//#define ENCMODE 7 // BASE RESOLUTION DIGITAL ONLY
//#define ENCMODE 8 // BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONING#define E1_ADC_PIN 26 // ADC PIN for hall sensor 1
#define E2_ADC_PIN 27 // ADC PIN for hall sensor 2ENCMODE = 1 # BASE RESOLUTION ANALOG ONLY
#ENCMODE = 2 # BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
#ENCMODE = 3 # EXTENDED RESOLUTION ANALOG ONLY
#ENCMODE = 4 # BASE RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 5 # BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
#ENCMODE = 6 # EXTENDED RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 7 # BASE RESOLUTION DIGITAL ONLY
#ENCMODE = 8 # BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONINGE1_ADC_PIN = 26 # ADC PIN for hall sensor 1
E2_ADC_PIN = 27 # ADC PIN for hall sensor 2in this mode the library uses the signals from the hall effect sensors together with two additional digital interrupt enabled input pins. This mode has all the same features and benefits as the analog only detection mode without the need for constant polling of the hall effect sensors, this is extremely usefull for complex systems, as the interrupt pins notify the code of when a rotation occurs, so constant polling is not needed, this mode is in fact the mode used on the Ahmsville Dial V2. Please note that the code will return to constant polling if you select the Extended Resolution mode, since this process requires interpolation between the encoder’s steps.
To use this mode, simply connect ENC-1 and ENC-2 to two analog input pins, and E1-INT1 and E2-INT1 to two interrupt enabled pins on the board, you may also connect the LED pin to any available pins on the board. VCC should be connected to the same voltage level used by the microcontroller on the boards, so power the encoder with 5v if the board uses 5v, and power it with 3.3v it the board uses 3.3v, you should offcus also connect the GND pin.
Depending on your encoder version, you may also need to bridge the config pads on the PCB to use this mode.
To test the code, all you have to do is activate the analog and digital mode and also change the pin assignment according to your connections. For this mode, you also have the option to choose continuous rotation detection which returns a continuous count in either direction, or absolute positioning, which returns a value within the encoder’s base resolution, you can also choose the extended interpolated resolution mode for a super-duper high resolution.
//#define ENCMODE 1 // BASE RESOLUTION ANALOG ONLY
//#define ENCMODE 2 // BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
//#define ENCMODE 3 // EXTENDED RESOLUTION ANALOG ONLY
#define ENCMODE 4 // BASE RESOLUTION ANALOG AND DIGITAL
//#define ENCMODE 5 // BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
//#define ENCMODE 6 // EXTENDED RESOLUTION ANALOG AND DIGITAL
//#define ENCMODE 7 // BASE RESOLUTION DIGITAL ONLY
//#define ENCMODE 8 // BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONING#define E1_INT1 16 // hall sensor 1 interrupt pin 1
#define E2_INT1 18 // hall sensor 2 interrupt pin 1
#define E1_ADC_PIN 26 // ADC PIN for hall sensor 1
#define E2_ADC_PIN 27 // ADC PIN for hall sensor 2#ENCMODE = 1 # BASE RESOLUTION ANALOG ONLY
#ENCMODE = 2 # BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
#ENCMODE = 3 # EXTENDED RESOLUTION ANALOG ONLY
ENCMODE = 4 # BASE RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 5 # BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
#ENCMODE = 6 # EXTENDED RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 7 # BASE RESOLUTION DIGITAL ONLY
#ENCMODE = 8 # BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONINGE1_INT1 = 16 # hall sensor 1 interrupt pin 1
E2_INT1 = 18 # hall sensor 2 interrupt pin 1
E1_ADC_PIN = 26 # ADC PIN for hall sensor 1
E2_ADC_PIN = 27 # ADC PIN for hall sensor 2in this mode the library uses only digital interrupt enabled input pins; four of them. This mode is similar in operation to traditional rotary switches, the analog signals from the hall effect sensors have been converted to digital signals using comparators, so no analog input pins are required. This mode was developed for systems that don’t have or cannot spare analog input pins, its also the fastest mode and requires zero polling, which is why I used it to encode the Pick N Place Wheel. Because this mode uses digital signals alone, you cannot use the interpolated extended resolution mode that is available in the previous modes.
To use this mode, simply connect E1-INT1, E1-INT2, E2-INT1 and E2-INT2 to four interrupt enabled pins on the board, you may also connect the LED pin to any available pins on the board. VCC should be connected to the same voltage level used by the microcontroller on the boards, so power the encoder with 5v if the board uses 5v, and power it with 3.3v it the board uses 3.3v, also connect the GND pin.
To test the code, all you have to do is activate the digital only mode and also change the pin assignments according to your connections. For this mode, you have the option to choose continuous rotation detection which returns a continuous count in either direction, or absolute positioning, which returns a value within the encoder’s base resolution.
//#define ENCMODE 1 // BASE RESOLUTION ANALOG ONLY
//#define ENCMODE 2 // BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
//#define ENCMODE 3 // EXTENDED RESOLUTION ANALOG ONLY
//#define ENCMODE 4 // BASE RESOLUTION ANALOG AND DIGITAL
//#define ENCMODE 5 // BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
//#define ENCMODE 6 // EXTENDED RESOLUTION ANALOG AND DIGITAL
#define ENCMODE 7 // BASE RESOLUTION DIGITAL ONLY
//#define ENCMODE 8 // BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONING#define E1_INT1 16 // hall sensor 1 interrupt pin 1
#define E1_INT2 17 // hall sensor 1 interrupt pin 2
#define E2_INT1 18 // hall sensor 2 interrupt pin 1
#define E2_INT2 19 // hall sensor 2 interrupt pin 2#ENCMODE = 1 # BASE RESOLUTION ANALOG ONLY
#ENCMODE = 2 # BASE RESOLUTION ANALOG ONLY ABSOLUTE POSITIONING
#ENCMODE = 3 # EXTENDED RESOLUTION ANALOG ONLY
ENCMODE = 4 # BASE RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 5 # BASE RESOLUTION ANALOG AND DIGITAL ABSOLUTE POSITIONING
#ENCMODE = 6 # EXTENDED RESOLUTION ANALOG AND DIGITAL
#ENCMODE = 7 # BASE RESOLUTION DIGITAL ONLY
#ENCMODE = 8 # BASE RESOLUTION DIGITAL ONLY ABSOLUTE POSITIONINGE1_INT1 = 16 # hall sensor 1 interrupt pin 1
E1_INT2 = 17 # hall sensor 1 interrupt pin 2
E2_INT1 = 18 # hall sensor 2 interrupt pin 1
E2_INT2 = 19 # hall sensor 2 interrupt pin 2You have two options when it comes to complimentary input on the encoder, you can choose to use capacitive touch or a normal push button, both the capacitive touch and the push button will be included with the kit if you buy it from my store. To use capacitive touch, you will need an Arduino board, if you use other development boards like the ESP32 or Raspberry PI Pico, you will have to use the push button.
To use the capacitive touch on an Arduino, you must have assembled the encoder according to the instructions, so that you can simply connect CT1 and CT2 to two available pins and then update the pin assignment in the example code accordingly.
#define CT1 5 // CAPACITIVE TOUCH (CT1)
#define CT2 6 // CAPACITIVE TOUCH (CT2)To use the push button, you should solder the included button to the encoder board and then connect only CT1 to an available pin on the development board.
#define CT1 15 // PUSH BUTTON (CT1)CT1 = 15 # PUSH BUTTON (CT1)| Qty | Value | Footprint | References |
|---|---|---|---|
| 12 | 0.1uf | Capacitor_SMD:C_0603_1608Metric | C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12 |
| 12 | 5.1K | Resistor_SMD:R_0603_1608Metric | R3, R4, R5, R6, R7, R8, R9, R10, R11, R12, R13, R14 |
| 12 | Gateron_Switch | MY CUSTOM LIBRARY:GATERON SWITCH | MK1, MK2, MK3, MK4, MK5, MK6, MK7, MK8, MK9, MK10, MK11, MK12 |
| 3 | 1K | Resistor_SMD:R_0603_1608Metric | R1, R2, R15 |
| 3 | LOGO | LOGO | G***, G***, G*** |
| 1 | clipboard:35357825-467e-4df7-85c8-061ca90a2ec3 | ||
| 1 | Conn_01x02_Female | Connector_PinSocket_2.54mm:PinSocket_1x02_P2.54mm_Vertical | J2 |
| 1 | Conn_01x04_Female | Connector_PinSocket_2.54mm:PinSocket_1x04_P2.54mm_Vertical | J1 |
| 1 | Conn_01x05_Female | Connector_PinSocket_2.54mm:PinSocket_1x05_P2.54mm_Vertical | J4 |
| 1 | Conn_01x06_Female | Connector_PinSocket_2.54mm:PinSocket_1x06_P2.54mm_Vertical | J5 |
| 1 | Conn_01x08_Female | Connector_PinSocket_2.54mm:PinSocket_1x08_P2.54mm_Vertical | J3 |
| 1 | PICO_DEV_M3 | MY CUSTOM LIBRARY:PICO DEV M3 | U1 |
| 1 | RJ45_LED_Shielded | MY CUSTOM LIBRARY:RJ45_LED_SHIELDED | SERIAL_CONN1 |
ahmsville/Magnetic_rotary_encoding
A library for setting up magnetic rotary encoding in C/C++ & MicroPython, The library also features a haptics controller which allows you to connect and control a vibration motor as a step count haptic feedback.
hackclub/OnBoard
💡 Join 1,000 teenagers and make your first PCB with a $100 grant!
dmcke5/NucDeck
The Open Source DIY Handheld Gaming PC!
roarfred/AmsToMqttBridge
Minimalistic system to read AMS/HAN data from electrical meter
It measures 147.8 × 133.6 mm and has 2 copper layers, 1.6 mm thick.
50 parts. The full list of its parts is on this page, with links to each part's symbol and footprint where PCBKit's library has them.
From the ahmsville/Magnetic_rotary_encoding repository on GitHub, at the commit this page was made from: the board is PICO DEV M3/PICO DEV M3 KEYPAD/PICO DEV M3 KEYPAD.kicad_pcb and its schematic PICO DEV M3/PICO DEV M3 KEYPAD/KEYS.kicad_sch. PCBKit opens the board in the browser, with nothing to install.
Its repository publishes it under the GPL-3.0 licence: you may reuse it on that licence's terms (keep the author's notice, and for a copyleft licence share your changes alike).