Merge pull request #15 from Neradoc/move-layout-base-to-adafruit

Move layout base to adafruit_hid

Author: Neradoc

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.
 

docs/drive_generic-nohid.png

@@ -86,8 +86,8 @@
 	<li>Press the "Make Zip Bundle Links" button.</li>
 	<li>Click the link to download the zip with the modules.</li>
 	<li>Unzip the zip.</li>
-	<li>Copy the files to your boards "lib" directory (not the sample code).</li>
-	<li>Don't forget ton install adafruit_hid too if it's not already there.</li>
+	<li>Copy the files to your boards "lib" directory (the sample code is not needed).</li>
+	<li>Don't forget to install adafruit_hid too if it's not already there.</li>
 	<li>Follow the sample code, included in the zip.</li>
 	<li>Come bother me <a href="https://adafru.it/discord">on discord</a> if it doesn't work (no private messages).</li>
 </ul>

docs/drive_generic.png

@@ -5,6 +5,7 @@
 
 ob_start();
 $ERRORS = [];
+$LAYOUT_BASE = false;
 
 $source_url = "";
 $platform = "win";
@@ -90,13 +91,15 @@
 
 $keycodes = preg_replace("/".preg_quote($VERSION0)."/", $VERSION, $keycodes);
 
-if( !file_exists("src/keyboard_layout6.mpy") ) {
-	exec("mpy-cross/mpy-cross.static-amd64-linux-6 src/keyboard_layout.py");
-	rename("src/keyboard_layout.mpy", "src/keyboard_layout6.mpy");
-}
-if( !file_exists("src/keyboard_layout7.mpy") ) {
-	exec("mpy-cross/mpy-cross.static-amd64-linux-7 src/keyboard_layout.py");
-	rename("src/keyboard_layout.mpy", "src/keyboard_layout7.mpy");
+if($LAYOUT_BASE) {
+	if( !file_exists("src/keyboard_layout6.mpy") ) {
+		exec("mpy-cross/mpy-cross.static-amd64-linux-6 src/keyboard_layout.py");
+		rename("src/keyboard_layout.mpy", "src/keyboard_layout6.mpy");
+	}
+	if( !file_exists("src/keyboard_layout7.mpy") ) {
+		exec("mpy-cross/mpy-cross.static-amd64-linux-7 src/keyboard_layout.py");
+		rename("src/keyboard_layout.mpy", "src/keyboard_layout7.mpy");
+	}
 }
 
 function make_zip($layout, $keycodes, $cpversion, $platform, $lang) {
@@ -142,11 +145,15 @@ function make_zip($layout, $keycodes, $cpversion, $platform, $lang) {
 			$deletes[] = $tempfile;
 			$deletes[] = $mpyfile;
 			# layout base
-			$zip->addFile("src/keyboard_layout".$cpversion.".mpy", "keyboard_layout.mpy");
+			if($LAYOUT_BASE) {
+				$zip->addFile("src/keyboard_layout".$cpversion.".mpy", "keyboard_layout.mpy");
+			}
 		} else {
 			$zip->addFromString($layout_file, $layout);
 			$zip->addFromString($keycodes_file, $keycodes);
-			$zip->addFile("src/keyboard_layout.py", "keyboard_layout.py");
+			if($LAYOUT_BASE) {
+				$zip->addFile("src/keyboard_layout.py", "keyboard_layout.py");
+			}
 		}
 
 		$data = file_get_contents("src/sample_code_template.py");

docs/drive_pico_ducky-nohid.png

@@ -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"