Update Readme.md

Add files via upload
2018-05-22 22:59:03 +02:00 · 2018-05-22 22:58:27 +02:00 · 2018-05-22 22:58:09 +02:00 · 2018-05-22 22:57:17 +02:00 · 2018-01-04 18:31:23 +01:00 · 2018-01-04 12:48:19 -03:00
23 changed files with 466 additions and 284 deletions
--- a/.gitmodules
+++ b/.gitmodules
@ -0,0 +1,3 @@
+[submodule "HID.wiki"]
+	path = HID.wiki
+	url = https://github.com/NicoHood/HID.wiki.git
--- a/HID.wiki
+++ b/HID.wiki
@ -0,0 +1 @@
+Subproject commit a1a0b086985dec037d7e7d86c6b2d5816207f202
--- a/Readme.md
+++ b/Readme.md
@ -1,234 +1,27 @@
-Arduino HID Project 2.4.3
+**Arduino Silly Keyboard** forked from  Arduino HID Project 2.4.4
 =========================

-![Header Picture](header.jpg)
+![Header Picture](virtualkeyb.jpg)

-This project went through a lot of phases and has now reached a new Arduino ~~USB-Core~~ Library
-with a lot of new functions like extended HID. It also supports HoodLoader1+2.
-The idea is to enable enhanced USB functions to almost all 'standard' Arduino boards.
+This is targetted at the Leonardo or compatible boards (32U4) and will be built around one of these:
+https://www.aliexpress.com/item/Beetle-Virtual-Keyboard-BadUSB-Pro-Micro-ATMEGA32U4-Module-Mini-Development-Expansion-Board-For-Arduino-Leonardo-R3/32847715254.html?spm=2114.search0104.3.1.7d542341ScymPz&ws_ab_test=searchweb0_0,searchweb201602_1_10152_10151_10065_10344_10068_10342_10343_10340_5722611_10341_10696_5722911_5722811_10084_5722711_10083_10618_10307_10134_5711211_10059_308_100031_10103_10624_10623_10622_10621_10620_5711311_5722511_10814_10815,searchweb201603_25,ppcSwitch_5&algo_expid=c50f562a-35a5-4cbe-9391-2b1586b8823e-0&algo_pvid=c50f562a-35a5-4cbe-9391-2b1586b8823e&priceBeautifyAB=0

-**Supported Arduinos (IDE 1.6.7 or higher!):**
-* Uno (with [HoodLoader2](https://github.com/NicoHood/HoodLoader2))
-* Mega (with [HoodLoader2](https://github.com/NicoHood/HoodLoader2))
-* Leonardo
-* (Pro)Micro
-* Any other 8u2/16u2/at90usb8/162/32u2/32u4 compatible board
-* No SAM/ARM support (Due, Zero etc)
+It's going to act like a keyboard (HID) and will write random words at random times with the purpose of being an entertaining toy for the office to play (innocent) jokes on colleagues.

-**Supported HID devices:**
-* Keyboard with Leds out (8 modifiers + 6 keys pressed at the same time, + 1 limited linux consumer key)
-* ~~Teensy Keyboard with different keyboard layouts (german, french and many more)~~ soon
-* NKRO Keyboard with Leds out (press up to 113 keys at the same time)
-* Mouse (5 buttons, move, wheel)
-* BootKeyboard/BootMouse BIOS protocol support
-* Absolute Mouse
-* Consumer/Media Keys (4 keys for music player, web browser and more)
-* System Key (for PC standby/shutdown)
-* Gamepad (32 buttons, 4 16bit axis, 2 8bit axis, 2 D-Pads)
-* RawHID
-* Each device is available as single or multi report device (except RawHID)
+If I get clever, then it will insert words at just the right time when someone is typing - for example when the space bar is pressed and it's the perfect perfect time to insert a new new word word. Replay replay retyping things that were already typed would also be great. But I have some learning to do first! 

-See the [wiki](https://github.com/NicoHood/HID/wiki/Features) for more information about features etc.
-
-Wiki
-====
-
-All documentation moved to the [wiki page](https://github.com/NicoHood/HID/wiki).
-
-An offline snapshot is available in [releases](https://github.com/NicoHood/HID/releases).
+The project will advance more when the hardware arrives (sometime in the next 5-6 weeks).


-Contact
-=======
-
-You can contact me on my wordpress blog in the contact section.
-
-www.nicohood.de
-
-
-Version History
-===============
-```
-2.4.3 Release (02.03.2016)
-* Fixed NKRO Keyboard modifier add() #76
-
-2.4.2 Release (04.01.2016)
-* RawHID >64 byte fix (Arduino IDE 1.6.8 fix)
-* Fixed Keyboard modifier add() issue #68
-
-2.4.1 Release (19.12.2015)
-* RawHID Improvements
-* Added Keyboard Feature Report
-* NKRO and Keyboard API fixes
-* Arduino library manager fix
-
-2.4 Release (06.11.2015)
-* Added Arduino IDE 1.6.6 compatibility with Pluggable HID
-* Improved Pluggable HID (see Arduyuino changelog for my improvements)
-* Changed USB-Core into a simple library, only made possible with Pluggable HID
-* Removed HID presets in boards menu (like mouse + keyboard + consumer + system)
-* Added NKRO Keyboard
-* Added Led report for Keyboard
-* Added 1 Linux consumer key for keyboard
-* Added BootKeyboard/Mouse support (BIOS compatibility)
-* Added RawHID
-* Added a few key definitions
-* Renew whole Keyboard API and its definitions via enum
-* Uses .alinkage custom IDE option
-* Improved and updated examples
-* A lot of other minor and major fixes I missed to mention.
-
-2.3 Release (never released)
-* Updated Libraries
-* Updated Arduino Core
-* Added Minor Consumer definitions
-* Fixed platforms.txt
-* SERIAL_RX_BUFFER_SIZE reverted to 16 (TODO add -D to build option)
-
-2.2 Release (12.04.2015)
-* added experimental, not finished nor documented HID-Bridge between 16u2 and 328/2560
-* increased HW Serial1 RX buffer size from 16 to 32 (TX still 16)
-* added colour highlighting (through HID-Bridge library)
-* removed fixed size in report buffers
-* used HID_KeyboardReport_Data_t now in Keyboard API
-* Arduino as ISP fix for 328
-* Upload verification on USB hubs fix for HL2.0.4
-* No USB workaround for Leonardo integrated into variants
-* Changed USB Wakeup in System API
-* Consumer Key fix (issue #3)
-* Gamepad fix (issue #14)
-* Added Keycode example
-* Mouse press + release fix
-
-2.1 Release (28.01.2015)
-* Reworked the whole USB-Core from scratch
-* Uses less flash if HID or Serial is not used
-* Extended and compacter(flash) HID Report Descriptors
-* Fixed USB Device Descriptor
-* Added u2 compatibility with smaller USB_EP_SIZE (16u2 etc)
-* Added Serial Event for LineEncoding and LineState
-* Added Serial Function to get dtr state, line encoding etc
-* Added Keyboard Led Out report to get Led states (for numlock etc)
-* Made CDC-Core independent from USB-Core
-* Made HID-Core independent from USB-Core
-* Made HID-API independent from HID-Core
-* Removed not needed virtual functions in Keyboard
-* Made HID Reports and its IDs replaceable via pins_Arduino.h
-* Added Absolute Mouse
-* Removed uint8_t USBPutChar(uint8_t c); in HID.cpp
-* Made void Recv(volatile u8* data, u8 count) in USBCore.cpp static inline
-* HID-APIs sends a clean report on begin() and end() now.
-* Removed virtual functions in Keyboard API
-* Added Keycode functions in Keyboard API
-* Inlined a lot of the HID API functions to save flash
-* Added Gamepad
-* Added RawHID API (but RawHID itself isnt working still)
-* Added USB Wakeup support
-* Separated USB-Core in its own folder
-* Added HID Tables
-* USB-Serial now fully reprogrammable
-* Easy USB-Core selection via Tools->USB-Core
-* Added Arduino as ISP fix for 32u4 and 16u2
-* Moved documentation to the wiki
-* Added AVR libraries to the core with the better SoftSerial
-
-2.0 Release (29.11.2014)
-* Added HoodLoader2
-* Separated HoodLoader1&2 more
-* Added u2 series for USB-Core
-* Extended USB core and fixed minor things for the u2 series
-* Added Led Out report.
-* Added CDC Line state
-* Reworked the whole library structure again
-
-1.8 Beta Release (26.08.2014)
-* Changes in the Hoodloader1:
- * **Huge improvements**, see Hoodloader1 repository
- * Reworked the whole library, easy installation now
- * HID fixes for Media Keys/Ubuntu
- * Removed Joystick, added 4 Gamepads
-
-1.7.3 Beta Release (10.08.2014)
-* Changes in the Hoodloader1:
- * Fixed HID flush bug (1.6 - 1.7.2)
-
-1.7.2 Beta Release (10.08.2014)
-* Changes in the Hoodloader1:
- * Added Lite version for 8u2
- * Added Versions that show up as Uno/Mega (not recommended)
- * Makefile and structure changes
-
-1.7.1 Beta Release (10.08.2014)
-* Changes in the Hoodloader1:
- * Fixed HID deactivation bug
-
-1.7 Beta Release (10.08.2014)
-* Changes in the Hoodloader1:
- * Works as ISP now. See Hoodloader1 Repository for more information.
- * Exceeded 8kb limit. For flashing a 8u2 use v1.6 please!
-* Changed Readme text
-
-1.6 Beta Release (09.08.2014)
-* Bugfixes in the Hoodloader1:
- * Changed HID management (not blocking that much, faster)
- * added RawHID in/out (HID to Serial)
-* Added RawHID Class and example
-
-1.5 Beta Release (21.07.2014)
-* Moved Hoodloader1 source to a separate Github page
-* Bugfixes in the Hoodloader:
- * Firmware is still available here
- * Overall a lot of ram improvements, now with a big global union of ram
- * Removed USBtoUSART buffer (not needed, saved 128/500 bytes)
- * Removed Lite version because of better ram usage not needed
- * Separated different modes better to not cause any errors in default mode
- * Improved the deactivate option
- * Integrated NHP directly
- * Replaced LightweightRingbuffer with native Lufa Ringbuffer
- * Improved writing to CDC Host
- * Fixed a bug in checkNHPProtocol: & needs to be a ==
- * General structure changes
- * Improved stability
- * Fixed Arduino as ISP bug
-
-1.4.1 Beta Release (10.07.2014)
-* #define Bugfix in USBAPI.h
-
-1.4 Beta Release (10.07.2014)
-* Bugfixes in the Hoodloader1:
- * Added Lite Version with less ram usage
- * Changed PIDs, edited driver file
-* merged v1.0.x and v1.5.x together (both are compatible!)
-* added IDE v1.5.7 support
-* added Tutorials
-
-1.3 Beta Release (01.07.2014)
-* Bugfixes in the Hoodloader1:
- * Improved ram usage
-* **Important NHP fix inside the HID Class for Uno/Mega**
-
-1.2 Beta Release (22.06.2014)
-* Added 1.0.x/1.5.x support
-* Bugfixes in the Hoodloader1:
- * Sometimes HID Devices weren't updating
-   when using more than 1 Device (set forcewrite to true)
- * Fast updates crashed the bootloader
-  (too much ram usage, set CDC buffer from 128b to 100b each)
-* Minor file structure changes
-
-1.1 Beta Release (05.06.2014)
-* Added Leonardo/Micro support
-* Included NicoHoodProtocol
-* Minor fixes
-
-1.0 Beta Release (03.06.2014)
-```
+Forked at
+2.4.4 Release (27.01.2017)
+* Added releaseAll() to Mouse API
+* Fix flexible array errors


 Licence and Copyright
 =====================
-If you use this library for any cool project let me know!
-
+Here's the original License conditions from NicoHood (AWESOME WORK!). 
 ```
 Copyright (c) 2014-2016 NicoHood
 See the readme for credit to other people.
--- a/examples/SurfaceDial/connection_diagram.png
+++ b/examples/SurfaceDial/connection_diagram.png
--- a/examples/SurfaceDial/surface_dial.ino
+++ b/examples/SurfaceDial/surface_dial.ino
@ -0,0 +1,85 @@
+/*
+  Copyright (c) 2017 wind-rider
+  See the readme for credit to other people.
+
+  Surface dial example
+  
+  Use an encoder and a button to create a Surface Dial-compatible device.
+  See the connection diagram how to wire it up.
+
+  Please note that:
+   - I tested it using an Arduino Pro Micro; TinkerCad didn't have that in its component library
+   - you obviously don't need a motor, but TinkerCad didn't have a separate encoder
+
+  The encoder processing code is coming from https://www.allwinedesigns.com/blog/pocketnc-jog-wheel
+*/
+
+#include "HID-Project.h"
+
+// input pins for encoder channel A and channel B
+int pinA = 2;
+int pinB = 3;
+
+// input pin for pushbutton
+int pinButton = 4;
+
+volatile bool previousButtonValue = false;
+
+volatile int previous = 0;
+volatile int counter = 0;
+
+void setup() {
+  pinMode(pinA, INPUT_PULLUP); 
+  pinMode(pinB, INPUT_PULLUP);
+
+  pinMode(pinButton, INPUT_PULLUP);
+
+  attachInterrupt(digitalPinToInterrupt(pinA), changed, CHANGE); 
+  attachInterrupt(digitalPinToInterrupt(pinB), changed, CHANGE);
+  
+  SurfaceDial.begin();
+}
+
+void changed() {
+  int A = digitalRead(pinA); 
+  int B = digitalRead(pinB);
+
+  int current = (A << 1) | B;
+  int combined  = (previous << 2) | current;
+   
+  if(combined == 0b0010 || 
+     combined == 0b1011 ||
+     combined == 0b1101 || 
+     combined == 0b0100) {
+    counter++;
+  }
+   
+  if(combined == 0b0001 ||
+     combined == 0b0111 ||
+     combined == 0b1110 ||
+     combined == 0b1000) {
+    counter--;
+  }
+
+  previous = current;
+}
+
+void loop(){ 
+  bool buttonValue = digitalRead(pinButton);
+  if(buttonValue != previousButtonValue){
+    if(buttonValue) {
+      SurfaceDial.press();
+    } else {
+      SurfaceDial.release();
+    }    
+    previousButtonValue = buttonValue;
+  }
+
+  if(counter >= 4) {
+    SurfaceDial.rotate(10);
+    counter -= 4;
+  } else if(counter <= -4) {
+    SurfaceDial.rotate(-10);
+    counter += 4;
+  } 
+}
--- a/library.properties
+++ b/library.properties
@ -1,5 +1,5 @@
 name=HID-Project
-version=2.4.3
+version=2.4.4
 author=NicoHood
 maintainer=NicoHood <blog@NicoHood.de>
 sentence=Extended HID Functions for Arduino
--- a/src/HID-APIs/AbsoluteMouseAPI.h
+++ b/src/HID-APIs/AbsoluteMouseAPI.h
@ -39,9 +39,9 @@ THE SOFTWARE.

 typedef union{
 	// Absolute mouse report: 8 buttons, 2 absolute axis, wheel
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	struct{
 		uint8_t buttons;
 		int16_t xAxis;
@ -71,12 +71,12 @@ public:
 	inline void move(int x, int y, signed char wheel = 0);
 	inline void press(uint8_t b = MOUSE_LEFT);
 	inline void release(uint8_t b = MOUSE_LEFT);
+	inline void releaseAll(void);
 	inline bool isPressed(uint8_t b = MOUSE_LEFT);
-	
+
 	// Sending is public in the base class for advanced users.
 	virtual void SendReport(void* data, int length) = 0;
 };

 // Implementation is inline
 #include "AbsoluteMouseAPI.hpp"
-
--- a/src/HID-APIs/AbsoluteMouseAPI.hpp
+++ b/src/HID-APIs/AbsoluteMouseAPI.hpp
@ -32,7 +32,7 @@ void AbsoluteMouseAPI::buttons(uint8_t b){
 }

 int16_t AbsoluteMouseAPI::qadd16(int16_t base, int16_t increment) {
-	// Separate between subtracting and adding  
+	// Separate between subtracting and adding
 	if (increment < 0) {
 		// Subtracting more would cause an undefined overflow
 		if ((int16_t)0x8000 - increment > base)
@ -50,7 +50,7 @@ int16_t AbsoluteMouseAPI::qadd16(int16_t base, int16_t increment) {
 	return base;
 }

-AbsoluteMouseAPI::AbsoluteMouseAPI(void): 
+AbsoluteMouseAPI::AbsoluteMouseAPI(void):
 xAxis(0), yAxis(0), _buttons(0)
 {
 	// Empty
@ -98,6 +98,11 @@ void AbsoluteMouseAPI::release(uint8_t b){
 	buttons(_buttons & ~b);
 }

+void AbsoluteMouseAPI::releaseAll(void){
+	_buttons = 0;
+	moveTo(xAxis, yAxis, 0);
+}
+
 bool AbsoluteMouseAPI::isPressed(uint8_t b){
 	// check LEFT by default
 	if ((b & _buttons) > 0)
--- a/src/HID-APIs/ConsumerAPI.h
+++ b/src/HID-APIs/ConsumerAPI.h
@ -49,6 +49,9 @@ enum ConsumerKeycode : uint16_t {
 	MEDIA_VOLUME_DOWN	= 0xEA,
 	MEDIA_VOL_DOWN	= 0xEA, // Alias

+	CONSUMER_BRIGHTNESS_UP = 0x006F,
+	CONSUMER_BRIGHTNESS_DOWN = 0x0070,
+
 	CONSUMER_SCREENSAVER = 0x19e,

 	CONSUMER_PROGRAMMABLE_BUTTON_CONFIGURATION = 0x182,
@ -450,9 +453,9 @@ enum ConsumerKeycode : uint16_t {

 typedef union {
 	// Every usable Consumer key possible, up to 4 keys presses possible
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	ConsumerKeycode keys[4];
 	struct {
 		ConsumerKeycode key1;
@ -472,7 +475,7 @@ public:
 	inline void press(ConsumerKeycode m);
 	inline void release(ConsumerKeycode m);
 	inline void releaseAll(void);
-	
+
 	// Sending is public in the base class for advanced users.
 	virtual void SendReport(void* data, int length) = 0;

@ -482,4 +485,3 @@ protected:

 // Implementation is inline
 #include "ConsumerAPI.hpp"
-
--- a/src/HID-APIs/DefaultKeyboardAPI.h
+++ b/src/HID-APIs/DefaultKeyboardAPI.h
@ -29,9 +29,9 @@ THE SOFTWARE.

 typedef union{
 	// Low level key report: up to 6 keys and shift, ctrl etc at once
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	struct{
 		uint8_t modifiers;
 		uint8_t reserved;
@ -74,4 +74,3 @@ private:

 // Implementation is inline
 #include "DefaultKeyboardAPI.hpp"
-
--- a/src/HID-APIs/GamepadAPI.h
+++ b/src/HID-APIs/GamepadAPI.h
@ -41,9 +41,9 @@ THE SOFTWARE.

 typedef union {
 	// 32 Buttons, 6 Axis, 2 D-Pads
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	uint32_t buttons;

 	struct{
@ -117,7 +117,7 @@ public:
 	inline void rzAxis(int8_t a);
 	inline void dPad1(int8_t d);
 	inline void dPad2(int8_t d);
-	
+
 	// Sending is public in the base class for advanced users.
 	virtual void SendReport(void* data, int length) = 0;

@ -127,4 +127,3 @@ protected:

 // Implementation is inline
 #include "GamepadAPI.hpp"
-
--- a/src/HID-APIs/MouseAPI.h
+++ b/src/HID-APIs/MouseAPI.h
@ -39,9 +39,9 @@ THE SOFTWARE.

 typedef union{
 	// Mouse report: 8 buttons, position, wheel
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	struct{
 		uint8_t buttons;
 		int8_t xAxis;
@ -53,9 +53,9 @@ typedef union{
 typedef union{
 	// BootMouse report: 3 buttons, position
 	// Wheel is not supported by boot protocol
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	struct{
 		uint8_t buttons;
 		int8_t xAxis;
@ -70,14 +70,15 @@ public:
  inline void begin(void);
  inline void end(void);
  inline void click(uint8_t b = MOUSE_LEFT);
-  inline void move(signed char x, signed char y, signed char wheel = 0); 
+  inline void move(signed char x, signed char y, signed char wheel = 0);
  inline void press(uint8_t b = MOUSE_LEFT);   // press LEFT by default
  inline void release(uint8_t b = MOUSE_LEFT); // release LEFT by default
+	inline void releaseAll(void);
  inline bool isPressed(uint8_t b = MOUSE_LEFT); // check LEFT by default
-  
+
  // Sending is public in the base class for advanced users.
  virtual void SendReport(void* data, int length) = 0;
-  
+
 protected:
  uint8_t _buttons;
  inline void buttons(uint8_t b);
--- a/src/HID-APIs/MouseAPI.hpp
+++ b/src/HID-APIs/MouseAPI.hpp
@ -29,12 +29,12 @@ MouseAPI::MouseAPI(void) : _buttons(0)
 	// Empty
 }

-void MouseAPI::begin(void) 
+void MouseAPI::begin(void)
 {
    end();
 }

-void MouseAPI::end(void) 
+void MouseAPI::end(void)
 {
    _buttons = 0;
    move(0, 0, 0);
@ -67,7 +67,7 @@ void MouseAPI::buttons(uint8_t b)
 	}
 }

-void MouseAPI::press(uint8_t b) 
+void MouseAPI::press(uint8_t b)
 {
 	buttons(_buttons | b);
 }
@ -77,10 +77,15 @@ void MouseAPI::release(uint8_t b)
 	buttons(_buttons & ~b);
 }

+void MouseAPI::releaseAll(void)
+{
+  _buttons = 0;
+	move(0,0,0);
+}
+
 bool MouseAPI::isPressed(uint8_t b)
 {
-	if ((b & _buttons) > 0) 
+	if ((b & _buttons) > 0)
 		return true;
 	return false;
 }
-
--- a/src/HID-APIs/NKROKeyboardAPI.h
+++ b/src/HID-APIs/NKROKeyboardAPI.h
@ -32,9 +32,9 @@ THE SOFTWARE.

 typedef union{
 	// Modifier + keymap + 1 custom key
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	struct{
 		uint8_t modifiers;
 		uint8_t keys[NKRO_KEY_COUNT / 8];
@ -43,7 +43,7 @@ typedef union{
 	uint8_t allkeys[2 + NKRO_KEY_COUNT / 8];
 } HID_NKROKeyboardReport_Data_t;

-	
+
 class NKROKeyboardAPI : public KeyboardAPI
 {
 public:
@ -62,4 +62,3 @@ private:

 // Implementation is inline
 #include "NKROKeyboardAPI.hpp"
-
--- a/src/HID-APIs/SurfaceDialAPI.h
+++ b/src/HID-APIs/SurfaceDialAPI.h
@ -0,0 +1,66 @@
+/*
+Copyright (c) 2014-2015 NicoHood
+See the readme for credit to other people.
+
+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 guard
+#pragma once
+
+#include <Arduino.h>
+#include "HID-Settings.h"
+
+typedef union{
+	// SurfaceDial report: 1 button, 15-bit rotation, position
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
+	struct{
+		uint16_t button: 1;
+		uint16_t rotation: 15;
+		//int8_t xAxis;
+		//int8_t yAxis;
+		
+	};
+} HID_SurfaceDialReport_Data_t;
+
+class SurfaceDialAPI
+{
+public:
+  inline SurfaceDialAPI(void);
+  inline void begin(void);
+  inline void end(void);
+  inline void click(void);
+  inline void rotate(int16_t rotation);
+  inline void press(void);
+  inline void release(void);
+	inline void releaseAll(void);
+  inline bool isPressed();
+
+  // Sending is public in the base class for advanced users.
+  virtual void SendReport(void* data, int length) = 0;
+
+protected:
+  bool _button;
+  inline void button(bool b);
+};
+
+// Implementation is inline
+#include "SurfaceDialAPI.hpp"
--- a/src/HID-APIs/SurfaceDialAPI.hpp
+++ b/src/HID-APIs/SurfaceDialAPI.hpp
@ -0,0 +1,90 @@
+/*
+Copyright (c) 2014-2015 NicoHood
+See the readme for credit to other people.
+
+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 guard
+#pragma once
+
+SurfaceDialAPI::SurfaceDialAPI(void) : _button(false)
+{
+	// Empty
+}
+
+void SurfaceDialAPI::begin(void)
+{
+	end();
+}
+
+void SurfaceDialAPI::end(void)
+{
+	_button = false;
+	rotate(0);
+}
+
+void SurfaceDialAPI::click(void)
+{
+	_button = true;
+	rotate(0);
+	_button = false;
+	rotate(0);
+}
+
+void SurfaceDialAPI::rotate(int16_t rotation)
+{
+	HID_SurfaceDialReport_Data_t report;
+	report.button = _button;
+	report.rotation = rotation;
+	//report.xAxis = x;
+	//report.yAxis = y;
+
+	SendReport(&report, sizeof(report));
+}
+
+void SurfaceDialAPI::button(bool b)
+{
+	if (b != _button)
+	{
+		_button = b;
+		rotate(0);
+	}
+}
+
+void SurfaceDialAPI::press(void)
+{
+	button(true);
+}
+
+void SurfaceDialAPI::release(void)
+{
+	button(false);
+}
+
+void SurfaceDialAPI::releaseAll(void)
+{
+	_button = false;
+	rotate(0);
+}
+
+bool SurfaceDialAPI::isPressed()
+{
+	return _button;	
+}
--- a/src/HID-APIs/SystemAPI.h
+++ b/src/HID-APIs/SystemAPI.h
@ -76,7 +76,7 @@ enum SystemKeycode : uint8_t {

 typedef union{
 	// Every usable system control key possible
-	uint8_t whole8[];
+	uint8_t whole8[0];
 	uint8_t key;
 } HID_SystemControlReport_Data_t;

@ -89,7 +89,7 @@ public:
 	inline void press(SystemKeycode s);
 	inline void release(void);
 	inline void releaseAll(void);
-	
+
 	// Sending is public in the base class for advanced users.
 	virtual void SendReport(void* data, int length) = 0;
 };
--- a/src/HID-Project.h
+++ b/src/HID-Project.h
@ -25,7 +25,7 @@ THE SOFTWARE.
 #pragma once

 // Software version
-#define HID_PROJECT_VERSION 243
+#define HID_PROJECT_VERSION 244

 #if ARDUINO < 10607
 #error HID Project requires Arduino IDE 1.6.7 or greater. Please update your IDE.
@ -51,6 +51,7 @@ THE SOFTWARE.
 #include "MultiReport/ImprovedKeyboard.h"
 #include "SingleReport/SingleNKROKeyboard.h"
 #include "MultiReport/NKROKeyboard.h"
+#include "MultiReport/SurfaceDial.h"

 // Include Teensy HID afterwards to overwrite key definitions if used
 // TODO include Teensy API if non english keyboard layout was used
--- a/src/HID-Settings.h
+++ b/src/HID-Settings.h
@ -108,3 +108,7 @@ THE SOFTWARE.
 #ifndef HID_REPORTID_TEENSY_KEYBOARD
 #define HID_REPORTID_TEENSY_KEYBOARD 9
 #endif
+
+#ifndef HID_REPORTID_SURFACEDIAL
+#define HID_REPORTID_SURFACEDIAL 10
+#endif
--- a/src/MultiReport/SurfaceDial.cpp
+++ b/src/MultiReport/SurfaceDial.cpp
@ -0,0 +1,87 @@
+/*
+Copyright (c) 2014-2015 NicoHood
+See the readme for credit to other people.
+
+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 "SurfaceDial.h"
+
+static const uint8_t _hidMultiReportDescriptorSurfaceDial[] PROGMEM = {
+    // Integrated Radial Controller TLC
+    0x05, 0x01,       // USAGE_PAGE (Generic Desktop)
+    0x09, 0x0e,       // USAGE (System Multi-Axis Controller)
+    0xa1, 0x01,       // COLLECTION (Application)
+    0x85, HID_REPORTID_SURFACEDIAL,       //   REPORT_ID (Radial Controller)
+    0x05, 0x0d,       //   USAGE_PAGE (Digitizers)
+    0x09, 0x21,       //   USAGE (Puck)
+    0xa1, 0x00,       //   COLLECTION (Physical)
+    0x05, 0x09,       //     USAGE_PAGE (Buttons)
+    0x09, 0x01,       //     USAGE (Button 1)
+    0x95, 0x01,       //     REPORT_COUNT (1)
+    0x75, 0x01,       //     REPORT_SIZE (1)
+    0x15, 0x00,       //     LOGICAL_MINIMUM (0)
+    0x25, 0x01,       //     LOGICAL_MAXIMUM (1)
+    0x81, 0x02,       //     INPUT (Data,Var,Abs)
+    0x05, 0x01,       //     USAGE_PAGE (Generic Desktop)
+    0x09, 0x37,       //     USAGE (Dial)
+    0x95, 0x01,       //     REPORT_COUNT (1)
+    0x75, 0x0f,       //     REPORT_SIZE (15)
+    0x55, 0x0f,       //     UNIT_EXPONENT (-1)
+    0x65, 0x14,       //     UNIT (Degrees, English Rotation)
+    0x36, 0xf0, 0xf1, //     PHYSICAL_MINIMUM (-3600)
+    0x46, 0x10, 0x0e, //     PHYSICAL_MAXIMUM (3600)
+    0x16, 0xf0, 0xf1, //     LOGICAL_MINIMUM (-3600)
+    0x26, 0x10, 0x0e, //     LOGICAL_MAXIMUM (3600)
+    0x81, 0x06,       //     INPUT (Data,Var,Rel)
+    // 0x09, 0x30,       //     USAGE (X)
+    // 0x75, 0x10,       //     REPORT_SIZE (16)
+    // 0x55, 0x0d,       //     UNIT_EXPONENT (-3)
+    // 0x65, 0x13,       //     UNIT (Inch,EngLinear)
+    // 0x35, 0x00,       //     PHYSICAL_MINIMUM (0)
+    // 0x46, 0xc0, 0x5d, //     PHYSICAL_MAXIMUM (24000)
+    // 0x15, 0x00,       //     LOGICAL_MINIMUM (0)
+    // 0x26, 0xff, 0x7f, //     LOGICAL_MAXIMUM (32767)
+    // 0x81, 0x02,       //     INPUT (Data,Var,Abs)
+    // 0x09, 0x31,       //     USAGE (Y)
+    // 0x46, 0xb0, 0x36, //     PHYSICAL_MAXIMUM (14000)
+    // 0x81, 0x02,       //     INPUT (Data,Var,Abs)
+    // 0x05, 0x0d,       //     USAGE_PAGE (Digitizers)
+    // 0x09, 0x48,       //     USAGE (Width)
+    // 0x36, 0xb8, 0x0b, //     PHYSICAL_MINIMUM (3000)
+    // 0x46, 0xb8, 0x0b, //     PHYSICAL_MAXIMUM (3000)
+    // 0x16, 0xb8, 0x0b, //     LOGICAL_MINIMUM (3000)
+    // 0x26, 0xb8, 0x0b, //     LOGICAL_MAXIMUM (3000)
+    // 0x81, 0x03        //     INPUT (Cnst,Var,Abs)
+    0xc0,             //   END_COLLECTION
+    0xc0              // END_COLLECTION
+};
+
+SurfaceDial_::SurfaceDial_(void)
+{
+    static HIDSubDescriptor node(_hidMultiReportDescriptorSurfaceDial, sizeof(_hidMultiReportDescriptorSurfaceDial));
+    HID().AppendDescriptor(&node);
+}
+
+void SurfaceDial_::SendReport(void *data, int length)
+{
+    HID().SendReport(HID_REPORTID_SURFACEDIAL, data, length);
+}
+
+SurfaceDial_ SurfaceDial;
--- a/src/MultiReport/SurfaceDial.h
+++ b/src/MultiReport/SurfaceDial.h
@ -0,0 +1,43 @@
+/*
+Copyright (c) 2014-2015 NicoHood
+See the readme for credit to other people.
+
+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 guard
+#pragma once
+
+#include <Arduino.h>
+#include "PluggableUSB.h"
+#include "HID.h"
+#include "HID-Settings.h"
+#include "../HID-APIs/SurfaceDialAPI.h"
+
+
+class SurfaceDial_ : public SurfaceDialAPI
+{
+public:
+    SurfaceDial_(void);
+
+protected: 
+    virtual inline void SendReport(void* data, int length) override;
+};
+extern SurfaceDial_ SurfaceDial;
+
--- a/src/SingleReport/RawHID.h
+++ b/src/SingleReport/RawHID.h
@ -54,17 +54,17 @@ THE SOFTWARE.

 typedef union{
 	// a RAWHID_TX_SIZE byte buffer for tx
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	uint8_t buff[RAWHID_TX_SIZE];
 } HID_RawKeyboardTXReport_Data_t;

 typedef union{
 	// a RAWHID_TX_SIZE byte buffer for rx
-	uint8_t whole8[];
-	uint16_t whole16[];
-	uint32_t whole32[];
+	uint8_t whole8[0];
+	uint16_t whole16[0];
+	uint32_t whole32[0];
 	uint8_t buff[RAWHID_RX_SIZE];
 } HID_RawKeyboardRXReport_Data_t;

@ -77,23 +77,23 @@ public:
        if(length > 0){
            featureReport = (uint8_t*)report;
            featureLength = length;
-            
+
            // Disable feature report by default
            disableFeatureReport();
        }
    }
-    
+
    int availableFeatureReport(void){
        if(featureLength < 0){
            return featureLength & ~0x8000;
        }
        return 0;
    }
-    
+
    void enableFeatureReport(void){
        featureLength &= ~0x8000;
    }
-    
+
    void disableFeatureReport(void){
        featureLength |= 0x8000;
    }
@ -110,22 +110,22 @@ public:
 		disable();
 		dataLength = 0;
 	}
-	
+
 	void enable(void){
 		dataAvailable = 0;
 	}
-	
+
 	void disable(void){
 		dataAvailable = -1;
 	}
-	
+
 	virtual int available(void){
 		if(dataAvailable < 0){
 			return 0;
 		}
 		return dataAvailable;
 	}
-	
+
 	virtual int read(){
 		// Check if we have data available
 		if(dataAvailable > 0)
@ -135,7 +135,7 @@ public:
 		}
 		return -1;
 	}
-	
+
 	virtual int peek(){
 		// Check if we have data available
 		if(dataAvailable > 0){
@ -143,7 +143,7 @@ public:
 		}
 		return -1;
 	}
-	
+
 	virtual void flush(void){
 		// Writing will always flush by the USB driver
 	}
@ -157,24 +157,23 @@ public:
 	virtual size_t write(uint8_t *buffer, size_t size){
 		return USB_Send(pluggedEndpoint | TRANSFER_RELEASE, buffer, size);
 	}
-	
+
 protected:
    // Implementation of the PUSBListNode
    int getInterface(uint8_t* interfaceCount);
    int getDescriptor(USBSetup& setup);
    bool setup(USBSetup& setup);
-    
+
    uint8_t epType[1];
    uint8_t protocol;
    uint8_t idle;
-    
+
 	// Buffer pointers to hold the received data
 	int dataLength;
 	int dataAvailable;
 	uint8_t* data;
-	
+
 	uint8_t* featureReport;
 	int featureLength;
 };
 extern RawHID_ RawHID;
-
--- a/virtualkeyb.jpg
+++ b/virtualkeyb.jpg
Author	SHA1	Message	Date
James Devine	3fcbe5ccda	Update Readme.md	2018-05-22 22:59:03 +02:00
James Devine	6e4ed069be	Update Readme.md	2018-05-22 22:58:27 +02:00
James Devine	aab401084b	Add files via upload	2018-05-22 22:58:09 +02:00
James Devine	54d29302ae	personalised the readme	2018-05-22 22:57:17 +02:00
Nico	d4938ddcff	Merge pull request #127 from MarianoAmado/master Added screen brightness control keys	2018-01-04 18:31:23 +01:00
Mariano Amado	4249490ab3	added screen brightness keys	2018-01-04 12:48:19 -03:00
Nico	3c5000c4b6	Merge pull request #117 from wind-rider/surface_dial Add Surface Dial support	2017-08-31 20:21:36 +02:00
wind-rider	ee0bbd9657	Add more comments	2017-08-19 23:02:55 +02:00
wind-rider	8cdc8cca26	Add connection diagram and comments	2017-08-19 22:58:37 +02:00
wind-rider	813eb71440	Added simple example	2017-08-19 17:03:44 +02:00
wind-rider	2169d34f2c	Add Surface Dial support	2017-08-19 16:55:52 +02:00
Nico	af9fff10e9	Merge pull request #101 from faxm0dem/patch-1 Fix wrong advertisement	2017-04-02 19:36:09 +02:00
Fabien Wernli	ede4a3e9cf	Fix wrong advertisement As stated elsewhere HUDloader1 is not supported anymore	2017-04-02 14:26:14 +02:00
Nico	a5e20e94d2	Merge pull request #79 from NicoHood/dev Release 2.4.4	2017-01-27 12:26:34 +01:00
NicoHood	51611e6548	Release 2.4.4	2017-01-27 12:24:29 +01:00
NicoHood	583718f453	Fix flexible array errors	2017-01-27 12:22:02 +01:00
NicoHood	12557b5489	Added wiki submodule	2016-05-05 23:08:11 +02:00
NicoHood	7c269d9749	Added releaseAll() for abs Mouse	2016-03-05 18:02:50 +01:00
NicoHood	b33ff31253	Bump to version 2.4.4	2016-03-05 18:00:05 +01:00
NicoHood	d3147adbfd	Added releaseAll() for Mouse API	2016-03-05 17:58:16 +01:00
				`@ -0,0 +1 @@`
				`Subproject commit a1a0b086985dec037d7e7d86c6b2d5816207f202`