merged ArdUsbKeyboard; added example

UsbKeyboard.hxx

@@ -0,0 +1,397 @@
+//
+// Created by robin on 1/8/16.
+//
+
+UsbKeyboardDevice UsbKeyboard = UsbKeyboardDevice("us");
+
+
+/* We use a simplifed keyboard report descriptor which does not support the
+ * boot protocol. We don't allow setting status LEDs and but we do allow
+ * simultaneous key presses.
+ * The report descriptor has been created with usb.org's "HID Descriptor Tool"
+ * which can be downloaded from http://www.usb.org/developers/hidpage/.
+ * Redundant entries (such as LOGICAL_MINIMUM and USAGE_PAGE) have been omitted
+ * for the second INPUT item.
+ */
+PROGMEM const char usbHidReportDescriptor[35] = { /* USB report descriptor */
+        0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
+        0x09, 0x06,                    // USAGE (Keyboard)
+        0xa1, 0x01,                    // COLLECTION (Application)
+        0x05, 0x07,                    //   USAGE_PAGE (Keyboard)
+        0x19, 0xe0,                    //   USAGE_MINIMUM (Keyboard LeftControl)
+        0x29, 0xe7,                    //   USAGE_MAXIMUM (Keyboard Right GUI)
+        0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
+        0x25, 0x01,                    //   LOGICAL_MAXIMUM (1)
+        0x75, 0x01,                    //   REPORT_SIZE (1)
+        0x95, 0x08,                    //   REPORT_COUNT (8)
+        0x81, 0x02,                    //   INPUT (Data,Var,Abs)
+        0x95, BUFFER_SIZE-1,           //   REPORT_COUNT (simultaneous keystrokes)
+        0x75, 0x08,                    //   REPORT_SIZE (8)
+        0x25, 0x65,                    //   LOGICAL_MAXIMUM (101)
+        0x19, 0x00,                    //   USAGE_MINIMUM (Reserved (no event indicated))
+        0x29, 0x65,                    //   USAGE_MAXIMUM (Keyboard Application)
+        0x81, 0x00,                    //   INPUT (Data,Ary,Abs)
+        0xc0                           // END_COLLECTION
+};
+
+UsbKeyboardDevice::UsbKeyboardDevice(const char* layout)
+    : _layout(0)
+{
+    PORTD = 0; // TODO: Only for USB pins?
+    DDRD |= ~USBMASK;
+
+    cli();
+    usbDeviceDisconnect();
+    usbDeviceConnect();
+
+
+    usbInit();
+
+    sei();
+
+    // TODO: Remove the next two lines once we fix
+    //       missing first keystroke bug properly.
+    memset(reportBuffer, 0, sizeof(reportBuffer));
+    usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
+    setLayout("us");
+}
+
+bool UsbKeyboardDevice::isUsbReady()
+{
+    UsbKeyboard.update();
+    return usbInterruptIsReady();
+}
+
+void UsbKeyboardDevice::setLayout(const char* layout)
+{
+    delete _layout;
+    _layout = new char[strlen(layout)];
+    strcpy(_layout, layout);
+}
+
+int UsbKeyboardDevice::charModAltGr(char c, int* modifier)
+{
+    *modifier = MOD_ALT_RIGHT;
+    return c;
+}
+
+int UsbKeyboardDevice::charModShift(char c, int* modifier)
+{
+    *modifier = MOD_SHIFT_LEFT;
+    return c;
+}
+
+#ifdef ARD_USBKBD_AZERTY
+int UsbKeyboardDevice::charToKeyAzerty(int c, int* modifier)
+{
+    *modifier = 0;
+
+    if (c == '0')
+        return charModShift(KEY_0, modifier);
+    if (c >= '1' && c <= '9')
+        return charModShift(KEY_1 + c - '1', modifier);
+
+    if (c == '\n')
+        return KEY_ENTER;
+    if (c == ' ')
+        return KEY_SPACE;
+
+
+    if (c >= 'a' && c <= 'z')
+    {
+        if (c == 'a')
+            c = 'q';
+        else if (c == 'm')
+            return KEY_SEMICOLON;
+        else if (c == 'q')
+            c = 'a';
+        else if (c == 'w')
+            c = 'z';
+        else if (c == 'z')
+            c = 'w';
+        return KEY_A + c - 'a';
+    }
+    if (c >= 'A' && c <= 'Z')
+    {
+        if (c == 'A')
+            c = 'Q';
+        else if (c == 'M')
+            return charModShift(KEY_SEMICOLON, modifier);
+        else if (c == 'Q')
+            c = 'A';
+        else if (c == 'W')
+            c = 'Z';
+        else if (c == 'Z')
+            c = 'W';
+        return charModShift(KEY_A + c - 'A', modifier);
+    }
+
+    if (c == '~')
+        return charModAltGr(KEY_2, modifier);
+    if (c == '#')
+        return charModAltGr(KEY_3, modifier);
+    if (c == '{')
+        return charModAltGr(KEY_4, modifier);
+    if (c == '[')
+        return charModAltGr(KEY_5, modifier);
+    if (c == '|')
+        return charModAltGr(KEY_6, modifier);
+    if (c == '`')
+        return charModAltGr(KEY_7, modifier);
+    if (c == '\\')
+        return charModAltGr(KEY_8, modifier);
+    if (c == '^')
+        return charModAltGr(KEY_9, modifier);
+    if (c == '@')
+        return charModAltGr(KEY_0, modifier);
+    if (c == ']')
+        return charModAltGr(KEY_HYPHEN, modifier);
+    if (c == '}')
+        return charModAltGr(KEY_EQUAL, modifier);
+    if (c == -75)//µ
+        return charModShift(KEY_BSLASH, modifier);
+    if (c == '*')
+        return KEY_BSLASH;
+
+    if (c == '&')
+        return KEY_1;
+    if (c == -23)//é
+        return KEY_2;
+    if (c == '\"')
+        return KEY_3;
+    if (c == '\'')
+        return KEY_4;
+    if (c == '(')
+        return KEY_5;
+    if (c == '-')
+        return KEY_6;
+    if (c == -24)//è
+        return KEY_7;
+    if (c == '_')
+        return KEY_8;
+    if (c == -25)//ç
+        return KEY_9;
+    if (c == -32)//à
+        return KEY_0;
+    if (c == ')')
+        return KEY_HYPHEN;
+    if (c == '=')
+        return KEY_EQUAL;
+    if (c == '+')
+        return charModShift(KEY_EQUAL, modifier);
+
+    if (c == ',')
+        return KEY_M;
+    if (c == ';')
+        return KEY_COMMA;
+    if (c == ':')
+        return KEY_DOT;
+    if (c == '!')
+        return KEY_SLASH;
+    if (c == -7)//ù
+        return KEY_QUOTE;
+    if (c == '<')
+        return KEYP_NUS_BSLASH;
+
+    if (c == '?')
+        return charModShift(KEY_M, modifier);
+    if (c == '.')
+        return charModShift(KEY_COMMA, modifier);
+    if (c == '/')
+        return charModShift(KEY_DOT, modifier);
+    if (c == -89)//§
+        return charModShift(KEY_SLASH, modifier);
+    if (c == '%')
+        return charModShift(KEY_QUOTE, modifier);
+    if (c == '>')
+        return charModShift(KEYP_NUS_BSLASH, modifier);
+
+    return 0;
+}
+#endif
+
+#ifdef ARD_USBKBD_AZERTY
+int UsbKeyboardDevice::charToKeyQwerty(int c, int* modifier)
+{
+    *modifier = 0;
+    if (c == '0')
+        return KEY_0;
+    if (c >= '1' && c <= '9')
+        return KEY_1 + c - '1';
+    if (c >= 'a' && c <= 'z')
+        return KEY_A + c - 'a';
+    if (c >= 'A' && c <= 'Z')
+        return charModShift(KEY_A + c - 'A', modifier);
+
+    if (c == '\n')
+        return KEY_ENTER;
+    if (c == ' ')
+        return KEY_SPACE;
+
+
+    if (c == '.')
+        return KEY_DOT;
+    if (c == ',')
+        return KEY_COMMA;
+    if (c == '/')
+        return KEY_SLASH;
+    if (c == ';')
+        return KEY_SEMICOLON;
+    if (c == '`')
+        return KEY_TILDE;
+    if (c == '-')
+        return KEY_HYPHEN;
+    if (c == '=')
+        return KEY_EQUAL;
+    if (c == '\'')
+        return KEY_QUOTE;
+    if (c == '~')
+        return charModShift(KEY_TILDE, modifier);
+    if (c == '<')
+        return charModShift(KEY_COMMA, modifier);
+    if (c == '>')
+        return charModShift(KEY_DOT, modifier);
+    if (c == '?')
+        return charModShift(KEY_SLASH, modifier);
+    if (c == ':')
+        return charModShift(KEY_SEMICOLON, modifier);
+
+    if (c == '!')
+        return charModShift(KEY_1, modifier);
+    if (c == '@')
+        return charModShift(KEY_2, modifier);
+    if (c == '#')
+        return charModShift(KEY_3, modifier);
+    if (c == '$')
+        return charModShift(KEY_4, modifier);
+    if (c == '%')
+        return charModShift(KEY_5, modifier);
+    if (c == '^')
+        return charModShift(KEY_6, modifier);
+    if (c == '&')
+        return charModShift(KEY_7, modifier);
+    if (c == '*')
+        return charModShift(KEY_8, modifier);
+    if (c == '(')
+        return charModShift(KEY_9, modifier);
+    if (c == ')')
+        return charModShift(KEY_0, modifier);
+    if (c == '_')
+        return charModShift(KEY_HYPHEN, modifier);
+    if (c == '+')
+        return charModShift(KEY_EQUAL, modifier);
+    if (c == '"')
+        return charModShift(KEY_QUOTE, modifier);
+
+    if (c == '{')
+        return charModShift(KEY_LBRACKET, modifier);
+    if (c == '}')
+        return charModShift(KEY_RBRACKET, modifier);
+    if (c == '|')
+        return charModShift(KEY_BSLASH, modifier);
+
+    if (c == '[')
+        return KEY_LBRACKET;
+    if (c == ']')
+        return KEY_RBRACKET;
+    if (c == '\\')
+        return KEY_BSLASH;
+    return 0;
+}
+#endif
+
+void UsbKeyboardDevice::sendKeyStrokes(const char* str)
+{
+    int (*charToKey)(int,int*) = 0;
+#ifdef ARD_USBKBD_AZERTY
+    if (!strcmp(_layout, "fr"))
+    {
+        charToKey = charToKeyAzerty;
+    }
+#endif
+#ifdef ARD_USBKBD_QWERTY
+    if (!strcmp(_layout, "us"))
+    {
+        charToKey = charToKeyQwerty;
+    }
+#endif
+    if (!charToKey)
+    {
+        return;
+    }
+
+    while (*str)
+    {
+        int modifier = 0;
+        int k = charToKey(*str, &modifier);
+        /*if (!k)
+        {
+          k = KEY_SPACE;
+          char buf[12];
+          itoa((unsigned)*str, buf, 10);
+          sendKeyStrokes(buf);
+        }*/
+        if (k)
+        {
+            UsbKeyboard.sendKeyStroke(k, modifier);
+        }
+        ++str;
+    }
+}
+
+void UsbKeyboardDevice::sendKeyStroke(byte keyStroke, byte modifiers)
+{
+
+    while (!usbInterruptIsReady()) {
+        // Note: We wait until we can send keystroke
+        //       so we know the previous keystroke was
+        //       sent.
+    }
+
+    memset(reportBuffer, 0, sizeof(reportBuffer));
+
+    reportBuffer[0] = modifiers;
+    reportBuffer[1] = keyStroke;
+
+    usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
+
+    while (!usbInterruptIsReady()) {
+        // Note: We wait until we can send keystroke
+        //       so we know the previous keystroke was
+        //       sent.
+    }
+
+    // This stops endlessly repeating keystrokes:
+    memset(reportBuffer, 0, sizeof(reportBuffer));
+    usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
+
+}
+
+
+uchar usbFunctionSetup(uchar data[8])
+{
+    usbRequest_t    *rq = (usbRequest_t *)((void *)data);
+
+    usbMsgPtr = UsbKeyboard.reportBuffer; //
+    if((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS){
+        /* class request type */
+
+        if(rq->bRequest == USBRQ_HID_GET_REPORT){
+            /* wValue: ReportType (highbyte), ReportID (lowbyte) */
+
+            /* we only have one report type, so don't look at wValue */
+            // TODO: Ensure it's okay not to return anything here?
+            return 0;
+
+        }else if(rq->bRequest == USBRQ_HID_GET_IDLE){
+            //            usbMsgPtr = &idleRate;
+            //            return 1;
+            return 0;
+        }else if(rq->bRequest == USBRQ_HID_SET_IDLE){
+            idleRate = rq->wValue.bytes[1];
+        }
+    }else{
+        /* no vendor specific requests implemented */
+    }
+    return 0;
+}

examples/UsbKeyboardDemo2/.gitignore

@@ -0,0 +1 @@
+/.idea

examples/UsbKeyboardDemo2/CMakeLists.txt

@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 2.8.4)
+set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/ArduinoToolchain.cmake)
+set(PROJECT_NAME keyboard)
+project(${PROJECT_NAME})
+
+set(${CMAKE_PROJECT_NAME}_BOARD nano328)
+set(${CMAKE_PROJECT_NAME}_PORT /dev/ttyUSB0)
+
+enable_language(ASM)
+
+set(${CMAKE_PROJECT_NAME}_SKETCH main.ino)
+generate_arduino_firmware(${CMAKE_PROJECT_NAME})

examples/UsbKeyboardDemo2/cmake/ArduinoToolchain.cmake

@@ -0,0 +1,89 @@
+#=============================================================================#
+# Author: Tomasz Bogdal (QueezyTheGreat)
+# Home:   https://github.com/queezythegreat/arduino-cmake
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#=============================================================================#
+set(CMAKE_SYSTEM_NAME Arduino)
+
+set(CMAKE_C_COMPILER   avr-gcc)
+set(CMAKE_CXX_COMPILER avr-g++)
+
+# Add current directory to CMake Module path automatically
+if(EXISTS  ${CMAKE_CURRENT_LIST_DIR}/Platform/Arduino.cmake)
+    set(CMAKE_MODULE_PATH  ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_LIST_DIR})
+endif()
+
+#=============================================================================#
+#                         System Paths                                        #
+#=============================================================================#
+if(UNIX)
+    include(Platform/UnixPaths)
+    if(APPLE)
+        list(APPEND CMAKE_SYSTEM_PREFIX_PATH ~/Applications
+                                             /Applications
+                                             /Developer/Applications
+                                             /sw        # Fink
+                                             /opt/local) # MacPorts
+    endif()
+elseif(WIN32)
+    include(Platform/WindowsPaths)
+endif()
+
+
+#=============================================================================#
+#                         Detect Arduino SDK                                  #
+#=============================================================================#
+if(NOT ARDUINO_SDK_PATH)
+    set(ARDUINO_PATHS)
+
+    foreach(DETECT_VERSION_MAJOR 1)
+        foreach(DETECT_VERSION_MINOR RANGE 5 0)
+            list(APPEND ARDUINO_PATHS arduino-${DETECT_VERSION_MAJOR}.${DETECT_VERSION_MINOR})
+            foreach(DETECT_VERSION_PATCH  RANGE 3 0)
+                list(APPEND ARDUINO_PATHS arduino-${DETECT_VERSION_MAJOR}.${DETECT_VERSION_MINOR}.${DETECT_VERSION_PATCH})
+            endforeach()
+        endforeach()
+    endforeach()
+
+    foreach(VERSION RANGE 23 19)
+        list(APPEND ARDUINO_PATHS arduino-00${VERSION})
+    endforeach()
+
+    if(UNIX)
+        file(GLOB SDK_PATH_HINTS /usr/share/arduino*
+            /opt/local/arduino*
+            /opt/arduino*
+            /usr/local/share/arduino*)
+    elseif(WIN32)
+        set(SDK_PATH_HINTS "C:\\Program Files\\Arduino"
+            "C:\\Program Files (x86)\\Arduino"
+            )
+    endif()
+    list(SORT SDK_PATH_HINTS)
+    list(REVERSE SDK_PATH_HINTS)
+endif()
+
+find_path(ARDUINO_SDK_PATH
+          NAMES lib/version.txt
+          PATH_SUFFIXES share/arduino
+                        Arduino.app/Contents/Java/
+                        Arduino.app/Contents/Resources/Java/
+                        ${ARDUINO_PATHS}
+          HINTS ${SDK_PATH_HINTS}
+          DOC "Arduino SDK path.")
+
+if(ARDUINO_SDK_PATH)
+    list(APPEND CMAKE_SYSTEM_PREFIX_PATH ${ARDUINO_SDK_PATH}/hardware/tools/avr)
+    list(APPEND CMAKE_SYSTEM_PREFIX_PATH ${ARDUINO_SDK_PATH}/hardware/tools/avr/utils)
+else()
+    message(FATAL_ERROR "Could not find Arduino SDK (set ARDUINO_SDK_PATH)!")
+endif()
+
+set(ARDUINO_CPUMENU)
+if(ARDUINO_CPU)
+    set(ARDUINO_CPUMENU ".menu.cpu.${ARDUINO_CPU}")
+endif(ARDUINO_CPU)
+

examples/UsbKeyboardDemo2/main.ino

@@ -0,0 +1,36 @@
+#define ARD_UTILS_DELAYMS
+#define ARD_UTILS_UTF8
+#include "ArdUtils/ArdUtils.h"
+
+#define ARD_USBKBD_AZERTY
+#define ARD_USBKBD_QWERTY
+#include "UsbKeyboard.h"
+
+#define ledPin 13
+
+void setup()
+{
+    pinMode (ledPin, OUTPUT);
+    digitalWrite (ledPin, HIGH);
+}
+
+void loop()
+{
+    WAIT_USB;
+    ArdUtils::delayMs(42);
+
+    char* str = "abcdefghijklmnopqrstuvwxyz\nABCDEFGHIJKLMNOPQRSTUVWXYZ\n0123456789\n&\"\'(-_)=\n~#{[|`\\^@]}\n,;:!$\n?.<>/\n+-*/%\nµù§\néèçà\n";
+
+    ArdUtils::utf8ToAscii(str);
+
+    UsbKeyboard.setLayout("fr");
+    UsbKeyboard.sendKeyStrokes(str);
+
+    ArdUtils::delayMs(4000);
+
+    UsbKeyboard.setLayout("us");
+    UsbKeyboard.sendKeyStrokes(str);
+
+
+    digitalWrite(ledPin, !digitalRead(ledPin));
+}

keycodes.h

@@ -0,0 +1,118 @@
+//
+// Created by robin on 1/9/16.
+//
+
+#ifndef USBKEYBOARD_KEYCODES_H
+#define USBKEYBOARD_KEYCODES_H
+
+
+/* Keyboard usage values, see usb.org's HID-usage-tables document, chapter
+ * 10 Keyboard/Keypad Page for more codes.
+ */
+#define MOD_CONTROL_LEFT    (1<<0)
+#define MOD_SHIFT_LEFT      (1<<1)
+#define MOD_ALT_LEFT        (1<<2)
+#define MOD_GUI_LEFT        (1<<3)
+#define MOD_CONTROL_RIGHT   (1<<4)
+#define MOD_SHIFT_RIGHT     (1<<5)
+#define MOD_ALT_RIGHT       (1<<6)
+#define MOD_GUI_RIGHT       (1<<7)
+
+#define KEY_A       4
+#define KEY_B       5
+#define KEY_C       6
+#define KEY_D       7
+#define KEY_E       8
+#define KEY_F       9
+#define KEY_G       10
+#define KEY_H       11
+#define KEY_I       12
+#define KEY_J       13
+#define KEY_K       14
+#define KEY_L       15
+#define KEY_M       16
+#define KEY_N       17
+#define KEY_O       18
+#define KEY_P       19
+#define KEY_Q       20
+#define KEY_R       21
+#define KEY_S       22
+#define KEY_T       23
+#define KEY_U       24
+#define KEY_V       25
+#define KEY_W       26
+#define KEY_X       27
+#define KEY_Y       28
+#define KEY_Z       29
+#define KEY_1       30
+#define KEY_2       31
+#define KEY_3       32
+#define KEY_4       33
+#define KEY_5       34
+#define KEY_6       35
+#define KEY_7       36
+#define KEY_8       37
+#define KEY_9       38
+#define KEY_0       39
+
+#define KEY_ENTER   40
+#define KEY_ESCAPE  41
+#define KEY_BSPACE  42
+#define KEY_TAB     43
+#define KEY_SPACE   44
+
+
+#define KEY_HYPHEN    45
+#define KEY_EQUAL     46
+#define KEY_LBRACKET  47
+#define KEY_RBRACKET  48
+#define KEY_BSLASH    49
+#define KEY_HASHTAG   50
+#define KEY_SEMICOLON 51
+#define KEY_QUOTE    52
+#define KEY_TILDE     53
+#define KEY_COMMA     54
+#define KEY_DOT       55
+#define KEY_SLASH     56
+#define KEY_CAPSLOCK  57
+
+#define KEY_F1      58
+#define KEY_F2      59
+#define KEY_F3      60
+#define KEY_F4      61
+#define KEY_F5      62
+#define KEY_F6      63
+#define KEY_F7      64
+#define KEY_F8      65
+#define KEY_F9      66
+#define KEY_F10     67
+#define KEY_F11     68
+#define KEY_F12     69
+
+#define KEY_PRINTSCREEN 70
+#define KEY_SCROLLLOCK  71
+#define KEY_PAUSE       72
+#define KEY_INSERT      73
+#define KEY_HOME        74
+#define KEY_PAGEUP      75
+#define KEY_DELETE      76
+#define KEY_END         77
+#define KEY_PAGEDOWN    78
+
+#define KEY_ARROW_RIGHT 79
+#define KEY_ARROW_LEFT  80
+#define KEY_ARROW_DOWN  81
+#define KEY_ARROW_UP    82
+
+
+#define KEY_NUMLOCK     83
+#define KEYP_SLASH      84
+#define KEYP_STAR       85
+#define KEYP_MINUS      86
+#define KEYP_PLUS       87
+#define KEYP_ENTER      88
+
+
+#define KEYP_NUS_BSLASH 100
+
+#endif //USBKEYBOARD_KEYCODES_H