keypad
– Support for scanning keys and key matrices
The keypad
module provides native support to scan sets of keys or buttons,
connected independently to individual pins,
connected to a shift register,
or connected in a row-and-column matrix.
For more information about working with the keypad
module in CircuitPython,
see this Learn guide.
Warning
Using pull-downs with keypad
on Raspberry Pi RP2350 A2 stepping has some limitations
due to a GPIO hardware issue that causes excessive leakage current (~120uA).
A pin can read as high even when driven or pulled low, if the input signal is high
impedance or if an attached pull-down resistor is too weak (has too high a value).
See the warning in digitalio
for more information.
Available on these boards
- class keypad.Event(key_number: int = 0, pressed: bool = True, timestamp: int | None = None)
A key transition event.
Create a key transition event, which reports a key-pressed or key-released transition.
- Parameters:
key_number (int) – The key number.
pressed (bool) –
True
if the key was pressed;False
if it was released.timestamp (int) – The time in milliseconds that the keypress occurred in the
supervisor.ticks_ms
time system. If specified as None, the current value ofsupervisor.ticks_ms
is used.
- pressed: bool
True
if the event represents a key down (pressed) transition. The opposite ofreleased
.
- released: bool
True
if the event represents a key up (released) transition. The opposite ofpressed
.
- class keypad.EventQueue
A queue of
Event
objects, filled by akeypad
scanner such asKeys
orKeyMatrix
.You cannot create an instance of
EventQueue
directly. Each scanner creates an instance when it is created.- get() Event | None
Return the next key transition event. Return
None
if no events are pending.Note that the queue size is limited; see
max_events
in the constructor of a scanner such asKeys
orKeyMatrix
. If a new event arrives when the queue is full, the event is discarded, andoverflowed
is set toTrue
.
- get_into(event: Event) bool
Store the next key transition event in the supplied event, if available, and return
True
. If there are no queued events, do not touchevent
and returnFalse
.The advantage of this method over
get()
is that it does not allocate storage. Instead you can reuse an existingEvent
object.Note that the queue size is limited; see
max_events
in the constructor of a scanner such asKeys
orKeyMatrix
.- Returns:
True
if an event was available and stored,False
if not.- Return type:
- clear() None
Clear any queued key transition events. Also sets
overflowed
toFalse
.
- class keypad.KeyMatrix(row_pins: Sequence[microcontroller.Pin], column_pins: Sequence[microcontroller.Pin], columns_to_anodes: bool = True, interval: float = 0.02, max_events: int = 64, debounce_threshold: int = 1)
Manage a 2D matrix of keys with row and column pins.
Available on these boards
- 01Space 0.42 OLED ESP32C3
- 0xCB Helios
- 42. Keebs Frood
- 8086 Commander
- 8086 USB Interposer
- AITHinker ESP32-C3S_Kit
- AITHinker ESP32-C3S_Kit_2M
- ARAMCON Badge 2019
- ARAMCON2 Badge
- ATMegaZero ESP32-S2
- Adafruit CLUE nRF52840 Express
- Adafruit Circuit Playground Bluefruit
- Adafruit EdgeBadge
- Adafruit Feather Bluefruit Sense
- Adafruit Feather ESP32 V2
- Adafruit Feather ESP32-C6 4MB Flash No PSRAM
- Adafruit Feather ESP32-S2 Reverse TFT
- Adafruit Feather ESP32-S2 TFT
- Adafruit Feather ESP32-S3 Reverse TFT
- Adafruit Feather ESP32-S3 TFT
- Adafruit Feather ESP32S2
- Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
- Adafruit Feather ESP32S3 No PSRAM
- Adafruit Feather HUZZAH32
- Adafruit Feather M4 CAN
- Adafruit Feather M4 Express
- Adafruit Feather MIMXRT1011
- Adafruit Feather RP2040
- Adafruit Feather RP2040 Adalogger
- Adafruit Feather RP2040 CAN
- Adafruit Feather RP2040 DVI
- Adafruit Feather RP2040 Prop-Maker
- Adafruit Feather RP2040 RFM
- Adafruit Feather RP2040 Scorpio
- Adafruit Feather RP2040 ThinkInk
- Adafruit Feather RP2040 USB Host
- Adafruit Feather RP2350
- Adafruit Feather STM32F405 Express
- Adafruit Feather nRF52840 Express
- Adafruit Floppsy RP2040
- Adafruit FunHouse
- Adafruit Grand Central M4 Express
- Adafruit HUZZAH32 Breakout
- Adafruit Hallowing M4 Express
- Adafruit ItsyBitsy ESP32
- Adafruit ItsyBitsy M4 Express
- Adafruit ItsyBitsy RP2040
- Adafruit ItsyBitsy nRF52840 Express
- Adafruit KB2040
- Adafruit LED Glasses Driver nRF52840
- Adafruit Macropad RP2040
- Adafruit MagTag
- Adafruit Matrix Portal M4
- Adafruit MatrixPortal S3
- Adafruit Metro ESP32S2
- Adafruit Metro ESP32S3
- Adafruit Metro M4 Airlift Lite
- Adafruit Metro M4 Express
- Adafruit Metro RP2040
- Adafruit Metro RP2350
- Adafruit Metro nRF52840 Express
- Adafruit PyGamer
- Adafruit PyPortal
- Adafruit PyPortal Pynt
- Adafruit PyPortal Titano
- Adafruit Pybadge
- Adafruit QT Py ESP32 PICO
- Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
- Adafruit QT Py ESP32-S3 no psram
- Adafruit QT Py ESP32C3
- Adafruit QT Py ESP32S2
- Adafruit QT Py RP2040
- Adafruit QT2040 Trinkey
- Adafruit Trellis M4 Express
- Adafruit Vindie S2
- Adafruit-Qualia-S3-RGB666
- Ai Thinker ESP32-CAM
- AloriumTech Evo M51
- Archi RP2040
- Arduino Nano 33 BLE
- Arduino Nano 33 BLE Rev2
- Arduino Nano ESP32
- Arduino Nano RP2040 Connect
- Artisense Reference Design RD00
- AtelierDuMaker nRF52840 Breakout
- AutosportLabs-ESP32-CAN-X2
- BARDUINO 4.0.2
- BBQ20KBD
- BDMICRO VINA-D51
- BLE-SS dev board Multi Sensor
- BLING!
- BLOK
- BPI-Bit-S2
- BPI-Leaf-S3
- BPI-PicoW-S3
- BastBLE
- BastWiFi
- Bee-Data-Logger
- Bee-Motion-S3
- Bee-S3
- BlizzardS3
- BlueMicro833
- BlueMicro840
- Bradán Lane STUDIO Explorer Badge
- COSMO-Pico
- CP32-M4
- CRCibernetica IdeaBoard
- Challenger NB RP2040 WiFi
- Challenger RP2040 LTE
- Challenger RP2040 LoRa
- Challenger RP2040 SD/RTC
- Challenger RP2040 SubGHz
- Challenger RP2040 WiFi
- Challenger RP2040 WiFi/BLE
- Challenger+ RP2350 BConnect
- Challenger+ RP2350 WiFi6/BLE5
- CircuitART Zero S3
- CircuitBrains Deluxe
- ColumbiaDSL-Sensor-Board-V1
- CrumpS2
- Cytron EDU PICO W
- Cytron IRIV IO Controller
- Cytron MOTION 2350 Pro
- Cytron Maker Feather AIoT S3
- Cytron Maker Nano RP2040
- Cytron Maker Pi RP2040
- Cytron Maker Uno RP2040
- DFRobot Beetle ESP32-C3
- DFRobot FireBeetle 2 ESP32-S3
- Datanoise PicoADK
- Datanoise PicoADK V2
- Deneyap Kart
- Deneyap Kart 1A
- Deneyap Kart 1A v2
- Deneyap Kart G
- Deneyap Mini
- Deneyap Mini v2
- Diodes Delight Piunora
- DynOSSAT-EDU-OBC
- E-Fidget
- ELECFREAKS PICO:ED
- ES3ink
- ESP 12k NodeMCU
- ESP32 Devkit V1
- ESP32-C3-DevKitM-1
- ESP32-C6-DevKitC-1-N8
- ESP32-C6-DevKitM-1
- ESP32-H2-DevKitM-1
- ESP32-P4-Function-EV
- ESP32-S2-DevKitC-1-N4
- ESP32-S2-DevKitC-1-N4R2
- ESP32-S2-DevKitC-1-N8R2
- ESP32-S3-Box-2.5
- ESP32-S3-Box-Lite
- ESP32-S3-DevKitC-1-N16
- ESP32-S3-DevKitC-1-N32R8
- ESP32-S3-DevKitC-1-N8
- ESP32-S3-DevKitC-1-N8R2
- ESP32-S3-DevKitC-1-N8R8
- ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
- ESP32-S3-DevKitM-1-N8
- ESP32-S3-EYE
- ESP32-S3-USB-OTG-N8
- ESP8684-DevKitC-02-N4
- Electrolama minik
- Electronut Labs Blip
- Electronut Labs Papyr
- EncoderPad RP2040
- Espressif ESP32 DevKitc V4 WROOM-32E
- Espressif ESP32 DevKitc V4 WROVER
- Espressif ESP32 TTGO T8 v1.7
- Espressif ESP32-LyraT
- Espressif-ESP32-S3-LCD-EV-Board
- Espressif-ESP32-S3-LCD-EV-Board_v1.5
- Espruino Bangle.js 2
- Espruino Wifi
- Feather MIMXRT1011
- Feather MIMXRT1062
- FeatherS2
- FeatherS2 Neo
- FeatherS2 PreRelease
- FeatherS3
- FeatherS3 Neo
- Fig Pi
- Flipper Zero Wi-Fi Dev
- Fomu
- Franzininho WIFI w/Wroom
- Franzininho WIFI w/Wrover
- Freenove ESP32-WROVER-DEV-CAM
- Gravitech Cucumber M
- Gravitech Cucumber MS
- Gravitech Cucumber R
- Gravitech Cucumber RS
- HEIA-FR Picomo V2
- HMI-DevKit-1.1
- Hack Club Sprig
- Hardkernel Odroid Go
- Heltec ESP32-S3-WIFI-LoRa-V3
- HexKyS2
- HiiBot BlueFi
- IMXRT1010-EVK
- IMXRT1015-EVK
- IkigaiSense Vita nRF52840
- IoTs2
- Kaluga 1
- LILYGO T-DECK
- LILYGO T-DISPLAY
- LILYGO T-DISPLAY S3 v1.2
- LILYGO T-Display S3 Pro
- LILYGO T-Watch-S3
- LILYGO TEMBED ESP32S3
- LILYGO TTGO T-01C3
- LILYGO TTGO T-DISPLAY v1.1
- LILYGO TTGO T-DISPLAY v1.1 4M
- LILYGO TTGO T-OI PLUS
- LILYGO TTGO T8 ESP32-S2
- LILYGO TTGO T8 ESP32-S2 w/Display
- LOLIN S3 16MB Flash 8MB PSRAM
- LOLIN S3 MINI 4MB Flash 2MB PSRAM
- LOLIN S3 PRO 16MB Flash 8MB PSRAM
- Lilygo T-watch 2020 V3
- Luatos Core-ESP32C3
- M5STACK STAMP-C3
- M5Stack Atom Echo
- M5Stack Atom Lite
- M5Stack Atom Matrix
- M5Stack Atom U
- M5Stack AtomS3
- M5Stack AtomS3 Lite
- M5Stack AtomS3U
- M5Stack Cardputer
- M5Stack Core Basic
- M5Stack Core Fire
- M5Stack Core2
- M5Stack CoreS3
- M5Stack Dial
- M5Stack M5Paper
- M5Stack Stick C
- M5Stack Stick C Plus
- M5Stack Timer Camera X
- MDBT50Q-DB-40
- MDBT50Q-RX Dongle
- MEOWBIT
- MORPHEANS MorphESP-240
- MagiClick S3 N4R2
- Maker Go ESP32C3 Supermini
- Maker Go ESP32C6 Supermini
- Maker badge by Czech maker
- MakerDiary nRF52840 MDK
- MakerDiary nRF52840 MDK USB Dongle
- MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
- Makerdiary M60 Keyboard
- Makerdiary Pitaya Go
- Makerdiary nRF52840 Connect Kit
- Makerdiary nRF52840 M.2 Developer Kit
- Maple Computing Elite-Pi
- Melopero Shake RP2040
- Metro MIMXRT1011
- MicroDev microC3
- MicroDev microS2
- Mini SAM M4
- MixGo CE
- NUCLEO STM32F746
- NUCLEO STM32F767
- NUCLEO STM32H743
- NanoS3
- Neuron
- NodeMcu-ESP32-C2
- OMGS3
- OPENMV-H7 R1
- Oak Dev Tech BREAD2040
- Oak Dev Tech Cast-Away RP2040
- Oak Dev Tech PixelWing ESP32S2
- Oak Dev Tech RPGA Feather
- Open Hardware Summit 2020 Badge
- Oxocard Artwork
- Oxocard Connect
- Oxocard Galaxy
- Oxocard Science
- P1AM-200
- PCA10056 nRF52840-DK
- PCA10059 nRF52840 Dongle
- PYB LR Nano V2
- Pajenicko PicoPad
- Particle Argon
- Particle Boron
- Particle Xenon
- PillBug
- Pimoroni Badger 2040
- Pimoroni Badger 2040 W
- Pimoroni Inky Frame 5.7
- Pimoroni Inky Frame 7.3
- Pimoroni Interstate 75
- Pimoroni Keybow 2040
- Pimoroni Motor 2040
- Pimoroni PGA2040
- Pimoroni PGA2350
- Pimoroni Pico DV Base W
- Pimoroni Pico LiPo (16MB)
- Pimoroni Pico LiPo (4MB)
- Pimoroni Pico Plus 2
- Pimoroni Pico dv Base
- Pimoroni PicoSystem
- Pimoroni Plasma 2040
- Pimoroni Plasma 2040W
- Pimoroni Plasma 2350
- Pimoroni Servo 2040
- Pimoroni Tiny 2040 (2MB)
- Pimoroni Tiny 2040 (8MB)
- Pimoroni Tiny 2350
- Pimoroni Tiny FX
- ProS3
- PyKey 18 Numpad
- PyKey 44 Ergo
- PyKey 60
- PyKey 87 TKL
- PyboardV1_1
- RF.Guru RP2040
- RGBTouch Mini
- RP2.65-F
- RP2040 Stamp
- RP2350 Stamp
- RP2350 Stamp XL
- Raspberry Breadstick
- Raspberry Pi 4B
- Raspberry Pi Compute Module 4
- Raspberry Pi Compute Module 4 IO Board
- Raspberry Pi Pico
- Raspberry Pi Pico 2
- Raspberry Pi Pico W
- Raspberry Pi Zero
- Raspberry Pi Zero 2W
- Raspberry Pi Zero W
- Robo HAT MM1 M4
- S2Mini
- S2Pico
- SAM E54 Xplained Pro
- SAM32v26
- SQFMI Watchy
- SSCI ISP1807 Dev Board
- SSCI ISP1807 Micro Board
- ST STM32F746G Discovery
- STM32F411E_DISCO
- STM32F412G_DISCO
- STM32F4_DISCO
- Saola 1 w/Wroom
- Saola 1 w/Wrover
- Seeed Studio XIAO ESP32C3
- Seeed XIAO nRF52840 Sense
- Seeed Xiao ESP32-C6 4MB Flash 512KB SRAM
- Seeed Xiao ESP32-S3 Sense
- Seeeduino Wio Terminal
- Seeeduino XIAO KB
- Seeeduino XIAO RP2040
- Seeeduino XIAO RP2350
- Silicognition LLC M4-Shim
- Silicognition LLC RP2040-Shim
- SparkFun MicroMod RP2040 Processor
- SparkFun MicroMod SAMD51 Processor
- SparkFun MicroMod nRF52840 Processor
- SparkFun Pro Micro RP2040
- SparkFun Pro Micro RP2350
- SparkFun Pro nRF52840 Mini
- SparkFun STM32 MicroMod Processor
- SparkFun Teensy MicroMod Processor
- SparkFun Thing Plus - RP2040
- SparkFun Thing Plus - SAMD51
- SparkFun Thing Plus - STM32
- Spotpear ESP32C3 LCD 1.44
- Sunton ESP32-2424S012
- Sunton-ESP32-8048S050
- Sunton-ESP32-8048S070
- SuperMini NRF52840
- Swan R5
- TG-Boards' Datalore IP M4
- TG-Watch
- THUNDERPACK_v11
- THUNDERPACK_v12
- TTGO T8 ESP32-S2-WROOM
- Targett Module Clip w/Wroom
- Targett Module Clip w/Wrover
- Teensy 4.0
- Teensy 4.1
- Teknikio Bluebird
- The Open Book Feather
- ThingPulse Pendrive S3
- TinkeringTech ScoutMakes Azul
- TinyC6
- TinyPICO
- TinyPICO Nano
- TinyS2
- TinyS3
- TinyWATCH S3
- UARTLogger II
- VCC-GND Studio YD RP2040
- VCC-GND YD-ESP32-S3 (N16R8)
- VCC-GND YD-ESP32-S3 (N8R8)
- VIDI X V1.1
- W5100S-EVB-Pico
- W5500-EVB-Pico
- WK-50 Trackball Keyboard
- WSC-1450
- WarmBit BluePixel nRF52840
- Waveshare ESP32-S2-Pico
- Waveshare ESP32-S2-Pico-LCD
- Waveshare ESP32-S3-GEEK
- Waveshare ESP32-S3-Pico
- Waveshare ESP32-S3-Tiny
- Waveshare ESP32-S3-Zero
- Waveshare ESP32S3 LCD 1.28
- Waveshare RP2040-GEEK
- Waveshare RP2040-LCD-0.96
- Waveshare RP2040-LCD-1.28
- Waveshare RP2040-One
- Waveshare RP2040-PiZero
- Waveshare RP2040-Plus (16MB)
- Waveshare RP2040-Plus (4MB)
- Waveshare RP2040-TOUCH-LCD-1.28
- Waveshare RP2040-Tiny
- Waveshare RP2040-Zero
- WeAct ESP32-C6 (4MB)
- WeAct ESP32-C6 (8MB)
- WeAct Studio Pico
- WeAct Studio Pico 16MB
- WeMos LOLIN32 Lite
- Wemos Lolin C3 Mini
- Wemos Lolin C3 Pico
- WisdPi Ardu2040M
- WisdPi Tiny RP2040
- iLabs Challenger 840
- iMX RT 1020 EVK
- iMX RT 1040 EVK
- iMX RT 1050 EVKB
- iMX RT 1060 EVK
- iMX RT 1060 EVKB
- iMX RT1011 Nano Kit
- nanoESP32-S2 w/Wrover
- nanoESP32-S2 w/Wroom
- nice!nano
- nullbits Bit-C PRO
- senseBox MCU-S2 ESP32S2
- splitkb.com Liatris
- stm32f411ce-blackpill
- stm32f411ce-blackpill-with-flash
- sunton_esp32_2432S028
- sunton_esp32_2432S032C
- takayoshiotake Octave RP2040
- uGame10
- uGame22
Create a
Keys
object that will scan the key matrix attached to the given row and column pins. There should not be any external pull-ups or pull-downs on the matrix:KeyMatrix
enables internal pull-ups or pull-downs on the pins as necessary.The keys are numbered sequentially from zero. A key number can be computed by
row * len(column_pins) + column
.An
EventQueue
is created when this object is created and is available in theevents
attribute.- Parameters:
row_pins (Sequence[microcontroller.Pin]) – The pins attached to the rows.
column_pins (Sequence[microcontroller.Pin]) – The pins attached to the columns.
columns_to_anodes (bool) – Default
True
. If the matrix uses diodes, the diode anodes are typically connected to the column pins, and the cathodes should be connected to the row pins. If your diodes are reversed, setcolumns_to_anodes
toFalse
.interval (float) – Scan keys no more often than
interval
to allow for debouncing.interval
is in float seconds. The default is 0.020 (20 msecs).max_events (int) – maximum size of
events
EventQueue
: maximum number of key transition events that are saved. Must be >= 1. If a new event arrives when the queue is full, the oldest event is discarded.debounce_threshold (int) – Emit events for state changes only after a key has been in the respective state for
debounce_threshold
times on average. Successive measurements are spaced apart byinterval
seconds. The default is 1, which resolves immediately. The maximum is 127.
- __exit__() None
Automatically deinitializes when exiting a context. See Lifetime and ContextManagers for more info.
- reset() None
Reset the internal state of the scanner to assume that all keys are now released. Any key that is already pressed at the time of this call will therefore immediately cause a new key-pressed event to occur.
- key_number_to_row_column(key_number: int) Tuple[int]
Return the row and column for the given key number. The row is
key_number // len(column_pins)
. The column iskey_number % len(column_pins)
.- Returns:
(row, column)
- Return type:
Tuple[int]
- row_column_to_key_number(row: int, column: int) int
Return the key number for a given row and column. The key number is
row * len(column_pins) + column
.
- events: EventQueue
The
EventQueue
associated with thisKeys
object. (read-only)
- class keypad.Keys(pins: Sequence[microcontroller.Pin], *, value_when_pressed: bool, pull: bool = True, interval: float = 0.02, max_events: int = 64, debounce_threshold: int = 1)
Manage a set of independent keys.
Available on these boards
- 01Space 0.42 OLED ESP32C3
- 0xCB Helios
- 42. Keebs Frood
- 8086 Commander
- 8086 USB Interposer
- AITHinker ESP32-C3S_Kit
- AITHinker ESP32-C3S_Kit_2M
- ARAMCON Badge 2019
- ARAMCON2 Badge
- ATMegaZero ESP32-S2
- Adafruit CLUE nRF52840 Express
- Adafruit Circuit Playground Bluefruit
- Adafruit EdgeBadge
- Adafruit Feather Bluefruit Sense
- Adafruit Feather ESP32 V2
- Adafruit Feather ESP32-C6 4MB Flash No PSRAM
- Adafruit Feather ESP32-S2 Reverse TFT
- Adafruit Feather ESP32-S2 TFT
- Adafruit Feather ESP32-S3 Reverse TFT
- Adafruit Feather ESP32-S3 TFT
- Adafruit Feather ESP32S2
- Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
- Adafruit Feather ESP32S3 No PSRAM
- Adafruit Feather HUZZAH32
- Adafruit Feather M4 CAN
- Adafruit Feather M4 Express
- Adafruit Feather MIMXRT1011
- Adafruit Feather RP2040
- Adafruit Feather RP2040 Adalogger
- Adafruit Feather RP2040 CAN
- Adafruit Feather RP2040 DVI
- Adafruit Feather RP2040 Prop-Maker
- Adafruit Feather RP2040 RFM
- Adafruit Feather RP2040 Scorpio
- Adafruit Feather RP2040 ThinkInk
- Adafruit Feather RP2040 USB Host
- Adafruit Feather RP2350
- Adafruit Feather STM32F405 Express
- Adafruit Feather nRF52840 Express
- Adafruit Floppsy RP2040
- Adafruit FunHouse
- Adafruit Grand Central M4 Express
- Adafruit HUZZAH32 Breakout
- Adafruit Hallowing M4 Express
- Adafruit ItsyBitsy ESP32
- Adafruit ItsyBitsy M4 Express
- Adafruit ItsyBitsy RP2040
- Adafruit ItsyBitsy nRF52840 Express
- Adafruit KB2040
- Adafruit LED Glasses Driver nRF52840
- Adafruit Macropad RP2040
- Adafruit MagTag
- Adafruit Matrix Portal M4
- Adafruit MatrixPortal S3
- Adafruit Metro ESP32S2
- Adafruit Metro ESP32S3
- Adafruit Metro M4 Airlift Lite
- Adafruit Metro M4 Express
- Adafruit Metro RP2040
- Adafruit Metro RP2350
- Adafruit Metro nRF52840 Express
- Adafruit PyGamer
- Adafruit PyPortal
- Adafruit PyPortal Pynt
- Adafruit PyPortal Titano
- Adafruit Pybadge
- Adafruit QT Py ESP32 PICO
- Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
- Adafruit QT Py ESP32-S3 no psram
- Adafruit QT Py ESP32C3
- Adafruit QT Py ESP32S2
- Adafruit QT Py RP2040
- Adafruit QT2040 Trinkey
- Adafruit TRRS Trinkey M0
- Adafruit Trellis M4 Express
- Adafruit Vindie S2
- Adafruit-Qualia-S3-RGB666
- Ai Thinker ESP32-CAM
- AloriumTech Evo M51
- Archi RP2040
- Arduino Nano 33 BLE
- Arduino Nano 33 BLE Rev2
- Arduino Nano ESP32
- Arduino Nano RP2040 Connect
- Artisense Reference Design RD00
- AtelierDuMaker nRF52840 Breakout
- AutosportLabs-ESP32-CAN-X2
- BARDUINO 4.0.2
- BBQ20KBD
- BDMICRO VINA-D51
- BLE-SS dev board Multi Sensor
- BLING!
- BLOK
- BPI-Bit-S2
- BPI-Leaf-S3
- BPI-PicoW-S3
- BastBLE
- BastWiFi
- Bee-Data-Logger
- Bee-Motion-S3
- Bee-S3
- BlizzardS3
- BlueMicro833
- BlueMicro840
- Bradán Lane STUDIO Explorer Badge
- COSMO-Pico
- CP32-M4
- CRCibernetica IdeaBoard
- Challenger NB RP2040 WiFi
- Challenger RP2040 LTE
- Challenger RP2040 LoRa
- Challenger RP2040 SD/RTC
- Challenger RP2040 SubGHz
- Challenger RP2040 WiFi
- Challenger RP2040 WiFi/BLE
- Challenger+ RP2350 BConnect
- Challenger+ RP2350 WiFi6/BLE5
- CircuitART Zero S3
- CircuitBrains Deluxe
- ColumbiaDSL-Sensor-Board-V1
- CrumpS2
- Cytron EDU PICO W
- Cytron IRIV IO Controller
- Cytron MOTION 2350 Pro
- Cytron Maker Feather AIoT S3
- Cytron Maker Nano RP2040
- Cytron Maker Pi RP2040
- Cytron Maker Uno RP2040
- DFRobot Beetle ESP32-C3
- DFRobot FireBeetle 2 ESP32-S3
- Datanoise PicoADK
- Datanoise PicoADK V2
- Deneyap Kart
- Deneyap Kart 1A
- Deneyap Kart 1A v2
- Deneyap Kart G
- Deneyap Mini
- Deneyap Mini v2
- Diodes Delight Piunora
- DynOSSAT-EDU-OBC
- E-Fidget
- ELECFREAKS PICO:ED
- ES3ink
- ESP 12k NodeMCU
- ESP32 Devkit V1
- ESP32-C3-DevKitM-1
- ESP32-C6-DevKitC-1-N8
- ESP32-C6-DevKitM-1
- ESP32-H2-DevKitM-1
- ESP32-P4-Function-EV
- ESP32-S2-DevKitC-1-N4
- ESP32-S2-DevKitC-1-N4R2
- ESP32-S2-DevKitC-1-N8R2
- ESP32-S3-Box-2.5
- ESP32-S3-Box-Lite
- ESP32-S3-DevKitC-1-N16
- ESP32-S3-DevKitC-1-N32R8
- ESP32-S3-DevKitC-1-N8
- ESP32-S3-DevKitC-1-N8R2
- ESP32-S3-DevKitC-1-N8R8
- ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
- ESP32-S3-DevKitM-1-N8
- ESP32-S3-EYE
- ESP32-S3-USB-OTG-N8
- ESP8684-DevKitC-02-N4
- Electrolama minik
- Electronut Labs Blip
- Electronut Labs Papyr
- EncoderPad RP2040
- Espressif ESP32 DevKitc V4 WROOM-32E
- Espressif ESP32 DevKitc V4 WROVER
- Espressif ESP32 TTGO T8 v1.7
- Espressif ESP32-LyraT
- Espressif-ESP32-S3-LCD-EV-Board
- Espressif-ESP32-S3-LCD-EV-Board_v1.5
- Espruino Bangle.js 2
- Espruino Wifi
- Feather MIMXRT1011
- Feather MIMXRT1062
- FeatherS2
- FeatherS2 Neo
- FeatherS2 PreRelease
- FeatherS3
- FeatherS3 Neo
- Fig Pi
- Flipper Zero Wi-Fi Dev
- Fomu
- Franzininho WIFI w/Wroom
- Franzininho WIFI w/Wrover
- Freenove ESP32-WROVER-DEV-CAM
- Gravitech Cucumber M
- Gravitech Cucumber MS
- Gravitech Cucumber R
- Gravitech Cucumber RS
- HEIA-FR Picomo V2
- HMI-DevKit-1.1
- Hack Club Sprig
- Hardkernel Odroid Go
- Heltec ESP32-S3-WIFI-LoRa-V3
- HexKyS2
- HiiBot BlueFi
- IMXRT1010-EVK
- IMXRT1015-EVK
- IkigaiSense Vita nRF52840
- IoTs2
- Kaluga 1
- LILYGO T-DECK
- LILYGO T-DISPLAY
- LILYGO T-DISPLAY S3 v1.2
- LILYGO T-Display S3 Pro
- LILYGO T-Watch-S3
- LILYGO TEMBED ESP32S3
- LILYGO TTGO T-01C3
- LILYGO TTGO T-DISPLAY v1.1
- LILYGO TTGO T-DISPLAY v1.1 4M
- LILYGO TTGO T-OI PLUS
- LILYGO TTGO T8 ESP32-S2
- LILYGO TTGO T8 ESP32-S2 w/Display
- LOLIN S3 16MB Flash 8MB PSRAM
- LOLIN S3 MINI 4MB Flash 2MB PSRAM
- LOLIN S3 PRO 16MB Flash 8MB PSRAM
- Lilygo T-watch 2020 V3
- Luatos Core-ESP32C3
- M5STACK STAMP-C3
- M5Stack Atom Echo
- M5Stack Atom Lite
- M5Stack Atom Matrix
- M5Stack Atom U
- M5Stack AtomS3
- M5Stack AtomS3 Lite
- M5Stack AtomS3U
- M5Stack Cardputer
- M5Stack Core Basic
- M5Stack Core Fire
- M5Stack Core2
- M5Stack CoreS3
- M5Stack Dial
- M5Stack M5Paper
- M5Stack Stick C
- M5Stack Stick C Plus
- M5Stack Timer Camera X
- MDBT50Q-DB-40
- MDBT50Q-RX Dongle
- MEOWBIT
- MORPHEANS MorphESP-240
- MagiClick S3 N4R2
- Maker Go ESP32C3 Supermini
- Maker Go ESP32C6 Supermini
- Maker badge by Czech maker
- MakerDiary nRF52840 MDK
- MakerDiary nRF52840 MDK USB Dongle
- MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
- Makerdiary M60 Keyboard
- Makerdiary Pitaya Go
- Makerdiary nRF52840 Connect Kit
- Makerdiary nRF52840 M.2 Developer Kit
- Maple Computing Elite-Pi
- Melopero Shake RP2040
- Metro MIMXRT1011
- MicroDev microC3
- MicroDev microS2
- Mini SAM M4
- MixGo CE
- NUCLEO STM32F746
- NUCLEO STM32F767
- NUCLEO STM32H743
- NanoS3
- Neuron
- NodeMcu-ESP32-C2
- OMGS3
- OPENMV-H7 R1
- Oak Dev Tech BREAD2040
- Oak Dev Tech Cast-Away RP2040
- Oak Dev Tech PixelWing ESP32S2
- Oak Dev Tech RPGA Feather
- Open Hardware Summit 2020 Badge
- Oxocard Artwork
- Oxocard Connect
- Oxocard Galaxy
- Oxocard Science
- P1AM-200
- PCA10056 nRF52840-DK
- PCA10059 nRF52840 Dongle
- PYB LR Nano V2
- Pajenicko PicoPad
- Particle Argon
- Particle Boron
- Particle Xenon
- PewPew LCD
- PewPew M4
- PillBug
- Pimoroni Badger 2040
- Pimoroni Badger 2040 W
- Pimoroni Inky Frame 5.7
- Pimoroni Inky Frame 7.3
- Pimoroni Interstate 75
- Pimoroni Keybow 2040
- Pimoroni Motor 2040
- Pimoroni PGA2040
- Pimoroni PGA2350
- Pimoroni Pico DV Base W
- Pimoroni Pico LiPo (16MB)
- Pimoroni Pico LiPo (4MB)
- Pimoroni Pico Plus 2
- Pimoroni Pico dv Base
- Pimoroni PicoSystem
- Pimoroni Plasma 2040
- Pimoroni Plasma 2040W
- Pimoroni Plasma 2350
- Pimoroni Servo 2040
- Pimoroni Tiny 2040 (2MB)
- Pimoroni Tiny 2040 (8MB)
- Pimoroni Tiny 2350
- Pimoroni Tiny FX
- ProS3
- PyKey 18 Numpad
- PyKey 44 Ergo
- PyKey 60
- PyKey 87 TKL
- PyboardV1_1
- RF.Guru RP2040
- RGBTouch Mini
- RP2.65-F
- RP2040 Stamp
- RP2350 Stamp
- RP2350 Stamp XL
- Raspberry Breadstick
- Raspberry Pi 4B
- Raspberry Pi Compute Module 4
- Raspberry Pi Compute Module 4 IO Board
- Raspberry Pi Pico
- Raspberry Pi Pico 2
- Raspberry Pi Pico W
- Raspberry Pi Zero
- Raspberry Pi Zero 2W
- Raspberry Pi Zero W
- Robo HAT MM1 M4
- S2Mini
- S2Pico
- SAM E54 Xplained Pro
- SAM32v26
- SQFMI Watchy
- SSCI ISP1807 Dev Board
- SSCI ISP1807 Micro Board
- ST STM32F746G Discovery
- STM32F411E_DISCO
- STM32F412G_DISCO
- STM32F4_DISCO
- Saola 1 w/Wroom
- Saola 1 w/Wrover
- Seeed Studio XIAO ESP32C3
- Seeed XIAO nRF52840 Sense
- Seeed Xiao ESP32-C6 4MB Flash 512KB SRAM
- Seeed Xiao ESP32-S3 Sense
- Seeeduino Wio Terminal
- Seeeduino XIAO KB
- Seeeduino XIAO RP2040
- Seeeduino XIAO RP2350
- Silicognition LLC M4-Shim
- Silicognition LLC RP2040-Shim
- SparkFun MicroMod RP2040 Processor
- SparkFun MicroMod SAMD51 Processor
- SparkFun MicroMod nRF52840 Processor
- SparkFun Pro Micro RP2040
- SparkFun Pro Micro RP2350
- SparkFun Pro nRF52840 Mini
- SparkFun STM32 MicroMod Processor
- SparkFun Teensy MicroMod Processor
- SparkFun Thing Plus - RP2040
- SparkFun Thing Plus - SAMD51
- SparkFun Thing Plus - STM32
- Spotpear ESP32C3 LCD 1.44
- Sunton ESP32-2424S012
- Sunton-ESP32-8048S050
- Sunton-ESP32-8048S070
- SuperMini NRF52840
- Swan R5
- TG-Boards' Datalore IP M4
- TG-Watch
- THUNDERPACK_v11
- THUNDERPACK_v12
- TTGO T8 ESP32-S2-WROOM
- Targett Module Clip w/Wroom
- Targett Module Clip w/Wrover
- Teensy 4.0
- Teensy 4.1
- Teknikio Bluebird
- The Open Book Feather
- ThingPulse Pendrive S3
- TinkeringTech ScoutMakes Azul
- TinyC6
- TinyPICO
- TinyPICO Nano
- TinyS2
- TinyS3
- TinyWATCH S3
- UARTLogger II
- VCC-GND Studio YD RP2040
- VCC-GND YD-ESP32-S3 (N16R8)
- VCC-GND YD-ESP32-S3 (N8R8)
- VIDI X V1.1
- W5100S-EVB-Pico
- W5500-EVB-Pico
- WK-50 Trackball Keyboard
- WSC-1450
- WarmBit BluePixel nRF52840
- Waveshare ESP32-S2-Pico
- Waveshare ESP32-S2-Pico-LCD
- Waveshare ESP32-S3-GEEK
- Waveshare ESP32-S3-Pico
- Waveshare ESP32-S3-Tiny
- Waveshare ESP32-S3-Zero
- Waveshare ESP32S3 LCD 1.28
- Waveshare RP2040-GEEK
- Waveshare RP2040-LCD-0.96
- Waveshare RP2040-LCD-1.28
- Waveshare RP2040-One
- Waveshare RP2040-PiZero
- Waveshare RP2040-Plus (16MB)
- Waveshare RP2040-Plus (4MB)
- Waveshare RP2040-TOUCH-LCD-1.28
- Waveshare RP2040-Tiny
- Waveshare RP2040-Zero
- WeAct ESP32-C6 (4MB)
- WeAct ESP32-C6 (8MB)
- WeAct Studio Pico
- WeAct Studio Pico 16MB
- WeMos LOLIN32 Lite
- Wemos Lolin C3 Mini
- Wemos Lolin C3 Pico
- WisdPi Ardu2040M
- WisdPi Tiny RP2040
- iLabs Challenger 840
- iMX RT 1020 EVK
- iMX RT 1040 EVK
- iMX RT 1050 EVKB
- iMX RT 1060 EVK
- iMX RT 1060 EVKB
- iMX RT1011 Nano Kit
- nanoESP32-S2 w/Wrover
- nanoESP32-S2 w/Wroom
- nice!nano
- nullbits Bit-C PRO
- senseBox MCU-S2 ESP32S2
- splitkb.com Liatris
- stm32f411ce-blackpill
- stm32f411ce-blackpill-with-flash
- sunton_esp32_2432S028
- sunton_esp32_2432S032C
- takayoshiotake Octave RP2040
- uGame10
- uGame22
Create a
Keys
object that will scan keys attached to the given sequence of pins. Each key is independent and attached to its own pin.An
EventQueue
is created when this object is created and is available in theevents
attribute.- Parameters:
pins (Sequence[microcontroller.Pin]) – The pins attached to the keys. The key numbers correspond to indices into this sequence.
value_when_pressed (bool) –
True
if the pin reads high when the key is pressed.False
if the pin reads low (is grounded) when the key is pressed. All the pins must be connected in the same way.pull (bool) –
True
if an internal pull-up or pull-down should be enabled on each pin. A pull-up will be used ifvalue_when_pressed
isFalse
; a pull-down will be used if it isTrue
. If an external pull is already provided for all the pins, you can setpull
toFalse
. However, enabling an internal pull when an external one is already present is not a problem; it simply uses slightly more current.interval (float) – Scan keys no more often than
interval
to allow for debouncing.interval
is in float seconds. The default is 0.020 (20 msecs).max_events (int) – maximum size of
events
EventQueue
: maximum number of key transition events that are saved. Must be >= 1. If a new event arrives when the queue is full, the oldest event is discarded.debounce_threshold (int) – Emit events for state changes only after a key has been in the respective state for
debounce_threshold
times on average. Successive measurements are spaced apart byinterval
seconds. The default is 1, which resolves immediately. The maximum is 127.
- __exit__() None
Automatically deinitializes when exiting a context. See Lifetime and ContextManagers for more info.
- reset() None
Reset the internal state of the scanner to assume that all keys are now released. Any key that is already pressed at the time of this call will therefore immediately cause a new key-pressed event to occur.
- events: EventQueue
The
EventQueue
associated with thisKeys
object. (read-only)
- class keypad.ShiftRegisterKeys(*, clock: microcontroller.Pin, data: microcontroller.Pin | Sequence[microcontroller.Pin], latch: microcontroller.Pin, value_to_latch: bool = True, key_count: int | Sequence[int], value_when_pressed: bool, interval: float = 0.02, max_events: int = 64, debounce_threshold: int = 1)
Manage a set of keys attached to an incoming shift register.
Available on these boards
- 01Space 0.42 OLED ESP32C3
- 0xCB Helios
- 42. Keebs Frood
- 8086 Commander
- 8086 USB Interposer
- AITHinker ESP32-C3S_Kit
- AITHinker ESP32-C3S_Kit_2M
- ARAMCON Badge 2019
- ARAMCON2 Badge
- ATMegaZero ESP32-S2
- Adafruit CLUE nRF52840 Express
- Adafruit Circuit Playground Bluefruit
- Adafruit EdgeBadge
- Adafruit Feather Bluefruit Sense
- Adafruit Feather ESP32 V2
- Adafruit Feather ESP32-C6 4MB Flash No PSRAM
- Adafruit Feather ESP32-S2 Reverse TFT
- Adafruit Feather ESP32-S2 TFT
- Adafruit Feather ESP32-S3 Reverse TFT
- Adafruit Feather ESP32-S3 TFT
- Adafruit Feather ESP32S2
- Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
- Adafruit Feather ESP32S3 No PSRAM
- Adafruit Feather HUZZAH32
- Adafruit Feather M4 CAN
- Adafruit Feather M4 Express
- Adafruit Feather MIMXRT1011
- Adafruit Feather RP2040
- Adafruit Feather RP2040 Adalogger
- Adafruit Feather RP2040 CAN
- Adafruit Feather RP2040 DVI
- Adafruit Feather RP2040 Prop-Maker
- Adafruit Feather RP2040 RFM
- Adafruit Feather RP2040 Scorpio
- Adafruit Feather RP2040 ThinkInk
- Adafruit Feather RP2040 USB Host
- Adafruit Feather RP2350
- Adafruit Feather STM32F405 Express
- Adafruit Feather nRF52840 Express
- Adafruit Floppsy RP2040
- Adafruit FunHouse
- Adafruit Grand Central M4 Express
- Adafruit HUZZAH32 Breakout
- Adafruit Hallowing M4 Express
- Adafruit ItsyBitsy ESP32
- Adafruit ItsyBitsy M4 Express
- Adafruit ItsyBitsy RP2040
- Adafruit ItsyBitsy nRF52840 Express
- Adafruit KB2040
- Adafruit LED Glasses Driver nRF52840
- Adafruit Macropad RP2040
- Adafruit MagTag
- Adafruit Matrix Portal M4
- Adafruit MatrixPortal S3
- Adafruit Metro ESP32S2
- Adafruit Metro ESP32S3
- Adafruit Metro M4 Airlift Lite
- Adafruit Metro M4 Express
- Adafruit Metro RP2040
- Adafruit Metro RP2350
- Adafruit Metro nRF52840 Express
- Adafruit PyGamer
- Adafruit PyPortal
- Adafruit PyPortal Pynt
- Adafruit PyPortal Titano
- Adafruit Pybadge
- Adafruit QT Py ESP32 PICO
- Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
- Adafruit QT Py ESP32-S3 no psram
- Adafruit QT Py ESP32C3
- Adafruit QT Py ESP32S2
- Adafruit QT Py RP2040
- Adafruit QT2040 Trinkey
- Adafruit Trellis M4 Express
- Adafruit Vindie S2
- Adafruit-Qualia-S3-RGB666
- Ai Thinker ESP32-CAM
- AloriumTech Evo M51
- Archi RP2040
- Arduino Nano 33 BLE
- Arduino Nano 33 BLE Rev2
- Arduino Nano ESP32
- Arduino Nano RP2040 Connect
- Artisense Reference Design RD00
- AtelierDuMaker nRF52840 Breakout
- AutosportLabs-ESP32-CAN-X2
- BARDUINO 4.0.2
- BBQ20KBD
- BDMICRO VINA-D51
- BLE-SS dev board Multi Sensor
- BLING!
- BLOK
- BPI-Bit-S2
- BPI-Leaf-S3
- BPI-PicoW-S3
- BastBLE
- BastWiFi
- Bee-Data-Logger
- Bee-Motion-S3
- Bee-S3
- BlizzardS3
- BlueMicro833
- BlueMicro840
- Bradán Lane STUDIO Explorer Badge
- COSMO-Pico
- CP32-M4
- CRCibernetica IdeaBoard
- Challenger NB RP2040 WiFi
- Challenger RP2040 LTE
- Challenger RP2040 LoRa
- Challenger RP2040 SD/RTC
- Challenger RP2040 SubGHz
- Challenger RP2040 WiFi
- Challenger RP2040 WiFi/BLE
- Challenger+ RP2350 BConnect
- Challenger+ RP2350 WiFi6/BLE5
- CircuitART Zero S3
- CircuitBrains Deluxe
- ColumbiaDSL-Sensor-Board-V1
- CrumpS2
- Cytron EDU PICO W
- Cytron IRIV IO Controller
- Cytron MOTION 2350 Pro
- Cytron Maker Feather AIoT S3
- Cytron Maker Nano RP2040
- Cytron Maker Pi RP2040
- Cytron Maker Uno RP2040
- DFRobot Beetle ESP32-C3
- DFRobot FireBeetle 2 ESP32-S3
- Datanoise PicoADK
- Datanoise PicoADK V2
- Deneyap Kart
- Deneyap Kart 1A
- Deneyap Kart 1A v2
- Deneyap Kart G
- Deneyap Mini
- Deneyap Mini v2
- Diodes Delight Piunora
- DynOSSAT-EDU-OBC
- E-Fidget
- ELECFREAKS PICO:ED
- ES3ink
- ESP 12k NodeMCU
- ESP32 Devkit V1
- ESP32-C3-DevKitM-1
- ESP32-C6-DevKitC-1-N8
- ESP32-C6-DevKitM-1
- ESP32-H2-DevKitM-1
- ESP32-P4-Function-EV
- ESP32-S2-DevKitC-1-N4
- ESP32-S2-DevKitC-1-N4R2
- ESP32-S2-DevKitC-1-N8R2
- ESP32-S3-Box-2.5
- ESP32-S3-Box-Lite
- ESP32-S3-DevKitC-1-N16
- ESP32-S3-DevKitC-1-N32R8
- ESP32-S3-DevKitC-1-N8
- ESP32-S3-DevKitC-1-N8R2
- ESP32-S3-DevKitC-1-N8R8
- ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
- ESP32-S3-DevKitM-1-N8
- ESP32-S3-EYE
- ESP32-S3-USB-OTG-N8
- ESP8684-DevKitC-02-N4
- Electrolama minik
- Electronut Labs Blip
- Electronut Labs Papyr
- EncoderPad RP2040
- Espressif ESP32 DevKitc V4 WROOM-32E
- Espressif ESP32 DevKitc V4 WROVER
- Espressif ESP32 TTGO T8 v1.7
- Espressif ESP32-LyraT
- Espressif-ESP32-S3-LCD-EV-Board
- Espressif-ESP32-S3-LCD-EV-Board_v1.5
- Espruino Bangle.js 2
- Espruino Wifi
- Feather MIMXRT1011
- Feather MIMXRT1062
- FeatherS2
- FeatherS2 Neo
- FeatherS2 PreRelease
- FeatherS3
- FeatherS3 Neo
- Fig Pi
- Flipper Zero Wi-Fi Dev
- Fomu
- Franzininho WIFI w/Wroom
- Franzininho WIFI w/Wrover
- Freenove ESP32-WROVER-DEV-CAM
- Gravitech Cucumber M
- Gravitech Cucumber MS
- Gravitech Cucumber R
- Gravitech Cucumber RS
- HEIA-FR Picomo V2
- HMI-DevKit-1.1
- Hack Club Sprig
- Hardkernel Odroid Go
- Heltec ESP32-S3-WIFI-LoRa-V3
- HexKyS2
- HiiBot BlueFi
- IMXRT1010-EVK
- IMXRT1015-EVK
- IkigaiSense Vita nRF52840
- IoTs2
- Kaluga 1
- LILYGO T-DECK
- LILYGO T-DISPLAY
- LILYGO T-DISPLAY S3 v1.2
- LILYGO T-Display S3 Pro
- LILYGO T-Watch-S3
- LILYGO TEMBED ESP32S3
- LILYGO TTGO T-01C3
- LILYGO TTGO T-DISPLAY v1.1
- LILYGO TTGO T-DISPLAY v1.1 4M
- LILYGO TTGO T-OI PLUS
- LILYGO TTGO T8 ESP32-S2
- LILYGO TTGO T8 ESP32-S2 w/Display
- LOLIN S3 16MB Flash 8MB PSRAM
- LOLIN S3 MINI 4MB Flash 2MB PSRAM
- LOLIN S3 PRO 16MB Flash 8MB PSRAM
- Lilygo T-watch 2020 V3
- Luatos Core-ESP32C3
- M5STACK STAMP-C3
- M5Stack Atom Echo
- M5Stack Atom Lite
- M5Stack Atom Matrix
- M5Stack Atom U
- M5Stack AtomS3
- M5Stack AtomS3 Lite
- M5Stack AtomS3U
- M5Stack Cardputer
- M5Stack Core Basic
- M5Stack Core Fire
- M5Stack Core2
- M5Stack CoreS3
- M5Stack Dial
- M5Stack M5Paper
- M5Stack Stick C
- M5Stack Stick C Plus
- M5Stack Timer Camera X
- MDBT50Q-DB-40
- MDBT50Q-RX Dongle
- MEOWBIT
- MORPHEANS MorphESP-240
- MagiClick S3 N4R2
- Maker Go ESP32C3 Supermini
- Maker Go ESP32C6 Supermini
- Maker badge by Czech maker
- MakerDiary nRF52840 MDK
- MakerDiary nRF52840 MDK USB Dongle
- MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
- Makerdiary M60 Keyboard
- Makerdiary Pitaya Go
- Makerdiary nRF52840 Connect Kit
- Makerdiary nRF52840 M.2 Developer Kit
- Maple Computing Elite-Pi
- Melopero Shake RP2040
- Metro MIMXRT1011
- MicroDev microC3
- MicroDev microS2
- Mini SAM M4
- MixGo CE
- NUCLEO STM32F746
- NUCLEO STM32F767
- NUCLEO STM32H743
- NanoS3
- Neuron
- NodeMcu-ESP32-C2
- OMGS3
- OPENMV-H7 R1
- Oak Dev Tech BREAD2040
- Oak Dev Tech Cast-Away RP2040
- Oak Dev Tech PixelWing ESP32S2
- Oak Dev Tech RPGA Feather
- Open Hardware Summit 2020 Badge
- Oxocard Artwork
- Oxocard Connect
- Oxocard Galaxy
- Oxocard Science
- P1AM-200
- PCA10056 nRF52840-DK
- PCA10059 nRF52840 Dongle
- PYB LR Nano V2
- Pajenicko PicoPad
- Particle Argon
- Particle Boron
- Particle Xenon
- PillBug
- Pimoroni Badger 2040
- Pimoroni Badger 2040 W
- Pimoroni Inky Frame 5.7
- Pimoroni Inky Frame 7.3
- Pimoroni Interstate 75
- Pimoroni Keybow 2040
- Pimoroni Motor 2040
- Pimoroni PGA2040
- Pimoroni PGA2350
- Pimoroni Pico DV Base W
- Pimoroni Pico LiPo (16MB)
- Pimoroni Pico LiPo (4MB)
- Pimoroni Pico Plus 2
- Pimoroni Pico dv Base
- Pimoroni PicoSystem
- Pimoroni Plasma 2040
- Pimoroni Plasma 2040W
- Pimoroni Plasma 2350
- Pimoroni Servo 2040
- Pimoroni Tiny 2040 (2MB)
- Pimoroni Tiny 2040 (8MB)
- Pimoroni Tiny 2350
- Pimoroni Tiny FX
- ProS3
- PyKey 18 Numpad
- PyKey 44 Ergo
- PyKey 60
- PyKey 87 TKL
- PyboardV1_1
- RF.Guru RP2040
- RGBTouch Mini
- RP2.65-F
- RP2040 Stamp
- RP2350 Stamp
- RP2350 Stamp XL
- Raspberry Breadstick
- Raspberry Pi 4B
- Raspberry Pi Compute Module 4
- Raspberry Pi Compute Module 4 IO Board
- Raspberry Pi Pico
- Raspberry Pi Pico 2
- Raspberry Pi Pico W
- Raspberry Pi Zero
- Raspberry Pi Zero 2W
- Raspberry Pi Zero W
- Robo HAT MM1 M4
- S2Mini
- S2Pico
- SAM E54 Xplained Pro
- SAM32v26
- SQFMI Watchy
- SSCI ISP1807 Dev Board
- SSCI ISP1807 Micro Board
- ST STM32F746G Discovery
- STM32F411E_DISCO
- STM32F412G_DISCO
- STM32F4_DISCO
- Saola 1 w/Wroom
- Saola 1 w/Wrover
- Seeed Studio XIAO ESP32C3
- Seeed XIAO nRF52840 Sense
- Seeed Xiao ESP32-C6 4MB Flash 512KB SRAM
- Seeed Xiao ESP32-S3 Sense
- Seeeduino Wio Terminal
- Seeeduino XIAO KB
- Seeeduino XIAO RP2040
- Seeeduino XIAO RP2350
- Silicognition LLC M4-Shim
- Silicognition LLC RP2040-Shim
- SparkFun MicroMod RP2040 Processor
- SparkFun MicroMod SAMD51 Processor
- SparkFun MicroMod nRF52840 Processor
- SparkFun Pro Micro RP2040
- SparkFun Pro Micro RP2350
- SparkFun Pro nRF52840 Mini
- SparkFun STM32 MicroMod Processor
- SparkFun Teensy MicroMod Processor
- SparkFun Thing Plus - RP2040
- SparkFun Thing Plus - SAMD51
- SparkFun Thing Plus - STM32
- Spotpear ESP32C3 LCD 1.44
- Sunton ESP32-2424S012
- Sunton-ESP32-8048S050
- Sunton-ESP32-8048S070
- SuperMini NRF52840
- Swan R5
- TG-Boards' Datalore IP M4
- TG-Watch
- THUNDERPACK_v11
- THUNDERPACK_v12
- TTGO T8 ESP32-S2-WROOM
- Targett Module Clip w/Wroom
- Targett Module Clip w/Wrover
- Teensy 4.0
- Teensy 4.1
- Teknikio Bluebird
- The Open Book Feather
- ThingPulse Pendrive S3
- TinkeringTech ScoutMakes Azul
- TinyC6
- TinyPICO
- TinyPICO Nano
- TinyS2
- TinyS3
- TinyWATCH S3
- UARTLogger II
- VCC-GND Studio YD RP2040
- VCC-GND YD-ESP32-S3 (N16R8)
- VCC-GND YD-ESP32-S3 (N8R8)
- VIDI X V1.1
- W5100S-EVB-Pico
- W5500-EVB-Pico
- WK-50 Trackball Keyboard
- WSC-1450
- WarmBit BluePixel nRF52840
- Waveshare ESP32-S2-Pico
- Waveshare ESP32-S2-Pico-LCD
- Waveshare ESP32-S3-GEEK
- Waveshare ESP32-S3-Pico
- Waveshare ESP32-S3-Tiny
- Waveshare ESP32-S3-Zero
- Waveshare ESP32S3 LCD 1.28
- Waveshare RP2040-GEEK
- Waveshare RP2040-LCD-0.96
- Waveshare RP2040-LCD-1.28
- Waveshare RP2040-One
- Waveshare RP2040-PiZero
- Waveshare RP2040-Plus (16MB)
- Waveshare RP2040-Plus (4MB)
- Waveshare RP2040-TOUCH-LCD-1.28
- Waveshare RP2040-Tiny
- Waveshare RP2040-Zero
- WeAct ESP32-C6 (4MB)
- WeAct ESP32-C6 (8MB)
- WeAct Studio Pico
- WeAct Studio Pico 16MB
- WeMos LOLIN32 Lite
- Wemos Lolin C3 Mini
- Wemos Lolin C3 Pico
- WisdPi Ardu2040M
- WisdPi Tiny RP2040
- iLabs Challenger 840
- iMX RT 1020 EVK
- iMX RT 1040 EVK
- iMX RT 1050 EVKB
- iMX RT 1060 EVK
- iMX RT 1060 EVKB
- iMX RT1011 Nano Kit
- nanoESP32-S2 w/Wrover
- nanoESP32-S2 w/Wroom
- nice!nano
- nullbits Bit-C PRO
- senseBox MCU-S2 ESP32S2
- splitkb.com Liatris
- stm32f411ce-blackpill
- stm32f411ce-blackpill-with-flash
- sunton_esp32_2432S028
- sunton_esp32_2432S032C
- takayoshiotake Octave RP2040
- uGame10
- uGame22
Create a
Keys
object that will scan keys attached to a parallel-in serial-out shift register like the 74HC165 or CD4021. Note that you may chain shift registers to load in as many values as you need. Furthermore, you can put multiple shift registers in parallel and share clock and latch.Key number 0 is the first (or more properly, the zero-th) bit read. In the 74HC165, this bit is labeled
Q7
. Key number 1 will be the value ofQ6
, etc. With multiple data pins, key numbers of the next pin are sequentially to the current pin.An
EventQueue
is created when this object is created and is available in theevents
attribute.- Parameters:
clock (microcontroller.Pin) – The shift register clock pin. The shift register should clock on a low-to-high transition.
data (Union[microcontroller.Pin, Sequence[microcontroller.Pin]]) – the incoming shift register data pin(s)
latch (microcontroller.Pin) – Pin used to latch parallel data going into the shift register.
value_to_latch (bool) – Pin state to latch data being read.
True
if the data is latched whenlatch
goes highFalse
if the data is latched whenlatch
goes low. The default isTrue
, which is how the 74HC165 operates. The CD4021 latch is the opposite. Once the data is latched, it will be shifted out by toggling the clock pin.key_count (Union[int, Sequence[int]]) – number of data lines to clock in (per data pin)
value_when_pressed (bool) –
True
if the pin reads high when the key is pressed.False
if the pin reads low (is grounded) when the key is pressed.interval (float) – Scan keys no more often than
interval
to allow for debouncing.interval
is in float seconds. The default is 0.020 (20 msecs).max_events (int) – maximum size of
events
EventQueue
: maximum number of key transition events that are saved. Must be >= 1. If a new event arrives when the queue is full, the oldest event is discarded.debounce_threshold (int) – Emit events for state changes only after a key has been in the respective state for
debounce_threshold
times on average. Successive measurements are spaced apart byinterval
seconds. The default is 1, which resolves immediately. The maximum is 127.
- __exit__() None
Automatically deinitializes when exiting a context. See Lifetime and ContextManagers for more info.
- reset() None
Reset the internal state of the scanner to assume that all keys are now released. Any key that is already pressed at the time of this call will therefore immediately cause a new key-pressed event to occur.
- events: EventQueue
The
EventQueue
associated with thisKeys
object. (read-only)