Bump version to 8.0.0. Update version numbers. Update changelog.

CHANGELOG.md

@@ -5,38 +5,56 @@ All notable changes to this project will be documented in this file.
 The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to the [UHK Versioning](VERSIONING.md) conventions.
 
+## [8.0.0] - 2017-12-15
+
+Device Protocol: 4.**1.0** | Module Protocol: **4.0.0** | User Config: 4.0.0 | Hardware Config: 1.0.0
+
+- Make the modules transfer the module protocol version and firmware version composed of a major, a minor and a patch number. `MODULEPROTOCOL:MAJOR`
+- Query module key count and pointer count in separate messages instead of a combined message for improved clarity. `MODULEPROTOCOL:MAJOR`
+- Add new UsbCommand_GetModuleProperties() device protocol command. `DEVICEPROTOCOL:MINOR`
+
+## [7.0.0] - 2017-12-14
+
+Device Protocol: **4.0.0** | Module Protocol: 3.0.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
+
+- Make UsbCommand_JumpToModuleBootloader() more robust by not making it dependent on the state of the module driver.
+- Don't make horizontal scrolling and vertical scrolling affect each other.
+- Expose version numbers via the get property interface. `DEVICEPROTOCOL:MINOR`
+- Add DevicePropertyId_ConfigSizes. `DEVICEPROTOCOL:MINOR`
+- Remove DevicePropertyId_HardwareConfigSize and DevicePropertyId_UserConfigSize. `DEVICEPROTOCOL:MAJOR`
+
 ## [6.0.0] - 2017-12-12
 
-Data Model: 4.0.0 (unchanged) | USB Protocol: 3.0.0 (major bump) | Slave Protocol: 3.0.0 (unchanged)
+Device Protocol: **3.0.0** | Module Protocol: 3.0.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
 
-- Change the value of almost every USB protocol commands because there were unused intervals between them. `USBPROTOCOL:MAJOR`
+- Change the value of almost every Device Protocol commands because there were unused intervals between them. `DEVICEPROTOCOL:MAJOR`
 - Disable LED display icons by default.
 - Update LED brightness levels upon applying the configuration.
 
 ## [5.0.1] - 2017-12-09
 
-Data Model: 4.0.0 (unchanged) | USB Protocol: 2.0.0 (unchanged) | Slave Protocol: 3.0.0 (unchanged)
+Device Protocol: 2.0.0 | Module Protocol: 3.0.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
 
  - Make key presses continue to emit scancodes even if a USB interface (typically the mouse interface) is not polled by the host anymore.
  - Make scrolling always immediately react to keypresses regardless of the previous internal scroll state.
 
 ## [5.0.0] - 2017-12-04
 
-Data Model: 4.0.0 (major bump) | USB Protocol: 2.0.0 (unchanged) | Slave Protocol: 3.0.0 (unchanged)
+Device Protocol: 2.0.0 | Module Protocol: 3.0.0 | User Config: **4.0.0** | Hardware Config: 1.0.0
 
-- Move pointerRole from keymaps to module configurations as pointerMode. Add angularShift, modLayerPointerFunction, fnLayerPointerFunction, and mouseLayerPointerFunction to module configurations. `DATAMODEL:MAJOR`
+- Move pointerRole from keymaps to module configurations as pointerMode. Add angularShift, modLayerPointerFunction, fnLayerPointerFunction, and mouseLayerPointerFunction to module configurations. `USERCONFIG:MAJOR`
 
 ## [4.0.0] - 2017-11-30
 
-Data Model: 3.0.0 (major bump) | USB Protocol: 2.0.0 (unchanged) | Slave Protocol: 3.0.0 (unchanged)
+Device Protocol: 2.0.0 | Module Protocol: 3.0.0 | User Config: **3.0.0** | Hardware Config: 1.0.0
 
 - Implement mouse movement and scrolling deceleration and acceleration.
 - Toggle layers upon double tapping their keys. Make the double tap timeout configurable.
-- Make the parser read additional user configuration properties: dataModelMajorVersion, dataModelMinorVersion, dataModelPatchVersion, doubleTapSwitchLayerTimeout, iconsAndLayerTextsBrightness, alphanumericSegmentsBrightness, keyBacklightBrightness, mouseMoveInitialSpeed, mouseMoveAcceleration, mouseMoveDeceleratedSpeed, mouseMoveBaseSpeed, mouseMoveAcceleratedSpeed, mouseScrollInitialSpeed, mouseScrollAcceleration, mouseScrollDeceleratedSpeed, mouseScrollBaseSpeed, mouseScrollAcceleratedSpeed. `DATAMODEL:MAJOR`
+- Make the parser read additional user configuration properties: USERCONFIGMajorVersion, USERCONFIGMinorVersion, USERCONFIGPatchVersion, doubleTapSwitchLayerTimeout, iconsAndLayerTextsBrightness, alphanumericSegmentsBrightness, keyBacklightBrightness, mouseMoveInitialSpeed, mouseMoveAcceleration, mouseMoveDeceleratedSpeed, mouseMoveBaseSpeed, mouseMoveAcceleratedSpeed, mouseScrollInitialSpeed, mouseScrollAcceleration, mouseScrollDeceleratedSpeed, mouseScrollBaseSpeed, mouseScrollAcceleratedSpeed. `USERCONFIG:MAJOR`
 
 ## [3.0.0] - 2017-11-15
 
-Data Model: 2.0.0 (major bump) | USB Protocol: 2.0.0 (major bump) | Slave Protocol: 3.0.0 (major bump)
+Device Protocol: **2.0.0** | Module Protocol: **3.0.0** | User Config: **2.0.0** | Hardware Config: 1.0.0
 
 - Detect the use of USB interfaces and only wait for the ones that are actually used by the host.
 - Implement key debouncer.
@@ -44,49 +62,49 @@ Data Model: 2.0.0 (major bump) | USB Protocol: 2.0.0 (major bump) | Slave Protoc
 - Make pressing the reset button revert to the factory preset.
 - Revert to the factory default state when the reset button is pressed upon firmware startup. Display FTY on the display in this case.
 - Make the LED display show the abbreviation of the current keymap even when it gets reinitialized by the I2C watchdog.
-- Swap SlaveCommand_RequestKeyStates and SlaveCommand_JumpToBootloader, thereby making SlaveCommand_JumpToBootloader the lower number because it's more essential and shouldn't change in the future. `SLAVEPROTOCOL:MAJOR`
+- Swap SlaveCommand_RequestKeyStates and SlaveCommand_JumpToBootloader, thereby making SlaveCommand_JumpToBootloader the lower number because it's more essential and shouldn't change in the future. `MODULEPROTOCOL:MAJOR`
 - Suppress pressed keys upon layer switcher key release.
 - Handle secondary role modifiers and layer switchers.
-- Make UsbCommand_JumpToSlaveBootloader expect a slave slot id instead of a uhkModuleDriverId. `USBPROTOCOL:MAJOR`
+- Make UsbCommand_JumpToSlaveBootloader expect a slave slot id instead of a uhkModuleDriverId. `DEVICEPROTOCOL:MAJOR`
-- Set UsbResponse_InvalidCommand upon encountering with an invalid USB command. `USBPROTOCOL:MINOR`
+- Set UsbResponse_InvalidCommand upon encountering with an invalid USB command. `DEVICEPROTOCOL:MINOR`
-- Remove UsbCommandId_ReadMergeSensor now that it can be queried via UsbCommandId_GetKeyboardState. `USBPROTOCOL:MAJOR`
+- Remove UsbCommandId_ReadMergeSensor now that it can be queried via UsbCommandId_GetKeyboardState. `DEVICEPROTOCOL:MAJOR`
-- Make the getAdcValue and getDebugInfo USB commands utilize the first byte of the response to provide status as dictated by the UHK protocol. `USBPROTOCOL:MAJOR`
+- Make the getAdcValue and getDebugInfo USB commands utilize the first byte of the response to provide status as dictated by the UHK protocol. `DEVICEPROTOCOL:MAJOR`
 - Switch keymap only upon keypress.
 - Handle layer toggle actions.
 - Keep the active layer active even if another layer switcher key gets pressed while holding it.
-- Read the new UserConfig.userConfigLength user config field. `DATAMODEL:MAJOR`
+- Read the new UserConfig.userConfigLength user config field. `USERCONFIG:MAJOR`
 - Change Ctrl and Alt back according to the official UHK factory keymap.
 - Update system keyboard HID descriptor which doesn't make the pointer go to the top left corner on OSX anymore.
 - Scan keyboard matrices in a more efficient manner from timer interrupts instead of the main loop.
-- Add UsbCommand_SendKbootCommand. `USBPROTOCOL:MINOR`
+- Add UsbCommand_SendKbootCommand. `DEVICEPROTOCOL:MINOR`
-- Make the reenumerate USB command accept a timeout value. `USBPROTOCOL:MINOR`
+- Make the reenumerate USB command accept a timeout value. `DEVICEPROTOCOL:MINOR`
-- Make the config parser read the device name. `DATAMODEL:MAJOR`
+- Make the config parser read the device name. `USERCONFIG:MAJOR`
 - Update release file format containing device and module directories and hex files instead of srec.
 - Remove obsolete ARM GCC build files.
 
 ## [2.1.0] - 2017-10-13
 
-Data Model: 1.0.0 (unchanged) | USB Protocol: 1.2.0 (minor bump) | Slave Protocol: 2.1.0 (minor bump)
+Device Protocol: 1.**2.0** | Module Protocol: 2.**1.0** | User Config: 1.0.0 | Hardware Config: 1.0.0
 
-- Add jumpToSlaveBootloader USB and slave protocol command. `USBPROTOCOL:MINOR` `SLAVEPROTOCOL:MINOR`
+- Add jumpToSlaveBootloader USB and Module Protocol command. `DEVICEPROTOCOL:MINOR` `MODULEPROTOCOL:MINOR`
 - Fix generic HID descriptor enumeration error.
 
 ## [2.0.0] - 2017-10-10
 
-Data Model: 1.0.0 (unchanged) | USB Protocol: 1.1.0 (minor bump) | Slave Protocol: 2.0.0 (major bump)
+Device Protocol: 1.**1.0** | Module Protocol: **2.0.0** | User Config: 1.0.0 | Hardware Config: 1.0.0
 
 - Read the hardware and user configuration area of the EEPROM upon startup and set the default keymap.
 - Greatly improve the I2C watchdog and drivers. Communication between the halves or the add-ons should never fail again.
-- Implement generic enumeration sequence and per-slave state for UHK modules, allowing add-ons to be added. `SLAVEPROTOCOL:MAJOR`
+- Implement generic enumeration sequence and per-slave state for UHK modules, allowing add-ons to be added. `MODULEPROTOCOL:MAJOR`
 - Make the master cache the output fields of slave modules, allowing for more frequent input updates.
 - Optimize I2C protocol scheduler resulting in increased roustness and more efficient use of I2C bandwidth.
-- Add I2C message headers containing a length header, allowing for variable-length messages and a CRC16-CCITT checksum, allowing for robust communication. `SLAVEPROTOCOL:MAJOR`
+- Add I2C message headers containing a length header, allowing for variable-length messages and a CRC16-CCITT checksum, allowing for robust communication. `MODULEPROTOCOL:MAJOR`
 - Add mechanism to dump the internal state of the KL03 via SPI for debugging purposes.
-- Add merge sensor state and attached module IDs to GetDebugInfo(). `USBPROTOCOL:PATCH`
+- Add merge sensor state and attached module IDs to GetDebugInfo(). `DEVICEPROTOCOL:PATCH`
-- Throw ParserError_InvalidKeymapCount if keymapCount == 0. `DATAMODEL:PATCH`
+- Throw ParserError_InvalidKeymapCount if keymapCount == 0. `USERCONFIG:PATCH`
 
 ## [1.0.0] - 2017-08-30
 
-Data Model: 1.0.0 | USB Protocol: 1.0.0 | Slave Protocol: 1.0.0
+Device Protocol: 1.0.0 | Module Protocol: 1.0.0 | User Config: 1.0.0 | Hardware Config: 1.0.0
 
 - First Release

left/src/module.h

@@ -6,6 +6,6 @@
     #define MODULE_PROTOCOL_VERSION 1
     #define MODULE_ID ModuleId_LeftKeyboardHalf
     #define MODULE_KEY_COUNT (KEYBOARD_MATRIX_ROWS_NUM * KEYBOARD_MATRIX_COLS_NUM)
-    #define MODULE_HAS_POINTER false
+    #define MODULE_POINTER_COUNT 0
 
 #endif

left/src/slave_protocol_handler.c

@@ -10,10 +10,23 @@
 #include "bool_array_converter.h"
 #include "bootloader.h"
 #include "module.h"
+#include "versions.h"
 
 i2c_message_t RxMessage;
 i2c_message_t TxMessage;
 
+static version_t moduleProtocolVersion = {
+    MODULE_PROTOCOL_MAJOR_VERSION,
+    MODULE_PROTOCOL_MINOR_VERSION,
+    MODULE_PROTOCOL_PATCH_VERSION,
+};
+
+static version_t firmwareVersion = {
+    FIRMWARE_MAJOR_VERSION,
+    FIRMWARE_MINOR_VERSION,
+    FIRMWARE_PATCH_VERSION,
+};
+
 void SlaveRxHandler(void)
 {
     if (!CRC16_IsMessageValid(&RxMessage)) {
@@ -51,21 +64,29 @@ void SlaveTxHandler(void)
                     TxMessage.length = SLAVE_SYNC_STRING_LENGTH;
                     break;
                 }
+                case SlaveProperty_ModuleProtocolVersion: {
+                    memcpy(TxMessage.data, &moduleProtocolVersion, sizeof(version_t));
+                    TxMessage.length = sizeof(version_t);
+                    break;
+                }
+                case SlaveProperty_FirmwareVersion: {
+                    memcpy(TxMessage.data, &firmwareVersion, sizeof(version_t));
+                    TxMessage.length = sizeof(version_t);
+                    break;
+                }
                 case SlaveProperty_ModuleId: {
                     TxMessage.data[0] = MODULE_ID;
                     TxMessage.length = 1;
                     break;
                 }
-                case SlaveProperty_ProtocolVersion: {
+                case SlaveProperty_KeyCount: {
-                    TxMessage.data[0] = MODULE_PROTOCOL_VERSION;
+                    TxMessage.data[0] = MODULE_KEY_COUNT;
                     TxMessage.length = 1;
                     break;
                 }
-                case SlaveProperty_Features: {
+                case SlaveProperty_PointerCount: {
-                    uhk_module_features_t *moduleFeatures = (uhk_module_features_t*)&TxMessage.data;
+                    TxMessage.data[0] = MODULE_POINTER_COUNT;
-                    moduleFeatures->keyCount = MODULE_KEY_COUNT;
+                    TxMessage.length = 1;
-                    moduleFeatures->hasPointer = MODULE_HAS_POINTER;
-                    TxMessage.length = sizeof(uhk_module_features_t);
                     break;
                 }
             }

right/src/slave_drivers/uhk_module_driver.c

@@ -69,6 +69,13 @@ status_t UhkModuleSlaveDriver_Update(uint8_t uhkModuleDriverId)
 
     switch (*uhkModulePhase) {
 
+        // Jump to bootloader
+        case UhkModulePhase_JumpToBootloader:
+            txMessage.data[0] = SlaveCommand_JumpToBootloader;
+            txMessage.length = 1;
+            status = tx(i2cAddress);
+            break;
+
         // Sync communication
         case UhkModulePhase_RequestSync:
             txMessage.data[0] = SlaveCommand_RequestProperty;
@@ -86,30 +93,52 @@ status_t UhkModuleSlaveDriver_Update(uint8_t uhkModuleDriverId)
             bool isSyncValid = memcmp(rxMessage->data, SlaveSyncString, SLAVE_SYNC_STRING_LENGTH) == 0;
             status = kStatus_Uhk_NoTransfer;
             *uhkModulePhase = isSyncValid && isMessageValid
-                ? UhkModulePhase_RequestProtocolVersion
+                ? UhkModulePhase_RequestModuleProtocolVersion
                 : UhkModulePhase_RequestSync;
             break;
         }
 
-        // Get protocol version
+        // Get module protocol version
-        case UhkModulePhase_RequestProtocolVersion:
+        case UhkModulePhase_RequestModuleProtocolVersion:
             txMessage.data[0] = SlaveCommand_RequestProperty;
-            txMessage.data[1] = SlaveProperty_ProtocolVersion;
+            txMessage.data[1] = SlaveProperty_ModuleProtocolVersion;
             txMessage.length = 2;
             status = tx(i2cAddress);
-            *uhkModulePhase = UhkModulePhase_ReceiveProtocolVersion;
+            *uhkModulePhase = UhkModulePhase_ReceiveModuleProtocolVersion;
             break;
-        case UhkModulePhase_ReceiveProtocolVersion:
+        case UhkModulePhase_ReceiveModuleProtocolVersion:
             status = rx(rxMessage, i2cAddress);
-            *uhkModulePhase = UhkModulePhase_ProcessProtocolVersion;
+            *uhkModulePhase = UhkModulePhase_ProcessModuleProtocolVersion;
             break;
-        case UhkModulePhase_ProcessProtocolVersion: {
+        case UhkModulePhase_ProcessModuleProtocolVersion: {
             bool isMessageValid = CRC16_IsMessageValid(rxMessage);
             if (isMessageValid) {
-                uhkModuleState->protocolVersion = rxMessage->data[0];
+                memcpy(&uhkModuleState->moduleProtocolVersion, rxMessage->data, sizeof(version_t));
             }
             status = kStatus_Uhk_NoTransfer;
-            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestModuleId : UhkModulePhase_RequestProtocolVersion;
+            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestFirmwareVersion : UhkModulePhase_RequestModuleProtocolVersion;
+            break;
+        }
+
+        // Get firmware version
+        case UhkModulePhase_RequestFirmwareVersion:
+            txMessage.data[0] = SlaveCommand_RequestProperty;
+            txMessage.data[1] = SlaveProperty_FirmwareVersion;
+            txMessage.length = 2;
+            status = tx(i2cAddress);
+            *uhkModulePhase = UhkModulePhase_ReceiveFirmwareVersion;
+            break;
+        case UhkModulePhase_ReceiveFirmwareVersion:
+            status = rx(rxMessage, i2cAddress);
+            *uhkModulePhase = UhkModulePhase_ProcessFirmwareVersion;
+            break;
+        case UhkModulePhase_ProcessFirmwareVersion: {
+            bool isMessageValid = CRC16_IsMessageValid(rxMessage);
+            if (isMessageValid) {
+                memcpy(&uhkModuleState->firmwareVersion, rxMessage->data, sizeof(version_t));
+            }
+            status = kStatus_Uhk_NoTransfer;
+            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestModuleId : UhkModulePhase_RequestFirmwareVersion;
             break;
         }
 
@@ -131,29 +160,51 @@ status_t UhkModuleSlaveDriver_Update(uint8_t uhkModuleDriverId)
                 uhkModuleState->moduleId = rxMessage->data[0];
             }
             status = kStatus_Uhk_NoTransfer;
-            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestModuleFeatures : UhkModulePhase_RequestModuleId;
+            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestModuleKeyCount : UhkModulePhase_RequestModuleId;
             break;
         }
 
-        // Get module features
+        // Get module key count
-        case UhkModulePhase_RequestModuleFeatures:
+        case UhkModulePhase_RequestModuleKeyCount:
             txMessage.data[0] = SlaveCommand_RequestProperty;
-            txMessage.data[1] = SlaveProperty_Features;
+            txMessage.data[1] = SlaveProperty_KeyCount;
             txMessage.length = 2;
             status = tx(i2cAddress);
-            *uhkModulePhase = UhkModulePhase_ReceiveModuleFeatures;
+            *uhkModulePhase = UhkModulePhase_ReceiveModuleKeyCount;
             break;
-        case UhkModulePhase_ReceiveModuleFeatures:
+        case UhkModulePhase_ReceiveModuleKeyCount:
             status = rx(rxMessage, i2cAddress);
-            *uhkModulePhase = UhkModulePhase_ProcessModuleFeatures;
+            *uhkModulePhase = UhkModulePhase_ProcessModuleKeyCount;
             break;
-        case UhkModulePhase_ProcessModuleFeatures: {
+        case UhkModulePhase_ProcessModuleKeyCount: {
             bool isMessageValid = CRC16_IsMessageValid(rxMessage);
             if (isMessageValid) {
-                memcpy(&uhkModuleState->features, rxMessage->data, sizeof(uhk_module_features_t));
+                uhkModuleState->keyCount = rxMessage->data[0];
             }
             status = kStatus_Uhk_NoTransfer;
-            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestKeyStates : UhkModulePhase_RequestModuleFeatures;
+            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestModulePointerCount : UhkModulePhase_RequestModuleKeyCount;
+            break;
+        }
+
+        // Get module pointer count
+        case UhkModulePhase_RequestModulePointerCount:
+            txMessage.data[0] = SlaveCommand_RequestProperty;
+            txMessage.data[1] = SlaveProperty_PointerCount;
+            txMessage.length = 2;
+            status = tx(i2cAddress);
+            *uhkModulePhase = UhkModulePhase_ReceiveModulePointerCount;
+            break;
+        case UhkModulePhase_ReceiveModulePointerCount:
+            status = rx(rxMessage, i2cAddress);
+            *uhkModulePhase = UhkModulePhase_ProcessModulePointerCount;
+            break;
+        case UhkModulePhase_ProcessModulePointerCount: {
+            bool isMessageValid = CRC16_IsMessageValid(rxMessage);
+            if (isMessageValid) {
+                uhkModuleState->pointerCount = rxMessage->data[0];
+            }
+            status = kStatus_Uhk_NoTransfer;
+            *uhkModulePhase = isMessageValid ? UhkModulePhase_RequestKeyStates : UhkModulePhase_RequestModulePointerCount;
             break;
         }
 
@@ -171,25 +222,12 @@ status_t UhkModuleSlaveDriver_Update(uint8_t uhkModuleDriverId)
         case UhkModulePhase_ProcessKeystates:
             if (CRC16_IsMessageValid(rxMessage)) {
                 uint8_t slotId = uhkModuleDriverId + 1;
-                BoolBitsToBytes(rxMessage->data, keyStatesBuffer, uhkModuleState->features.keyCount);
+                BoolBitsToBytes(rxMessage->data, keyStatesBuffer, uhkModuleState->keyCount);
-                for (uint8_t keyId=0; keyId<uhkModuleState->features.keyCount; keyId++) {
+                for (uint8_t keyId=0; keyId<uhkModuleState->keyCount; keyId++) {
                     KeyStates[slotId][keyId].current = keyStatesBuffer[keyId];
                 }
             }
             status = kStatus_Uhk_NoTransfer;
-            *uhkModulePhase = UhkModulePhase_JumpToBootloader;
-            break;
-
-        // Jump to bootloader
-        case UhkModulePhase_JumpToBootloader:
-            if (uhkModuleState->jumpToBootloader) {
-                txMessage.data[0] = SlaveCommand_JumpToBootloader;
-                txMessage.length = 1;
-                status = tx(i2cAddress);
-                uhkModuleState->jumpToBootloader = false;
-            } else {
-                status = kStatus_Uhk_NoTransfer;
-            }
             *uhkModulePhase = UhkModulePhase_SetTestLed;
             break;
 

right/src/slave_drivers/uhk_module_driver.h

@@ -5,6 +5,7 @@
 
     #include "fsl_common.h"
     #include "crc16.h"
+    #include "versions.h"
 
 // Macros:
 
@@ -29,19 +30,29 @@
         UhkModulePhase_ProcessSync,
 
         // Get protocol version
-        UhkModulePhase_RequestProtocolVersion,
+        UhkModulePhase_RequestModuleProtocolVersion,
-        UhkModulePhase_ReceiveProtocolVersion,
+        UhkModulePhase_ReceiveModuleProtocolVersion,
-        UhkModulePhase_ProcessProtocolVersion,
+        UhkModulePhase_ProcessModuleProtocolVersion,
+
+        // Get firmware version
+        UhkModulePhase_RequestFirmwareVersion,
+        UhkModulePhase_ReceiveFirmwareVersion,
+        UhkModulePhase_ProcessFirmwareVersion,
 
         // Get module id
         UhkModulePhase_RequestModuleId,
         UhkModulePhase_ReceiveModuleId,
         UhkModulePhase_ProcessModuleId,
 
-        // Get module features
+        // Get module key count
-        UhkModulePhase_RequestModuleFeatures,
+        UhkModulePhase_RequestModuleKeyCount,
-        UhkModulePhase_ReceiveModuleFeatures,
+        UhkModulePhase_ReceiveModuleKeyCount,
-        UhkModulePhase_ProcessModuleFeatures,
+        UhkModulePhase_ProcessModuleKeyCount,
+
+        // Get module key count
+        UhkModulePhase_RequestModulePointerCount,
+        UhkModulePhase_ReceiveModulePointerCount,
+        UhkModulePhase_ProcessModulePointerCount,
 
         // Get key states
         UhkModulePhase_RequestKeyStates,
@@ -49,9 +60,9 @@
         UhkModulePhase_ProcessKeystates,
 
         // Misc phases
-        UhkModulePhase_JumpToBootloader,
         UhkModulePhase_SetTestLed,
         UhkModulePhase_SetLedPwmBrightness,
+        UhkModulePhase_JumpToBootloader,
 
     } uhk_module_phase_t;
 
@@ -62,15 +73,16 @@
 
     typedef struct {
         uint8_t moduleId;
-        uint8_t protocolVersion;
+        version_t moduleProtocolVersion;
+        version_t firmwareVersion;
         uhk_module_phase_t phase;
         uhk_module_vars_t sourceVars;
         uhk_module_vars_t targetVars;
         i2c_message_t rxMessage;
         uint8_t firmwareI2cAddress;
         uint8_t bootloaderI2cAddress;
-        uhk_module_features_t features;
+        uint8_t keyCount;
-        bool jumpToBootloader;
+        uint8_t pointerCount;
     } uhk_module_state_t;
 
     typedef struct {

right/src/slot.h

@@ -13,7 +13,7 @@
 // Macros:
 
     #define SLOT_COUNT 4
-    #define IS_VALID_SLAVE_SLOT(slotId) (SlotId_LeftKeyboardHalf <= (slotId) && (slotId) <= SlotId_RightModule)
+    #define IS_VALID_MODULE_SLOT(slotId) (SlotId_LeftKeyboardHalf <= (slotId) && (slotId) <= SlotId_RightModule)
 
 // Typedefs:
 

right/src/usb_commands/usb_command_get_device_state.c

@@ -1,5 +1,5 @@
 #include "fsl_common.h"
-#include "usb_commands/usb_command_get_keyboard_state.h"
+#include "usb_commands/usb_command_get_device_state.h"
 #include "usb_protocol_handler.h"
 #include "eeprom.h"
 #include "peripherals/merge_sensor.h"

right/src/usb_commands/usb_command_get_module_properties.c

@@ -0,0 +1,21 @@
+#include "fsl_common.h"
+#include "usb_commands/usb_command_get_module_properties.h"
+#include "usb_protocol_handler.h"
+#include "slot.h"
+#include "slave_drivers/uhk_module_driver.h"
+
+void UsbCommand_GetModuleProperties()
+{
+    slot_t slotId = GetUsbRxBufferUint8(1);
+
+    if (!IS_VALID_MODULE_SLOT(slotId)) {
+        SetUsbTxBufferUint8(0, UsbStatusCode_ReadConfig_InvalidModuleSlotId);
+    }
+
+    uint8_t moduleDriverId = SLOT_ID_TO_UHK_MODULE_DRIVER_ID(slotId);
+    uhk_module_state_t *moduleState = UhkModuleStates + moduleDriverId;
+
+    GenericHidOutBuffer[1] = moduleState->moduleId;
+    memcpy(GenericHidOutBuffer + 2, &moduleState->moduleProtocolVersion, sizeof(version_t));
+    memcpy(GenericHidOutBuffer + 2 + sizeof(version_t), &moduleState->firmwareVersion, sizeof(version_t));
+}

right/src/usb_commands/usb_command_get_module_properties.h

@@ -0,0 +1,14 @@
+#ifndef __USB_COMMAND_GET_MODULE_PROPERTIES_H__
+#define __USB_COMMAND_GET_MODULE_PROPERTIES_H__
+
+// Functions:
+
+    void UsbCommand_GetModuleProperties();
+
+// Typedefs:
+
+    typedef enum {
+        UsbStatusCode_ReadConfig_InvalidModuleSlotId = 2,
+    } usb_status_code_get_module_properties_t;
+
+#endif

right/src/usb_commands/usb_command_get_property.c

@@ -2,29 +2,58 @@
 #include "usb_commands/usb_command_get_property.h"
 #include "usb_protocol_handler.h"
 #include "eeprom.h"
+#include "versions.h"
+
+version_t deviceProtocolVersion = {
+    DEVICE_PROTOCOL_MAJOR_VERSION,
+    DEVICE_PROTOCOL_MINOR_VERSION,
+    DEVICE_PROTOCOL_PATCH_VERSION,
+};
+
+version_t protocolVersions[] =
+{
+    {
+        FIRMWARE_MAJOR_VERSION,
+        FIRMWARE_MINOR_VERSION,
+        FIRMWARE_PATCH_VERSION,
+    },
+    {
+        DEVICE_PROTOCOL_MAJOR_VERSION,
+        DEVICE_PROTOCOL_MINOR_VERSION,
+        DEVICE_PROTOCOL_PATCH_VERSION,
+    },
+    {
+        MODULE_PROTOCOL_MAJOR_VERSION,
+        MODULE_PROTOCOL_MINOR_VERSION,
+        MODULE_PROTOCOL_PATCH_VERSION,
+    },
+    {
+        USER_CONFIG_MAJOR_VERSION,
+        USER_CONFIG_MINOR_VERSION,
+        USER_CONFIG_PATCH_VERSION,
+    },
+    {
+        HARDWARE_CONFIG_MAJOR_VERSION,
+        HARDWARE_CONFIG_MINOR_VERSION,
+        HARDWARE_CONFIG_PATCH_VERSION,
+    }
+};
+
+uint16_t configSizes[] = {HARDWARE_CONFIG_SIZE, USER_CONFIG_SIZE};
 
 void UsbCommand_GetProperty(void)
 {
     uint8_t propertyId = GetUsbRxBufferUint8(1);
 
     switch (propertyId) {
-        case SystemPropertyId_UsbProtocolVersion:
+        case DevicePropertyId_DeviceProtocolVersion:
-            SetUsbTxBufferUint8(1, SYSTEM_PROPERTY_USB_PROTOCOL_VERSION);
+            memcpy(GenericHidOutBuffer+1, (uint8_t*)&deviceProtocolVersion, sizeof(deviceProtocolVersion));
             break;
-        case SystemPropertyId_BridgeProtocolVersion:
+        case DevicePropertyId_ProtocolVersions:
-            SetUsbTxBufferUint8(1, SYSTEM_PROPERTY_BRIDGE_PROTOCOL_VERSION);
+            memcpy(GenericHidOutBuffer+1, (uint8_t*)&protocolVersions, sizeof(protocolVersions));
             break;
-        case SystemPropertyId_DataModelVersion:
+        case DevicePropertyId_ConfigSizes:
-            SetUsbTxBufferUint8(1, SYSTEM_PROPERTY_DATA_MODEL_VERSION);
+            memcpy(GenericHidOutBuffer+1, (uint8_t*)&configSizes, sizeof(configSizes));
-            break;
-        case SystemPropertyId_FirmwareVersion:
-            SetUsbTxBufferUint8(1, SYSTEM_PROPERTY_FIRMWARE_VERSION);
-            break;
-        case SystemPropertyId_HardwareConfigSize:
-            SetUsbTxBufferUint16(1, HARDWARE_CONFIG_SIZE);
-            break;
-        case SystemPropertyId_UserConfigSize:
-            SetUsbTxBufferUint16(1, USER_CONFIG_SIZE);
             break;
         default:
             SetUsbTxBufferUint8(0, UsbStatusCode_GetProperty_InvalidProperty);

right/src/usb_commands/usb_command_get_property.h

@@ -1,22 +1,12 @@
 #ifndef __USB_COMMAND_GET_PROPERTY_H__
 #define __USB_COMMAND_GET_PROPERTY_H__
 
-// Macros:
-
-    #define SYSTEM_PROPERTY_USB_PROTOCOL_VERSION      1
-    #define SYSTEM_PROPERTY_BRIDGE_PROTOCOL_VERSION   1
-    #define SYSTEM_PROPERTY_DATA_MODEL_VERSION        1
-    #define SYSTEM_PROPERTY_FIRMWARE_VERSION          1
-
 // Typedefs:
 
     typedef enum {
-        SystemPropertyId_UsbProtocolVersion    = 0,
+        DevicePropertyId_DeviceProtocolVersion = 0,
-        SystemPropertyId_BridgeProtocolVersion = 1,
+        DevicePropertyId_ProtocolVersions      = 1,
-        SystemPropertyId_DataModelVersion      = 2,
+        DevicePropertyId_ConfigSizes           = 2,
-        SystemPropertyId_FirmwareVersion       = 3,
-        SystemPropertyId_HardwareConfigSize    = 4,
-        SystemPropertyId_UserConfigSize        = 5,
     } system_property_t;
 
     typedef enum {

right/src/usb_commands/usb_command_jump_to_module_bootloader.c

@@ -7,11 +7,11 @@ void UsbCommand_JumpToModuleBootloader(void)
 {
     uint8_t slotId = GetUsbRxBufferUint8(1);
 
-    if (!IS_VALID_SLAVE_SLOT(slotId)) {
+    if (!IS_VALID_MODULE_SLOT(slotId)) {
         SetUsbTxBufferUint8(0, UsbStatusCode_JumpToModuleBootloader_InvalidSlaveSlotId);
         return;
     }
 
     uint8_t uhkModuleDriverId = SLOT_ID_TO_UHK_MODULE_DRIVER_ID(slotId);
-    UhkModuleStates[uhkModuleDriverId].jumpToBootloader = true;
+    UhkModuleStates[uhkModuleDriverId].phase = UhkModulePhase_JumpToBootloader;
 }

right/src/usb_protocol_handler.c

@@ -9,7 +9,7 @@
 #include "usb_commands/usb_command_get_adc_value.h"
 #include "usb_commands/usb_command_launch_eeprom_transfer.h"
 #include "usb_commands/usb_command_read_config.h"
-#include "usb_commands/usb_command_get_keyboard_state.h"
+#include "usb_commands/usb_command_get_device_state.h"
 #include "usb_commands/usb_command_get_debug_buffer.h"
 #include "usb_commands/usb_command_jump_to_module_bootloader.h"
 #include "usb_commands/usb_command_send_kboot_command_to_module.h"
@@ -61,6 +61,9 @@ void UsbProtocolHandler(void)
         case UsbCommandId_SetLedPwmBrightness:
             UsbCommand_SetLedPwmBrightness();
             break;
+        case UsbCommandId_GetModuleProperties:
+            UsbCommand_GetModuleProperties();
+            break;
         default:
             SetUsbTxBufferUint8(0, UsbStatusCode_InvalidCommand);
             break;

right/src/usb_protocol_handler.h

@@ -30,6 +30,7 @@
         UsbCommandId_GetDebugBuffer           = 0x0b,
         UsbCommandId_GetAdcValue              = 0x0c,
         UsbCommandId_SetLedPwmBrightness      = 0x0d,
+        UsbCommandId_GetModuleProperties      = 0x0e,
     } usb_command_id_t;
 
     typedef enum {

right/src/usb_report_updater.c

@@ -99,15 +99,21 @@ void processMouseKineticState(mouse_kinetic_state_t *kineticState)
 
         float distance = kineticState->currentSpeed * elapsedTime / 1000;
 
+
         if (kineticState->isScroll && !kineticState->wasMoveAction) {
             kineticState->xSum = 0;
             kineticState->ySum = 0;
         }
 
+        // Update horizontal state
+
+        bool horizontalMovement = true;
         if (activeMouseStates[kineticState->leftState]) {
             kineticState->xSum -= distance;
         } else if (activeMouseStates[kineticState->rightState]) {
             kineticState->xSum += distance;
+        } else {
+            horizontalMovement = false;
         }
 
         float xSumInt;
@@ -115,15 +121,20 @@ void processMouseKineticState(mouse_kinetic_state_t *kineticState)
         kineticState->xSum = xSumFrac;
         kineticState->xOut = xSumInt;
 
-        if (kineticState->isScroll && !kineticState->wasMoveAction && kineticState->xOut == 0) {
+        if (kineticState->isScroll && !kineticState->wasMoveAction && kineticState->xOut == 0 && horizontalMovement) {
             kineticState->xOut = kineticState->xSum > 0 ? 1 : -1;
             kineticState->xSum = 0;
         }
 
+        // Update vertical state
+
+        bool verticalMovement = true;
         if (activeMouseStates[kineticState->upState]) {
             kineticState->ySum -= distance;
         } else if (activeMouseStates[kineticState->downState]) {
             kineticState->ySum += distance;
+        } else {
+            verticalMovement = false;
         }
 
         float ySumInt;
@@ -131,7 +142,7 @@ void processMouseKineticState(mouse_kinetic_state_t *kineticState)
         kineticState->ySum = ySumFrac;
         kineticState->yOut = ySumInt;
 
-        if (kineticState->isScroll && !kineticState->wasMoveAction && kineticState->yOut == 0) {
+        if (kineticState->isScroll && !kineticState->wasMoveAction && kineticState->yOut == 0 && verticalMovement) {
             kineticState->yOut = kineticState->ySum > 0 ? 1 : -1;
             kineticState->ySum = 0;
         }

scripts/generate-versions-h.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+const fs = require('fs');
+
+const versionPropertyPrefixes = ['firmware', 'deviceProtocol', 'moduleProtocol', 'userConfig', 'hardwareConfig'];
+const patchVersions = ['Major', 'Minor', 'Patch'];
+const package = JSON.parse(fs.readFileSync(`${__dirname}/package.json`));
+
+const versionVariables = versionPropertyPrefixes.map(versionPropertyPrefix => {
+    const versionPropertyName = `${versionPropertyPrefix}Version`
+    const versionPropertyValues = package[versionPropertyName].split('.');
+    return patchVersions.map(patchVersion => {
+        const versionPropertyValue = versionPropertyValues.shift();
+        const versionPropertyMacroName = `${versionPropertyPrefix}${patchVersion}Version`.split(/(?=[A-Z])/).join('_').toUpperCase()
+        return `    #define ${versionPropertyMacroName} ${versionPropertyValue}`;
+    }).join('\n') + '\n';
+}).join('\n');
+
+fs.writeFileSync(`${__dirname}/../shared/versions.h`,
+`// Please do not edit this file by hand!
+// It is to be regenerated by /scripts/generate-versions-h.js
+
+#ifndef __VERSIONS_H__
+#define __VERSIONS_H__
+
+// Includes:
+
+    #include "fsl_common.h"
+
+// Typedefs:
+
+    typedef struct {
+        uint16_t major;
+        uint16_t minor;
+        uint16_t patch;
+    } version_t;
+
+// Variables:
+
+${versionVariables}
+#endif
+`);

scripts/make-release.js

@@ -5,8 +5,10 @@ require('shelljs/global');
 config.fatal = true;
 config.verbose = true;
 
+exec(`${__dirname}/generate-versions-h.js`);
+
 const package = JSON.parse(fs.readFileSync(`${__dirname}/package.json`));
-const version = package.version;
+const version = package.firmwareVersion;
 const releaseName = `uhk-firmware-${version}`;
 const releaseDir = `${__dirname}/${releaseName}`;
 const modulesDir = `${releaseDir}/modules`;
@@ -28,7 +30,7 @@ exec(`/opt/Freescale/KDS_v3/eclipse/kinetis-design-studio \
 -cleanBuild uhk-right`
 );
 
-for (let device of package.devices) {
+for (const device of package.devices) {
     const deviceDir = `${releaseDir}/devices/${device.name}`;
     const deviceSource = `${__dirname}/../${device.source}`;
     mkdir('-p', deviceDir);
@@ -37,7 +39,7 @@ for (let device of package.devices) {
     exec(`${usbDir}/user-config-json-to-bin.ts ${deviceDir}/config.bin`);
 }
 
-for (let module of package.modules) {
+for (const module of package.modules) {
     const moduleDir = `${releaseDir}/modules`;
     const moduleSource = `${__dirname}/../${module.source}`;
     mkdir('-p', moduleDir);

scripts/package.json

@@ -15,10 +15,11 @@
     "commander": "^2.11.0",
     "shelljs": "^0.7.8"
   },
-  "version": "6.0.0",
+  "firmwareVersion": "8.0.0",
-  "dataModelVersion": "4.0.0",
+  "deviceProtocolVersion": "4.1.0",
-  "usbProtocolVersion": "3.0.0",
+  "moduleProtocolVersion": "4.0.0",
-  "slaveProtocolVersion": "3.0.0",
+  "userConfigVersion": "4.0.0",
+  "hardwareConfigVersion": "1.0.0",
   "devices": [
     {
       "deviceId": 1,

shared/slave_protocol.h

@@ -27,9 +27,11 @@
 
     typedef enum {
         SlaveProperty_Sync,
-        SlaveProperty_ProtocolVersion,
+        SlaveProperty_ModuleProtocolVersion,
+        SlaveProperty_FirmwareVersion,
         SlaveProperty_ModuleId,
-        SlaveProperty_Features,
+        SlaveProperty_KeyCount,
+        SlaveProperty_PointerCount,
     } slave_property_t;
 
     typedef enum {
@@ -40,11 +42,6 @@
         ModuleId_TouchpadRight    = 5,
     } module_id_t;
 
-    typedef struct {
-        uint8_t keyCount;
-        bool hasPointer;
-    } uhk_module_features_t;
-
     typedef struct {
         uint8_t length;
         uint16_t crc;

shared/versions.h

@@ -0,0 +1,41 @@
+// Please do not edit this file by hand!
+// It is to be regenerated by /scripts/generate-versions-h.js
+
+#ifndef __VERSIONS_H__
+#define __VERSIONS_H__
+
+// Includes:
+
+    #include "fsl_common.h"
+
+// Typedefs:
+
+    typedef struct {
+        uint16_t major;
+        uint16_t minor;
+        uint16_t patch;
+    } version_t;
+
+// Variables:
+
+    #define FIRMWARE_MAJOR_VERSION 8
+    #define FIRMWARE_MINOR_VERSION 0
+    #define FIRMWARE_PATCH_VERSION 0
+
+    #define DEVICE_PROTOCOL_MAJOR_VERSION 4
+    #define DEVICE_PROTOCOL_MINOR_VERSION 1
+    #define DEVICE_PROTOCOL_PATCH_VERSION 0
+
+    #define MODULE_PROTOCOL_MAJOR_VERSION 4
+    #define MODULE_PROTOCOL_MINOR_VERSION 0
+    #define MODULE_PROTOCOL_PATCH_VERSION 0
+
+    #define USER_CONFIG_MAJOR_VERSION 4
+    #define USER_CONFIG_MINOR_VERSION 0
+    #define USER_CONFIG_PATCH_VERSION 0
+
+    #define HARDWARE_CONFIG_MAJOR_VERSION 1
+    #define HARDWARE_CONFIG_MINOR_VERSION 0
+    #define HARDWARE_CONFIG_PATCH_VERSION 0
+
+#endif