Introduced support for Consumer Control devices on Leonardo and Micro

Author: Stefan Jones

Diff for: hardware/arduino/cores/arduino/HID.cpp

@@ -25,10 +25,11 @@
 
 //#define RAWHID_ENABLED
 
-//	Singletons for mouse and keyboard
-
+//	Singletons for mouse, keyboard and remote
+ 
 Mouse_ Mouse;
 Keyboard_ Keyboard;
+Remote_ Remote;
 
 //================================================================================
 //================================================================================
@@ -124,8 +125,61 @@ const u8 _hidReportDescriptor[] = {
 	0x95, 64,				// report count RX
 	0x09, 0x02,				// usage
 	0x91, 0x02,				// Output (array)
-	0xC0					// end collection
+	0xC0,					// end collection
 #endif
+
+//-----------------------------------------------------------------------------
+
+    /* Cross-platform support for controls found on IR Remotes */
+
+    0x05, 0x0c,                    //	Usage Page (Consumer Devices)
+    0x09, 0x01,                    //	Usage (Consumer Control)
+    0xa1, 0x01,                    //	Collection (Application)
+    0x85, 0x04,                    //	REPORT_ID (4)
+    0x15, 0x00,                    //	Logical Minimum (0)
+    0x25, 0x01,                    //	Logical Maximum (1)
+    0x09, 0xe9,                    //	Usage (Volume Up)
+    0x09, 0xea,                    //	Usage (Volume Down)
+    0x75, 0x01,                    //	Report Size (1)
+    0x95, 0x02,                    //	Report Count (2)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xe2,                    //	Usage (Mute)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb0,                    //	Usage (Play)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb1,                    //	Usage (Pause)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb7,                    //	Usage (Stop)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb5,                    //	Usage (Next)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb6,                    //	Usage (Previous)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb3,                    //	Usage (Fast Forward)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x09, 0xb4,                    //	Usage (Rewind)
+    0x95, 0x01,                    //	Report Count (1)
+    0x81, 0x06,                    //	Input (Data, Variable, Relative)
+
+    0x95, 0x06,                    //	Report Count (6) Number of bits remaining in byte
+    0x81, 0x07,                    //	Input (Constant, Variable, Relative) 
+    0xc0                           //End Collection
+
 };
 
 extern const HIDDescriptor _hidInterface PROGMEM;
@@ -515,6 +569,110 @@ size_t Keyboard_::write(uint8_t c)
 	return (p);					// just return the result of press() since release() almost always returns 1
 }
 
+//================================================================================
+//================================================================================
+//	Remote
+ 
+Remote_::Remote_(void)
+{
+}
+ 
+void Remote_::begin(void) 
+{
+}
+ 
+void Remote_::end(void) 
+{
+}
+ 
+void Remote_::increase(void)
+{
+	u8 m[2];
+	m[0] = VOLUME_UP;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::decrease(void)
+{
+	u8 m[2];
+	m[0] = VOLUME_DOWN;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::mute(void)
+{
+	u8 m[2];
+	m[0] = VOLUME_MUTE;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::play(void)
+{
+	u8 m[2];
+	m[0] = REMOTE_PLAY;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::pause(void)
+{
+	u8 m[2];
+	m[0] = REMOTE_PAUSE;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::stop(void)
+{
+	u8 m[2];
+	m[0] = REMOTE_STOP;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::next(void)
+{
+	u8 m[2];
+	m[0] = REMOTE_NEXT;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::previous(void)
+{
+	u8 m[2];
+	m[0] = REMOTE_PREVIOUS;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::forward(void)
+{
+	u8 m[2];
+	m[0] = 0;
+	m[1] = REMOTE_FAST_FORWARD >> 8;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::rewind(void)
+{
+	u8 m[2];
+	m[0] = 0;
+	m[1] = REMOTE_REWIND >> 8;
+	HID_SendReport(4,m,2);
+}
+ 
+void Remote_::clear(void)
+{
+	u8 m[2];
+	m[0] = 0;
+	m[1] = 0;
+	HID_SendReport(4,m,2);
+}
+
 #endif
 
 #endif /* if defined(USBCON) */

Diff for: hardware/arduino/cores/arduino/USBAPI.h

@@ -135,6 +135,50 @@ class Keyboard_ : public Print
 };
 extern Keyboard_ Keyboard;
 
+//================================================================================
+//================================================================================
+//	Remote 
+ 
+#define REMOTE_CLEAR 0
+#define VOLUME_UP 1
+#define VOLUME_DOWN 2
+#define VOLUME_MUTE 4
+#define REMOTE_PLAY 8
+#define REMOTE_PAUSE 16
+#define REMOTE_STOP 32
+#define REMOTE_NEXT 64
+#define REMOTE_PREVIOUS 128
+#define REMOTE_FAST_FORWARD 256
+#define REMOTE_REWIND 512
+ 
+class Remote_
+{
+private:
+public:
+	Remote_(void);
+	void begin(void);
+	void end(void);
+ 
+	// Volume
+	void increase(void);
+	void decrease(void);
+	void mute(void);
+ 
+	// Playback
+	void play(void);
+	void pause(void);
+	void stop(void);
+ 
+	// Track Controls
+	void next(void);
+	void previous(void);
+	void forward(void);
+	void rewind(void);
+ 
+	// Send an empty report to prevent repeated actions
+	void clear(void);
+};
+extern Remote_ Remote;
 //================================================================================
 //================================================================================
 //	Low level API