Fix scanners.md (#1058)

* Fix scanners.md * Fix affected boards
KMKfw · Dec 16, 2024 · b638cc5 · b638cc5
1 parent 9271a9a
commit b638cc5
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 11 deletions.
diff --git a/boards/a_dux/kb.py b/boards/a_dux/kb.py
@@ -27,4 +27,4 @@ class KMKKeyboard(_KMKKeyboard):
 
     def __init__(self):
         # create and register the scanner
-        self.matrix = KeysScanner(_KEY_CFG_LEFT)
+        self.matrix = KeysScanner(_KEY_CFG_LEFT, value_when_pressed=False)
diff --git a/boards/anavi/anavi-arrows/arrows.py b/boards/anavi/anavi-arrows/arrows.py
@@ -17,4 +17,7 @@ class AnaviArrows(KMKKeyboard):
     '''
 
     def __init__(self):
-        self.matrix = KeysScanner([board.D1, board.D2, board.D3, board.D6])
+        self.matrix = KeysScanner(
+            [board.D1, board.D2, board.D3, board.D6],
+            value_when_pressed=False,
+        )
diff --git a/boards/anavi/knob1/code.py b/boards/anavi/knob1/code.py
@@ -8,7 +8,7 @@
 from kmk.scanners.keypad import KeysScanner
 
 knob = KMKKeyboard()
-knob.matrix = KeysScanner([])
+knob.matrix = KeysScanner([], value_when_pressed=False)
 
 media_keys = MediaKeys()
 knob.extensions.append(media_keys)

diff --git a/boards/anavi/knobs3/code.py b/boards/anavi/knobs3/code.py
@@ -8,7 +8,7 @@
 from kmk.scanners.keypad import KeysScanner
 
 knob = KMKKeyboard()
-knob.matrix = KeysScanner([])
+knob.matrix = KeysScanner([], value_when_pressed=False)
 
 media_keys = MediaKeys()
 knob.extensions.append(media_keys)

diff --git a/boards/budgy/kb.py b/boards/budgy/kb.py
@@ -41,7 +41,10 @@
 class KMKKeyboard(_KMKKeyboard):
     def __init__(self):
         # create and register the scanner
-        self.matrix = KeysScanner(pins=_KEY_CFG_RIGHT if isRight else _KEY_CFG_LEFT)
+        self.matrix = KeysScanner(
+            pins=_KEY_CFG_RIGHT if isRight else _KEY_CFG_LEFT,
+            value_when_pressed=False,
+        )
 
     # fmt: off
     coord_mapping = [

diff --git a/boards/ferris_sweep/kb.py b/boards/ferris_sweep/kb.py
@@ -19,7 +19,7 @@
 class KMKKeyboard(_KMKKeyboard):
     def __init__(self):
         # create and register the scanner
-        self.matrix = KeysScanner(_KEY_CFG_LEFT)
+        self.matrix = KeysScanner(_KEY_CFG_LEFT, value_when_pressed=False)
 
     # fmt: off
     coord_mapping = [

diff --git a/boards/isopad/kb.py b/boards/isopad/kb.py
@@ -15,4 +15,4 @@
 class KMKKeyboard(_KMKeyboard):
     def __init__(self):
         # create and register the scanner
-        self.matrix = KeysScanner(_KEY_CFG)
+        self.matrix = KeysScanner(_KEY_CFG, value_when_pressed=False)
diff --git a/boards/pimoroni/keybow/keybow.py b/boards/pimoroni/keybow/keybow.py
@@ -110,4 +110,4 @@ class Keybow(KMKKeyboard):
     extensions = [rgb]
 
     def __init__(self):
-        self.matrix = KeysScanner(_KEY_CFG)
+        self.matrix = KeysScanner(_KEY_CFG, value_when_pressed=False)
diff --git a/boards/pimoroni/keybow_2040/keybow_2040.py b/boards/pimoroni/keybow_2040/keybow_2040.py
@@ -43,4 +43,4 @@ class Keybow2040(KMKKeyboard):
     '''
 
     def __init__(self):
-        self.matrix = KeysScanner(_KEY_CFG)
+        self.matrix = KeysScanner(_KEY_CFG, value_when_pressed=False)
diff --git a/docs/en/scanners.md b/docs/en/scanners.md
@@ -70,8 +70,8 @@ class MyKeyboard(KMKKeyboard):
         self.matrix = KeysScanner(
             # require argument:
             pins=_KEY_CFG,
-            # optional arguments with defaults:
             value_when_pressed=False,
+            # optional arguments with defaults:
             pull=True,
             interval=0.02, # Matrix sampling interval in ms
             debounce_threshold=None, # Number of samples needed to change state, values greater than 1 enable debouncing. Only applicable for CircuitPython >= 9.2.0
@@ -97,9 +97,9 @@ class MyKeyboard(KMKKeyboard):
             data=board.GP1,
             latch=board.GP2,
             key_count=8,
+            value_when_pressed=False,
             # optional arguments with defaults:
             value_to_latch=True, # 74HC165: True, CD4021: False
-            value_when_pressed=False,
             interval=0.02, # Matrix sampling interval in ms
             debounce_threshold=None, # Number of samples needed to change state, values greater than 1 enable debouncing. Only applicable for CircuitPython >= 9.2.0
             max_events=64