Add french layout (with example)

adafruit_hid/keyboard_layout_fr.py

@@ -0,0 +1,287 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Dan Halbert
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE
+#
+"""
+`adafruit_hid.keyboard_layout_fr.KeyboardLayoutFR`
+=======================================================
+
+* Author(s): Dan Halbert
+"""
+
+from .keycode import Keycode
+
+
+class KeyboardLayoutFR:
+    """Map ASCII characters to appropriate keypresses on a standard FR PC keyboard.
+
+    Non-ASCII characters and most control characters will raise an exception.
+    """
+
+    # The ASCII_TO_KEYCODE bytes object is used as a table to maps ASCII 0-127
+    # to the corresponding # keycode on a US 104-key keyboard.
+    # The user should not normally need to use this table,
+    # but it is not marked as private.
+    #
+    # Because the table only goes to 127, we use the top bit of each byte (ox80) to indicate
+    # that the shift key should be pressed. So any values 0x{8,9,a,b}* are shifted characters.
+    #
+    # The Python compiler will concatenate all these bytes literals into a single bytes object.
+    # Micropython/CircuitPython will store the resulting bytes constant in flash memory
+    # if it's in a .mpy file, so it doesn't use up valuable RAM.
+    #
+    # \x00 entries have no keyboard key and so won't be sent.
+    # FR Layout Based on https://github.com/matthgyver/Arduino-Keyboard-FR/blob/master/KeyboardFR/src/KeyboardFR.cpp
+    SHIFT_FLAG = 0x80
+    ALTGR_FLAG = 0xC0
+
+    ASCII_TO_KEYCODE = (
+        b"\x00"  # NUL
+        b"\x00"  # SOH
+        b"\x00"  # STX
+        b"\x00"  # ETX
+        b"\x00"  # EOT
+        b"\x00"  # ENQ
+        b"\x00"  # ACK
+        b"\x00"  # BEL \a
+        b"\x2a"  # BS BACKSPACE \b (called DELETE in the usb.org document)
+        b"\x2b"  # TAB \t
+        b"\x28"  # LF \n (called Return or ENTER in the usb.org document)
+        b"\x00"  # VT \v
+        b"\x00"  # FF \f
+        b"\x00"  # CR \r
+        b"\x00"  # SO
+        b"\x00"  # SI
+        b"\x00"  # DLE
+        b"\x00"  # DC1
+        b"\x00"  # DC2
+        b"\x00"  # DC3
+        b"\x00"  # DC4
+        b"\x00"  # NAK
+        b"\x00"  # SYN
+        b"\x00"  # ETB
+        b"\x00"  # CAN
+        b"\x00"  # EM
+        b"\x00"  # SUB
+        b"\x29"  # ESC
+        b"\x00"  # FS
+        b"\x00"  # GS
+        b"\x00"  # RS
+        b"\x00"  # US
+        b"\x2c"  # SPACE
+        b"\x38"  # ! x1e|SHIFT_FLAG (shift 1)
+        b"\x20"  # " x34|SHIFT_FLAG (shift ')
+        b"\xe0"  # # x20|SHIFT_FLAG (shift 3)
+        b"\x30"  # $ x21|SHIFT_FLAG (shift 4)
+        b"\xb4"  # % x22|SHIFT_FLAG (shift 5)
+        b"\x1e"  # & x24|SHIFT_FLAG (shift 7)
+        b"\x21"  # '
+        b"\x22"  # ( x26|SHIFT_FLAG (shift 9)
+        b"\x2d"  # ) x27|SHIFT_FLAG (shift 0)
+        b"\x31"  # * x25|SHIFT_FLAG (shift 8)
+        b"\xae"  # + x2e|SHIFT_FLAG (shift =)
+        b"\x10"  # ,
+        b"\x23"  # -
+        b"\xb6"  # .
+        b"\xb7"  # /
+        b"\xa7"  # 0
+        b"\x9e"  # 1
+        b"\x9f"  # 2
+        b"\xa0"  # 3
+        b"\xa1"  # 4
+        b"\xa2"  # 5
+        b"\xa3"  # 6
+        b"\xa4"  # 7
+        b"\xa5"  # 8
+        b"\xa6"  # 9
+        b"\x37"  # : x33|SHIFT_FLAG (shift ;)
+        b"\x36"  # ;
+        b"\x64"  # < x36|SHIFT_FLAG (shift ,)
+        b"\x2e"  # =
+        b"\x03"  # > x37|SHIFT_FLAG (shift .)
+        b"\x90"  # ? x38|SHIFT_FLAG (shift /)
+        b"\xe7"  # @ x1f|SHIFT_FLAG (shift 2)
+        b"\x94"  # A x04|SHIFT_FLAG (shift a)
+        b"\x85"  # B x05|SHIFT_FLAG (etc.)
+        b"\x86"  # C x06|SHIFT_FLAG
+        b"\x87"  # D x07|SHIFT_FLAG
+        b"\x88"  # E x08|SHIFT_FLAG
+        b"\x89"  # F x09|SHIFT_FLAG
+        b"\x8a"  # G x0a|SHIFT_FLAG
+        b"\x8b"  # H x0b|SHIFT_FLAG
+        b"\x8c"  # I x0c|SHIFT_FLAG
+        b"\x8d"  # J x0d|SHIFT_FLAG
+        b"\x8e"  # K x0e|SHIFT_FLAG
+        b"\x8f"  # L x0f|SHIFT_FLAG
+        b"\xb3"  # M x10|SHIFT_FLAG
+        b"\x91"  # N x11|SHIFT_FLAG
+        b"\x92"  # O x12|SHIFT_FLAG
+        b"\x93"  # P x13|SHIFT_FLAG
+        b"\x84"  # Q x14|SHIFT_FLAG
+        b"\x95"  # R x15|SHIFT_FLAG
+        b"\x96"  # S x16|SHIFT_FLAG
+        b"\x97"  # T x17|SHIFT_FLAG
+        b"\x98"  # U x18|SHIFT_FLAG
+        b"\x99"  # V x19|SHIFT_FLAG
+        b"\x9d"  # W x1a|SHIFT_FLAG
+        b"\x9b"  # X x1b|SHIFT_FLAG
+        b"\x9c"  # Y x1c|SHIFT_FLAG
+        b"\x9a"  # Z x1d|SHIFT_FLAG
+        b"\xe2"  # [
+        b"\xe5"  # \ backslash
+        b"\xed"  # ]
+        b"\xe6"  # ^ x23|SHIFT_FLAG (shift 6)
+        b"\x25"  # _ x2d|SHIFT_FLAG (shift -)
+        b"\xe4"  # `
+        b"\x14"  # a
+        b"\x05"  # b
+        b"\x06"  # c
+        b"\x07"  # d
+        b"\x08"  # e
+        b"\x09"  # f
+        b"\x0a"  # g
+        b"\x0b"  # h
+        b"\x0c"  # i
+        b"\x0d"  # j
+        b"\x0e"  # k
+        b"\x0f"  # l
+        b"\x33"  # m
+        b"\x11"  # n
+        b"\x12"  # o
+        b"\x13"  # p
+        b"\x04"  # q
+        b"\x15"  # r
+        b"\x16"  # s
+        b"\x17"  # t
+        b"\x18"  # u
+        b"\x19"  # v
+        b"\x1d"  # w
+        b"\x1b"  # x
+        b"\x1c"  # y
+        b"\x1a"  # z
+        b"\xe1"  # { x2f|SHIFT_FLAG (shift [)
+        b"\xe3"  # | x31|SHIFT_FLAG (shift \)
+        b"\xee"  # } x30|SHIFT_FLAG (shift ])
+        b"\xdf"  # ~ x35|SHIFT_FLAG (shift `)
+        b"\x4c"  # DEL DELETE (called Forward Delete in usb.org document)
+    )
+
+    def __init__(self, keyboard):
+        """Specify the layout for the given keyboard.
+
+        :param keyboard: a Keyboard object. Write characters to this keyboard when requested.
+
+        Example::
+
+            kbd = Keyboard(usb_hid.devices)
+            layout = KeyboardLayoutUS(kbd)
+        """
+
+        self.keyboard = keyboard
+
+    def write(self, string):
+        """Type the string by pressing and releasing keys on my keyboard.
+
+        :param string: A string of ASCII characters.
+        :raises ValueError: if any of the characters are not ASCII or have no keycode
+            (such as some control characters).
+
+        Example::
+
+            # Write abc followed by Enter to the keyboard
+            layout.write('abc\\n')
+        """
+        for char in string:
+            keycode = self._char_to_keycode(char)
+            # If this is a shifted /altgr char, clear the SHIFT/ALTGR flag and press the SHIFT/ALTGR key.
+            if keycode == 0x03:
+                self.keyboard.press(Keycode.SHIFT)
+                self.keyboard.press(0x64)
+            elif keycode & self.ALTGR_FLAG == 192:
+                keycode &= ~self.ALTGR_FLAG
+                self.keyboard.press(Keycode.RIGHT_ALT)
+
+            elif keycode & self.SHIFT_FLAG == 128:
+               keycode &= ~self.SHIFT_FLAG
+               self.keyboard.press(Keycode.SHIFT)
+
+            self.keyboard.press(keycode)
+            self.keyboard.release_all()
+
+    def keycodes(self, char):
+        """Return a tuple of keycodes needed to type the given character.
+
+        :param char: A single ASCII character in a string.
+        :type char: str of length one.
+        :returns: tuple of Keycode keycodes.
+        :raises ValueError: if ``char`` is not ASCII or there is no keycode for it.
+
+        Examples::
+
+            # Returns (Keycode.TAB,)
+            keycodes('\t')
+            # Returns (Keycode.A,)
+            keycode('a')
+            # Returns (Keycode.SHIFT, Keycode.A)
+            keycode('A')
+            # Raises ValueError because it's a accented e and is not ASCII
+            keycode('é')
+        """
+        keycode = self._char_to_keycode(char)
+        if keycode & self.SHIFT_FLAG == 128:
+            return (Keycode.SHIFT, keycode & ~self.SHIFT_FLAG)
+        if keycode & self.ALTGR_FLAG == 192:
+            return (Keycode.ALTGR, keycode & ~self.ALTGR_FLAG)
+
+        return (keycode,)
+
+    def _char_to_keycode(self, char):
+        """Return the HID keycode for the given ASCII character, with the SHIFT_FLAG possibly set.
+
+        If the character requires pressing the Shift key, the SHIFT_FLAG bit is set.
+        You must clear this bit before passing the keycode in a USB report.
+        """
+        keycode = -1
+        char_val = ord(char)
+        if char_val > 128:
+            if char_val == 224: # à
+                keycode = 0x27
+            elif char_val == 231: # ç
+                keycode = 0x26
+            elif char_val == 232: # è
+                keycode = 0x24
+            elif char_val == 233: # é
+                keycode = 0x1f
+            elif char_val == 249: # ù
+                keycode = 0x34
+            elif char_val == 8364: # €
+                keycode = 0xc8
+            elif char_val == 176: # °
+                keycode = 0xad
+            else:
+                raise ValueError("Not an ASCII character.")
+
+        if keycode == -1:
+            keycode = self.ASCII_TO_KEYCODE[char_val]
+
+        if keycode == 0:
+            raise ValueError("No keycode available for character.")
+        return keycode

examples/hid_keyboard_fr.py

@@ -0,0 +1,36 @@
+from time import sleep
+import usb_hid
+from adafruit_hid.keyboard import Keyboard
+from adafruit_hid.keycode import Keycode
+from adafruit_hid.keyboard_layout_fr import KeyboardLayoutFR
+
+keyboard = Keyboard(usb_hid.devices)
+keyboard_layout = KeyboardLayoutFR(keyboard)  # Nous sommes en france :)
+
+#You must have twitter open and the browser windows focus
+def send_tweet(tweet):
+    keyboard_layout.write("n")
+    sleep(0.1)
+    keyboard_layout.write(tweet)
+    sleep(0.1)
+    keyboard.press(Keycode.LEFT_CONTROL)
+    keyboard.press(Keycode.ENTER)
+    keyboard.release_all()
+
+#Test the layout (CIRCUMFLEX not available for now... :( )
+def layout_test():
+    keyboard_layout.write("àçèéù€°!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~~")
+
+sleep(5)
+#send_tweet("hé Salut le monde! @circuitpython")
+#layout_test()
+
+#
+#àçèéù€°!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_àbcdefghijklmnopqrstuvwxyz{|}~~
+
+
+
+
+
+
+