switch KeyboardLayoutBase to latest adafruit_HID

Neradoc · Neradoc · commit 6015f0d2b5fa · 2022-02-08T05:16:36.000+01:00
diff --git a/README.md b/README.md
@@ -13,9 +13,8 @@ NOTE: for pico-ducky users, [there's a dedicated guide](PICODUCKY.md).
 
 ## Install your language
 
-To install both the layout and keycode files for your language, you need to copy 3 files to your board. Pick the language and platforms that match yours. Use the `.py` version, or the `.mpy` version matching your version of Circuitpython. The mpy files take less space and are better suited for Circuitpython boards with less than 1MB of drive.
+To install both the layout and keycode files for your language, you need to copy 2 files to your board. Pick the language and platforms that match yours. Use the `.py` version, or the `.mpy` version matching your version of Circuitpython. The mpy files take less space and are better suited for Circuitpython boards with less than 1MB of drive.
 
-- `keyboard_layout.mpy` (support file)
 - `keyboard_layout_win_fr.mpy` (pick your platform/language)
 - `keycode_win_fr.mpy` (pick your platform/language)
 
@@ -29,7 +28,7 @@ Don't forget to also install [the adafruit_hid library](https://github.com/adafr
 
 ### Layouts
 
-Layouts require first installing the `keyboard_layout` module (`keyboard_layout.mpy` in the bundle zip), containing the base class for the layouts. This file should be part of adafruit_hid in the future and will then be removed.
+Layouts require the **latest** version of the `adafruit_hid` library (at least 5.x.x).
 
 For the plaform **platform** (win, mac) and the layout language **lang**. The module `keyboard_layout_platform_lang` has a class called `KeyboardLayout`. It contains the layout information for use with the `Keyboard` to type text.
 
diff --git a/docs/drive_generic.png b/docs/drive_generic.png
diff --git a/docs/drive_pico_ducky.png b/docs/drive_pico_ducky.png
diff --git a/libraries/layouts/keyboard_layout_mac_fr.py b/libraries/layouts/keyboard_layout_mac_fr.py
@@ -25,7 +25,7 @@
 * Author(s): Dan Halbert, Neradoc
 """
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 
 
 __version__ = "1.0.0-auto.0"
diff --git a/libraries/layouts/keyboard_layout_us_dvo.py b/libraries/layouts/keyboard_layout_us_dvo.py
@@ -1,4 +1,4 @@
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 
 
 __version__ = "0.0.0-auto.0"
diff --git a/libraries/layouts/keyboard_layout_win_br.py b/libraries/layouts/keyboard_layout_win_br.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_cz.py b/libraries/layouts/keyboard_layout_win_cz.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_cz1.py b/libraries/layouts/keyboard_layout_win_cz1.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_da.py b/libraries/layouts/keyboard_layout_win_da.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_de.py b/libraries/layouts/keyboard_layout_win_de.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_es.py b/libraries/layouts/keyboard_layout_win_es.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_fr.py b/libraries/layouts/keyboard_layout_win_fr.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_hu.py b/libraries/layouts/keyboard_layout_win_hu.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_it.py b/libraries/layouts/keyboard_layout_win_it.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_po.py b/libraries/layouts/keyboard_layout_win_po.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_sw.py b/libraries/layouts/keyboard_layout_win_sw.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/libraries/layouts/keyboard_layout_win_tr.py b/libraries/layouts/keyboard_layout_win_tr.py
@@ -10,7 +10,7 @@
 __repo__ = "https://github.com/Neradoc/Circuitpython_Keyboard_Layouts.git"
 
 
-from keyboard_layout import KeyboardLayoutBase
+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase
 class KeyboardLayout(KeyboardLayoutBase):
     ASCII_TO_KEYCODE = (
         b'\x00'
diff --git a/tests/reference/keyboard_layout.py b/tests/reference/keyboard_layout.py
@@ -3,6 +3,9 @@
 # SPDX-License-Identifier: MIT
 
 """
+`keyboard_layout.KeyboardLayoutBase`
+=======================================================
+
 * Author(s): Dan Halbert, AngainorDev, Neradoc
 """
 
@@ -43,7 +46,7 @@ def __init__(self, keyboard):
 
     def _write(self, keycode, altgr=False):
         """Type a key combination based on shift bit and altgr bool
-        
+
         :param keycode: int value of the keycode, with the shift bit.
         :param altgr: bool indicating if the altgr key should be pressed too.
         """

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from keyboard_layout import KeyboardLayoutBase`
	`1`	`+from adafruit_hid.keyboard_layout_base import KeyboardLayoutBase`
`2`	`2`
`3`	`3`
`4`	`4`	`__version__ = "0.0.0-auto.0"`