Keyboard: Invert pin states for open drain output.

peterhinch · peterhinch · commit d549e5bcb832 · 2023-10-06T20:09:47.000+01:00
diff --git a/v3/docs/EVENTS.md b/v3/docs/EVENTS.md
@@ -494,18 +494,18 @@ from primitives import Keyboard
 ```
 A `Keyboard` provides an interface to a set of pushbuttons arranged as a
 crosspoint array. If a key is pressed its array index (scan code) is placed on a
- queue. Keypresses are retrieved with `async for`. The driver operates by
- polling each row, reading the response of each column. N-key rollover is
- supported - this is the case where a key is pressed before the prior key has
- been released.
+queue. Keypresses are retrieved with `async for`. The driver operates by
+polling each row, reading the response of each column. 1-key rollover is
+supported - this is the case where a key is pressed before the prior key has
+been released.
 
- Example usage:
+Example usage:
 ```python
 import asyncio
 from primitives import Keyboard
 from machine import Pin
-rowpins = [Pin(p, Pin.OUT) for p in range(10, 14)]
-colpins = [Pin(p, Pin.IN, Pin.PULL_DOWN) for p in range(16, 20)]
+rowpins = [Pin(p, Pin.OPEN_DRAIN) for p in range(10, 14)]
+colpins = [Pin(p, Pin.IN, Pin.PULL_UP) for p in range(16, 20)]
 
 async def main():
     kp = Keyboard(rowpins, colpins)
@@ -553,7 +553,7 @@ async def repeat(tim, uart, ch):  # Send at least one char
         await tim.wait()
 
 async def main():  # Run forever
-    rowpins = [Pin(p, Pin.OUT) for p in range(10, 14)]
+    rowpins = [Pin(p, Pin.OPEN_DRAIN) for p in range(10, 14)]
     colpins = [Pin(p, Pin.IN, Pin.PULL_DOWN) for p in range(16, 20)]
     uart = UART(0, 9600, tx=0, rx=1)
     pad = Keyboard(rowpins, colpins)
@@ -570,10 +570,10 @@ asyncio.run(main())
 ```
 ##### Application note
 
-Scanning of the keyboard occurs rapidly, and built-in pull-down resistors have a
+Scanning of the keyboard occurs rapidly, and built-in pull-up resistors have a
 high value. If the capacitance between wires is high, spurious keypresses may be
-registed. To prevent this it is wise to add physical resistors between the input
-pins and gnd. A value in the region of 1KΩ to 5KΩ is recommended.
+registered. To prevent this it is wise to add physical resistors between the
+input pins and 3.3V. A value in the region of 1KΩ to 5KΩ is recommended.
 
 ###### [Contents](./EVENTS.md#0-contents)
 
diff --git a/v3/primitives/events.py b/v3/primitives/events.py
@@ -175,21 +175,21 @@ def __init__(self, rowpins, colpins, *, buffer=bytearray(10), db_delay=50):
         self.colpins = colpins
         self._state = 0  # State of all keys as bitmap
         for opin in self.rowpins:  # Initialise output pins
-            opin(0)
+            opin(1)
         asyncio.create_task(self.scan(len(rowpins) * len(colpins), db_delay))
 
     def __getitem__(self, scan_code):
         return bool(self._state & (1 << scan_code))
 
     async def scan(self, nkeys, db_delay):
         while True:
-            cur = 0  # Current bitmap of key states
+            cur = 0  # Current bitmap of logical key states
             for opin in self.rowpins:
-                opin(1)  # Assert output
+                opin(0)  # Assert output
                 for ipin in self.colpins:
                     cur <<= 1
-                    cur |= ipin()
-                opin(0)
+                    cur |= ipin() ^ 1  # Convert physical to logical
+                opin(1)
             if pressed := (cur & ~self._state):  # 1's are newly pressed button(s)
                 for sc in range(nkeys):
                     if pressed & 1:
