USB HID Device that emulates a Gamecontroller

Dependencies:   mbed

The notebook page for this application is here

Files at this revision

API Documentation at this revision

Comitter:
wim
Date:
Sat Jan 07 21:03:54 2012 +0000
Commit message:
First version

Changed in this revision

USBDevice.lib Show annotated file Show diff for this revision Revisions of this file
USBJoystick.cpp Show annotated file Show diff for this revision Revisions of this file
USBJoystick.h Show annotated file Show diff for this revision Revisions of this file
main.cpp Show annotated file Show diff for this revision Revisions of this file
mbed.bld Show annotated file Show diff for this revision Revisions of this file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/USBDevice.lib	Sat Jan 07 21:03:54 2012 +0000
@@ -0,0 +1,1 @@
+http://mbed.org/users/samux/code/USBDevice/#5e24508aa46e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/USBJoystick.cpp	Sat Jan 07 21:03:54 2012 +0000
@@ -0,0 +1,168 @@
+/* Copyright (c) 2010-2011 mbed.org, MIT License
+* Modified Mouse code for Joystick - WH 2012
+*
+* 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.
+*/
+
+#include "stdint.h"
+#include "USBJoystick.h"
+
+bool USBJoystick::update(int16_t t, int16_t r, int16_t x, int16_t y, uint8_t button, uint8_t hat) {
+             HID_REPORT report;
+   _t = t;
+   _r = r;   
+   _x = x;
+   _y = y;
+   _button = button;     
+   _hat = hat;
+
+   // Fill the report according to the Joystick Descriptor
+   report.data[0] = _t & 0xff;            
+   report.data[1] = _r & 0xff;               
+   report.data[2] = _x & 0xff;            
+   report.data[3] = _y & 0xff;            
+   report.data[4] = ((_button & 0x0f) << 4) | (_hat & 0x0f) ;                                      
+   report.length = 5; 
+           
+   return send(&report);
+}
+ 
+bool USBJoystick::update() {
+   HID_REPORT report;
+
+   // Fill the report according to the Joystick Descriptor
+   report.data[0] = _t & 0xff;            
+   report.data[1] = _r & 0xff;               
+   report.data[2] = _x & 0xff;            
+   report.data[3] = _y & 0xff;            
+   report.data[4] = ((_button & 0x0f) << 4) | (_hat & 0x0f) ;                                      
+   report.length = 5; 
+
+   return send(&report);
+}
+
+bool USBJoystick::throttle(int16_t t) {
+     _t = t;
+     return update();
+}
+
+bool USBJoystick::rudder(int16_t r) {
+     _r = r;
+     return update();
+}
+
+bool USBJoystick::move(int16_t x, int16_t y) {
+     _x = x;
+     _y = y;
+     return update();
+}
+
+bool USBJoystick::button(uint8_t button) {
+     _button = button;
+     return update();
+}
+
+bool USBJoystick::hat(uint8_t hat) {
+     _hat = hat;
+     return update();
+}
+
+
+void USBJoystick::_init() {
+
+   _t = -127;
+   _r = -127;    
+   _x = 0;                       
+   _y = 0;     
+   _button = 0x00;
+   _hat = 0x00;              
+}
+
+
+uint8_t * USBJoystick::reportDesc() {    
+         static uint8_t reportDescriptor[] = {
+
+             USAGE_PAGE(1), 0x01,           // Generic Desktop           
+             LOGICAL_MINIMUM(1), 0x00,      // Logical_Minimum (0)             
+             USAGE(1), 0x04,                // Usage (Joystick)
+             COLLECTION(1), 0x01,           // Application
+               USAGE_PAGE(1), 0x02,            // Simulation Controls
+               USAGE(1), 0xBB,                 // Throttle             
+               USAGE(1), 0xBA,                 // Rudder               
+               LOGICAL_MINIMUM(1), 0x81,       // -127
+               LOGICAL_MAXIMUM(1), 0x7f,       // 127
+               REPORT_SIZE(1), 0x08,
+               REPORT_COUNT(1), 0x02,
+               INPUT(1), 0x02,                 // Data, Variable, Absolute               
+               USAGE_PAGE(1), 0x01,            // Generic Desktop
+               USAGE(1), 0x01,                 // Usage (Pointer)
+               COLLECTION(1), 0x00,            // Physical
+                 USAGE(1), 0x30,                 // X
+                 USAGE(1), 0x31,                 // Y
+//  8 bit values
+                 LOGICAL_MINIMUM(1), 0x81,       // -127
+                 LOGICAL_MAXIMUM(1), 0x7f,       // 127
+                 REPORT_SIZE(1), 0x08,
+                 REPORT_COUNT(1), 0x02,
+                 INPUT(1), 0x02,                 // Data, Variable, Absolute                  
+// 16 bit values
+//                 LOGICAL_MINIMUM(1), 0x00,       // 0
+//                 LOGICAL_MAXIMUM(2), 0xff, 0x7f, // 32767
+//                 REPORT_SIZE(1), 0x10,
+//                 REPORT_COUNT(1), 0x02,
+//                 INPUT(1), 0x02,                 // Data, Variable, Absolute                
+
+               END_COLLECTION(0),               
+// 4 Position Hat Switch
+//               USAGE(1), 0x39,                 // Usage (Hat switch)
+//               LOGICAL_MINIMUM(1), 0x00,       // 0
+//               LOGICAL_MAXIMUM(1), 0x03,       // 3
+//               PHYSICAL_MINIMUM(1), 0x00,      // Physical_Minimum (0)
+//               PHYSICAL_MAXIMUM(2), 0x0E, 0x01, // Physical_Maximum (270)
+//               UNIT(1), 0x14,                  // Unit (Eng Rot:Angular Pos)                            
+//               REPORT_SIZE(1), 0x04,
+//               REPORT_COUNT(1), 0x01,
+//               INPUT(1), 0x02,                 // Data, Variable, Absolute               
+// 8 Position Hat Switch
+               USAGE(1), 0x39,                 // Usage (Hat switch)
+               LOGICAL_MINIMUM(1), 0x00,       // 0
+               LOGICAL_MAXIMUM(1), 0x07,       // 7
+               PHYSICAL_MINIMUM(1), 0x00,      // Physical_Minimum (0)
+               PHYSICAL_MAXIMUM(2), 0x3B, 0x01, // Physical_Maximum (315)
+               UNIT(1), 0x14,                  // Unit (Eng Rot:Angular Pos)                            
+               REPORT_SIZE(1), 0x04,
+               REPORT_COUNT(1), 0x01,
+               INPUT(1), 0x02,                 // Data, Variable, Absolute               
+//
+               USAGE_PAGE(1), 0x09,            // Buttons
+               USAGE_MINIMUM(1), 0x01,         // 1
+               USAGE_MAXIMUM(1), 0x04,         // 4
+               LOGICAL_MINIMUM(1), 0x00,       // 0
+               LOGICAL_MAXIMUM(1), 0x01,       // 1
+               REPORT_SIZE(1), 0x01,
+               REPORT_COUNT(1), 0x04,
+               UNIT_EXPONENT(1), 0x00,         // Unit_Exponent (0)
+               UNIT(1), 0x00,                  // Unit (None)                                           
+               INPUT(1), 0x02,                 // Data, Variable, Absolute
+             END_COLLECTION(0)
+
+        };
+
+      reportLength = sizeof(reportDescriptor);
+      return reportDescriptor;
+}
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/USBJoystick.h	Sat Jan 07 21:03:54 2012 +0000
@@ -0,0 +1,210 @@
+/* USBJoystick.h */
+/* USB device example: Joystick*/
+/* Copyright (c) 2011 ARM Limited. All rights reserved. */
+/* Modified Mouse code for Joystick - WH 2012 */
+
+#ifndef USBJOYSTICK_H
+#define USBJOYSTICK_H
+
+#include "USBHID.h"
+
+#define REPORT_ID_JOYSTICK  4
+
+/* Common usage */
+enum JOY_BUTTON {
+     JOY_B0 = 1,
+     JOY_B1 = 2,
+     JOY_B2 = 4,
+     JOY_B3 = 8,     
+};
+
+#if(0)
+enum JOY_HAT {
+     JOY_HAT_UP      = 0,
+     JOY_HAT_RIGHT   = 1,
+     JOY_HAT_DOWN    = 2,
+     JOY_HAT_LEFT    = 3,     
+     JOY_HAT_NEUTRAL = 4,          
+};
+#else
+enum JOY_HAT {
+     JOY_HAT_UP         = 0,     
+     JOY_HAT_UP_RIGHT   = 1,
+     JOY_HAT_RIGHT      = 2,
+     JOY_HAT_RIGHT_DOWN = 3,
+     JOY_HAT_DOWN       = 4,
+     JOY_HAT_DOWN_LEFT  = 5,     
+     JOY_HAT_LEFT       = 6,     
+     JOY_HAT_LEFT_UP    = 7,          
+     JOY_HAT_NEUTRAL    = 8,          
+};
+#endif
+
+/* X, Y and T limits */
+/* These values do not directly map to screen pixels */
+/* Zero may be interpreted as meaning 'no movement' */
+#define JX_MIN_ABS    (-127)     /*!< The maximum value that we can move to the left on the x-axis */
+#define JY_MIN_ABS    (-127)     /*!< The maximum value that we can move up on the y-axis */
+#define JT_MIN_ABS    (-127)     /*!< The minimum value for the throttle */
+#define JX_MAX_ABS    (127)      /*!< The maximum value that we can move to the right on the x-axis */
+#define JY_MAX_ABS    (127)      /*!< The maximum value that we can move down on the y-axis */
+#define JT_MAX_ABS    (127)      /*!< The maximum value for the throttle */
+
+/**
+ *
+ * USBJoystick example
+ * @code
+ * #include "mbed.h"
+ * #include "USBJoystick.h"
+ *
+ * USBJoystick joystick;
+ *
+ * int main(void)
+ * {
+ *   while (1)
+ *   {
+ *      joystick.move(20, 0);
+ *      wait(0.5);
+ *   }
+ * }
+ *
+ * @endcode
+ *
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "USBJoystick.h"
+ * #include <math.h>
+ *
+ * USBJoystick joystick;
+ *
+ * int main(void)
+ * {
+ *   int16_t i = 0;
+ *   int16_t throttle = 0;
+ *   int16_t rudder = 0;    
+ *   int16_t x = 0;
+ *   int16_t y = 0;
+ *   int32_t radius = 120;
+ *   int32_t angle = 0;
+ *   int8_t button = 0;    
+ *   int8_t hat = 0;    
+ *   
+ *   while (1) {
+ *       // Basic Joystick
+ *       throttle = (i >> 8) & 0xFF; // value -127 .. 128
+ *       rudder = (i >> 8) & 0xFF;   // value -127 .. 128        
+ *       button = (i >> 8) & 0x0F;   // value    0 .. 15, one bit per button     
+ *        hat    = (i >> 8) & 0x07;   // value 0..7 or 8 for neutral         
+ *       i++;        
+ *       
+ *       x = cos((double)angle*3.14/180.0)*radius;  // value -127 .. 128
+ *       y = sin((double)angle*3.14/180.0)*radius;  // value -127 .. 128
+ *       angle += 3;        
+ *
+ *       joystick.update(throttle, rudder, x, y, button, hat);
+ *
+ *       wait(0.001);
+ *   }
+ * }
+ * @endcode
+ */
+
+
+class USBJoystick: public USBHID {
+   public:
+
+        /**
+         *   Constructor
+         *
+         * @param vendor_id Your vendor_id (default: 0x1234)
+         * @param product_id Your product_id (default: 0x0002)
+         * @param product_release Your product_release (default: 0x0001)
+         */
+         USBJoystick(uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0100, uint16_t product_release = 0x0001): 
+             USBHID(0, 0, vendor_id, product_id, product_release, false)
+             { 
+                 _init();
+                 connect();
+             };
+         
+         /**
+         * Write a state of the mouse
+         *
+         * @param t throttle position
+         * @param r rudder position         
+         * @param x x-axis position
+         * @param y y-axis position
+         * @param buttons buttons state
+         * @param hat hat state 0 (up), 1 (right, 2 (down), 3 (left) or 4 (neutral)
+         * @returns true if there is no error, false otherwise
+         */
+         bool update(int16_t t, int16_t r, int16_t x, int16_t y, uint8_t buttons, uint8_t hat);
+
+         /**
+         * Write a state of the mouse
+         *
+         * @returns true if there is no error, false otherwise
+         */
+         bool update();
+
+         /**
+         * Move the throttle position
+         *
+         * @param t throttle position
+         * @returns true if there is no error, false otherwise
+         */
+         bool throttle(int16_t t);
+         
+         /**
+         * Move the rudder position
+         *
+         * @param r rudder position
+         * @returns true if there is no error, false otherwise
+         */        
+         bool rudder(int16_t r);         
+
+         /**
+         * Move the cursor to (x, y)
+         *
+         * @param x-axis position
+         * @param y-axis position
+         * @returns true if there is no error, false otherwise
+         */
+         bool move(int16_t x, int16_t y);
+         
+         /**
+         * Press one or several buttons
+         *
+         * @param button button state
+         * @returns true if there is no error, false otherwise
+         */
+         bool button(uint8_t button);
+         
+         /**
+         * Press hat
+         *
+         * @param hat hat state
+         * @returns true if there is no error, false otherwise
+         */
+         bool hat(uint8_t hat);
+         
+         /*
+         * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
+         *
+         * @returns pointer to the report descriptor
+         */
+         virtual uint8_t * reportDesc();
+
+     private:
+         int8_t _t;     
+         int8_t _r;              
+         int8_t _x;                       
+         int8_t _y;     
+         uint8_t _button;
+         uint8_t _hat; 
+         
+         void _init();                 
+};
+
+#endif
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Sat Jan 07 21:03:54 2012 +0000
@@ -0,0 +1,65 @@
+#include "mbed.h"
+#include "USBMouse.h"
+#include "USBJoystick.h"
+
+//USBMouse mouse;
+USBJoystick joystick;
+
+// Variables for Heartbeat and Status monitoring
+DigitalOut myled1(LED1);
+DigitalOut myled2(LED2);
+DigitalOut myled3(LED3);
+DigitalOut heartbeatLED(LED4);
+
+Ticker heartbeat;
+Serial pc(USBTX, USBRX); // tx, rx
+
+// Heartbeat monitor
+void pulse() {
+  heartbeatLED = !heartbeatLED;
+}
+
+void heartbeat_start() {
+  heartbeat.attach(&pulse, 0.5);
+}
+
+void heartbeat_stop() {
+  heartbeat.detach();
+}
+
+
+int main() {
+    int16_t i = 0;
+    int16_t throttle = 0;
+    int16_t rudder = 0;    
+    int16_t x = 0;
+    int16_t y = 0;
+    int32_t radius = 120;
+    int32_t angle = 0;
+    int8_t button = 0;    
+    int8_t hat = 0;    
+    
+    pc.printf("Hello World!\n\r");
+
+    heartbeat_start();
+
+    while (1) {
+        // Basic Joystick
+        throttle = (i >> 8) & 0xFF; // value -127 .. 128
+        rudder = (i >> 8) & 0xFF;   // value -127 .. 128        
+        button = (i >> 8) & 0x0F;   // value    0 .. 15, one bit per button     
+//        hat    = (i >> 8) & 0x03;   // value 0, 1, 2, 3 or 4 for neutral 
+        hat    = (i >> 8) & 0x07;   // value 0..7 or 8 for neutral         
+        i++;        
+        
+        x = cos((double)angle*3.14/180.0)*radius;  // value -127 .. 128
+        y = sin((double)angle*3.14/180.0)*radius;  // value -127 .. 128
+        angle += 3;        
+
+        joystick.update(throttle, rudder, x, y, button, hat);
+
+        wait(0.001);
+    }
+    
+    pc.printf("Bye World!\n\r");                           
+}
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed.bld	Sat Jan 07 21:03:54 2012 +0000
@@ -0,0 +1,1 @@
+http://mbed.org/users/mbed_official/code/mbed/builds/7110ebee3484