Bump Agent version to 1.1.3 and update changelog.

* feat: enhance device firmware page

* remove confirmation dialog from firmware upgrade buttons

.travis.yml

@@ -11,7 +11,7 @@ matrix:
   fast_finish: true
   include:
     - os: osx
-      osx_image: xcode8.3
+      osx_image: xcode9.3beta
     - os: linux
       env: CC=clang CXX=clang++ npm_config_clang=1
       compiler: clang

CHANGELOG.md

@@ -6,7 +6,25 @@ The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1
 
 Every Agent version includes the most recent firmware version. See the [firmware changelog](https://github.com/UltimateHackingKeyboard/firmware/blob/master/CHANGELOG.md).
 
-## [1.1.1] - 2017-02-13
+## [1.1.3] - 2018-04-06
+
+Firmware: 8.1.**5** [[release](https://github.com/UltimateHackingKeyboard/firmware/releases/tag/v8.1.5)] | Device Protocol: 4.2.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
+
+- Show the firmware versions of the left and right keyboard halves on the firmware page.
+- Fix menu scancode.
+- Make the tooltip text regarding non-US characters easier to understand.
+- On the Device Configuration page change terminology from download/upload to export/import for greater clarity.
+
+## [1.1.2] - 2018-03-09
+
+Firmware: 8.1.**4** [[release](https://github.com/UltimateHackingKeyboard/firmware/releases/tag/v8.1.4)] | Device Protocol: 4.2.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
+
+- Fix the configuration serializer so that the correct key actions get serialized, and the save button always appears when needed.
+- Add instructions to the firmware page to aid users.
+- Fix code signing on OSX.
+- Sign Agent on Windows.
+
+## [1.1.1] - 2018-02-13
 
 Firmware: 8.1.**2** [[release](https://github.com/UltimateHackingKeyboard/firmware/releases/tag/v8.1.2)] | Device Protocol: 4.2.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
 
@@ -20,7 +38,7 @@ Firmware: 8.1.**2** [[release](https://github.com/UltimateHackingKeyboard/firmwa
 - Assign "switch to test keymap" action on all keymaps in the default configuration.
 - Add keymap descriptions in the default configuration.
 
-## [1.1.0] - 2017-01-15
+## [1.1.0] - 2018-01-15
 
 Firmware: 8.**1**.0 [[release](https://github.com/UltimateHackingKeyboard/firmware/releases/tag/v8.1.0)] | Device Protocol: 4.2.0 | User Config: 4.0.0 | Hardware Config: 1.0.0
 

appveyor.yml

@@ -1,8 +1,11 @@
 os: unstable
 
+clone_folder: c:\projects\uhk-agent
+
 environment:
   GH_TOKEN:
     secure: 3IebpEKmC39codi1wT6dXx8mql4/mCL1JzZ7lir7GQ5MWRnCxlED2OXbiKHHigDV
+  CSC_LINK: c:\projects\uhk-agent\scripts\certs\windows-cert.p12
   matrix:
     - nodejs_version: "8"
 

package.json

@@ -3,8 +3,8 @@
   "private": true,
   "author": "Ultimate Gadget Laboratories",
   "main": "electron/dist/electron-main.js",
-  "version": "1.1.1",
-  "firmwareVersion": "8.1.2",
+  "version": "1.1.3",
+  "firmwareVersion": "8.1.5",
   "deviceProtocolVersion": "4.2.0",
   "userConfigVersion": "4.0.0",
   "hardwareConfigVersion": "1.0.0",
@@ -30,24 +30,26 @@
     "@types/usb": "1.1.3",
     "autoprefixer": "6.5.3",
     "buffer": "5.0.6",
+    "copyfiles": "^2.0.0",
     "copy-webpack-plugin": "4.0.1",
     "core-js": "2.4.1",
     "cross-env": "5.0.5",
     "decompress": "4.2.0",
     "decompress-tarbz2": "^4.1.1",
     "devtron": "1.4.0",
-    "electron": "1.7.11",
-    "electron-builder": "19.45.5",
-    "electron-debug": "1.4.0",
-    "electron-devtools-installer": "2.2.0",
-    "electron-log": "2.2.9",
-    "electron-rebuild": "1.6.0",
-    "electron-settings": "3.1.2",
+    "electron": "1.8.4",
+    "electron-builder": "20.8.1",
+    "electron-debug": "1.5.0",
+    "electron-devtools-installer": "2.2.3",
+    "electron-log": "2.2.14",
+    "electron-rebuild": "1.7.3",
+    "electron-settings": "3.1.4",
+    "electron-updater": "2.21.4",
     "exports-loader": "0.6.3",
     "file-loader": "0.10.0",
     "fs-extra": "4.0.2",
     "jsonfile": "4.0.0",
-    "lerna": "2.0.0",
+    "lerna": "2.9.0",
     "mkdirp": "0.5.1",
     "npm-run-all": "4.0.2",
     "pre-commit": "1.2.2",

packages/uhk-agent/package.json

@@ -17,12 +17,6 @@
     "command-line-args": "4.0.7",
     "decompress": "4.2.0",
     "decompress-bzip2": "4.0.0",
-    "electron": "1.7.9",
-    "electron-is-dev": "0.1.2",
-    "electron-log": "2.2.9",
-    "electron-rebuild": "1.6.0",
-    "electron-settings": "3.1.2",
-    "electron-updater": "2.15.0",
     "node-hid": "0.5.4",
     "sudo-prompt": "7.0.0",
     "tmp": "0.0.33",

packages/uhk-agent/src/services/device.service.ts

@@ -1,5 +1,5 @@
 import { ipcMain } from 'electron';
-import { ConfigurationReply, DeviceConnectionState, IpcEvents, IpcResponse, LogService } from 'uhk-common';
+import { ConfigurationReply, DeviceConnectionState, HardwareModules, IpcEvents, IpcResponse, LogService } from 'uhk-common';
 import { snooze, UhkHidDevice, UhkOperations } from 'uhk-usb';
 import { Observable } from 'rxjs/Observable';
 import { Subscription } from 'rxjs/Subscription';
@@ -73,10 +73,15 @@ export class DeviceService {
         try {
             await this.device.waitUntilKeyboardBusy();
             const result = await this.operations.loadConfigurations();
+            const modules: HardwareModules = {
+                leftModuleInfo: await this.operations.getLeftModuleVersionInfo(),
+                rightModuleInfo: await this.operations.getRightModuleVersionInfo()
+            };
 
             response = {
                 success: true,
-                ...result
+                ...result,
+                modules
             };
         } catch (error) {
             response = {

packages/uhk-common/package.json

@@ -10,7 +10,10 @@
     "url": "git@github.com:UltimateHackingKeyboard/agent.git"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "run-s tsc copy:*",
+    "tsc": "tsc",
+    "copy:scancodes": "copyfiles ./src/config-serializer/config-items/scancodes.json dist",
+    "copy:secondary-roles": "copyfiles ./src/config-serializer/config-items/secondaryRole.json dist",
     "test": "jasmine-ts --config=jasmine.json",
     "coverage": "nyc jasmine-ts --config=jasmine.json"
   },

packages/uhk-common/src/config-serializer/config-items/index.ts

@@ -9,3 +9,6 @@ export * from './macro';
 export * from './module';
 export * from './module-configuration';
 export * from './user-configuration';
+
+export const SCANCODES = require('./scancodes.json');
+export const SECONDARY_ROLES = require('./secondaryRole.json');

packages/uhk-common/src/config-serializer/config-items/key-action/helper.ts

@@ -8,6 +8,7 @@ import { SwitchKeymapAction, UnresolvedSwitchKeymapAction } from './switch-keyma
 import { MouseAction } from './mouse-action';
 import { PlayMacroAction } from './play-macro-action';
 import { NoneAction } from './none-action';
+import { isScancodeExists } from '../scancode-checker';
 
 export class Helper {
 
@@ -26,7 +27,12 @@ export class Helper {
         buffer.backtrack();
 
         if (keyActionFirstByte >= KeyActionId.KeystrokeAction && keyActionFirstByte < KeyActionId.LastKeystrokeAction) {
-            return new KeystrokeAction().fromBinary(buffer);
+            const keystrokeAction = new KeystrokeAction().fromBinary(buffer);
+            if (isValidKeystrokeAction(keystrokeAction)) {
+                return keystrokeAction;
+            }
+
+            return new NoneAction();
         }
 
         switch (keyActionFirstByte) {
@@ -68,8 +74,14 @@ export class Helper {
         }
 
         switch (keyAction.keyActionType) {
-            case keyActionType.KeystrokeAction:
-                return new KeystrokeAction().fromJsonObject(keyAction);
+            case keyActionType.KeystrokeAction: {
+                const keystrokeAction = new KeystrokeAction().fromJsonObject(keyAction);
+                if (isValidKeystrokeAction(keystrokeAction)) {
+                    return keystrokeAction;
+                }
+
+                return new NoneAction();
+            }
             case keyActionType.SwitchLayerAction:
                 return new SwitchLayerAction().fromJsonObject(keyAction);
             case keyActionType.SwitchKeymapAction:
@@ -85,3 +97,9 @@ export class Helper {
         }
     }
 }
+
+function isValidKeystrokeAction(keystrokeAction: KeystrokeAction): boolean {
+    return keystrokeAction.hasSecondaryRoleAction() ||
+        keystrokeAction.hasActiveModifier() ||
+        keystrokeAction.hasScancode() && isScancodeExists(keystrokeAction.scancode);
+}

packages/uhk-common/src/config-serializer/config-items/module.ts

@@ -54,15 +54,12 @@ export class Module {
 
         const noneAction = new NoneAction();
 
-        const keyActions: KeyAction[] = this.keyActions.map(keyAction => {
+        buffer.writeArray(this.keyActions, (uhkBuffer: UhkBuffer, keyAction: KeyAction) => {
             if (keyAction) {
-                return keyAction;
+                keyAction.toBinary(uhkBuffer, userConfiguration);
+            } else {
+                noneAction.toBinary(uhkBuffer);
             }
-            return noneAction;
-        });
-
-        buffer.writeArray(keyActions, (uhkBuffer: UhkBuffer, keyAction: KeyAction) => {
-            keyAction.toBinary(uhkBuffer, userConfiguration);
         });
     }
 

packages/uhk-common/src/config-serializer/config-items/scancode-checker.ts

@@ -0,0 +1,26 @@
+import { SCANCODES } from './';
+
+let scancodeMap: Map<number, any>;
+
+export function isScancodeExists(scancode: number): boolean {
+    if (!scancodeMap) {
+        fillScancodeMap();
+    }
+
+    return scancodeMap.has(scancode);
+}
+
+function fillScancodeMap(): void {
+    scancodeMap = new Map<number, any>();
+
+    for (const scanGroup of SCANCODES) {
+        for (const child of scanGroup.children) {
+            if (child.additional && child.additional.scancode) {
+                scancodeMap.set(child.additional.scancode, child);
+            }
+            else {
+                scancodeMap.set(Number.parseInt(child.id), child);
+            }
+        }
+    }
+}

packages/uhk-common/src/config-serializer/config-items/scancodes.json

@@ -242,7 +242,7 @@
                 "text": "Delete"
             },
             {
-                "id": "118",
+                "id": "101",
                 "text": "Menu"
             },
             {

packages/uhk-common/src/models/configuration-reply.ts

@@ -1,6 +1,9 @@
+import { HardwareModules } from './hardware-modules';
+
 export interface ConfigurationReply {
     success: boolean;
     userConfiguration?: string;
     hardwareConfiguration?: string;
+    modules?: HardwareModules;
     error?: string;
 }

packages/uhk-common/src/models/hardware-module-info.ts

@@ -0,0 +1,4 @@
+export interface HardwareModuleInfo {
+    firmwareVersion?: string;
+    moduleProtocolVersion?: string;
+}

packages/uhk-common/src/models/hardware-modules.ts

@@ -0,0 +1,6 @@
+import { HardwareModuleInfo } from './hardware-module-info';
+
+export interface HardwareModules {
+    leftModuleInfo?: HardwareModuleInfo;
+    rightModuleInfo?: HardwareModuleInfo;
+}

packages/uhk-common/src/models/index.ts

@@ -5,3 +5,5 @@ export * from './app-start-info';
 export * from './configuration-reply';
 export * from './version-information';
 export * from './device-connection-state';
+export * from './hardware-modules';
+export * from './hardware-module-info';

packages/uhk-usb/src/constants.ts

@@ -22,7 +22,7 @@ export enum UsbCommand {
     GetDebugBuffer           = 0x0b,
     GetAdcValue              = 0x0c,
     SetLedPwmBrightness      = 0x0d,
-    GetModuleProperties      = 0x0e
+    GetModuleProperty        = 0x0e
 }
 
 export enum EepromOperation {
@@ -81,3 +81,7 @@ export enum KbootCommands {
     ping = 1,
     reset = 2
 }
+
+export enum ModulePropertyId {
+    protocolVersions = 0
+}

packages/uhk-usb/src/uhk-operations.ts

@@ -1,5 +1,12 @@
-import { LogService } from 'uhk-common';
-import { EnumerationModes, EnumerationNameToProductId, KbootCommands, ModuleSlotToI2cAddress, ModuleSlotToId } from './constants';
+import { HardwareModuleInfo, LogService, UhkBuffer } from 'uhk-common';
+import {
+    EnumerationModes,
+    EnumerationNameToProductId,
+    KbootCommands,
+    ModulePropertyId,
+    ModuleSlotToI2cAddress,
+    ModuleSlotToId
+} from './constants';
 import * as path from 'path';
 import * as fs from 'fs';
 import { UhkBlhost } from './uhk-blhost';
@@ -193,6 +200,50 @@ export class UhkOperations {
         return false;
     }
 
+    public async getLeftModuleVersionInfo(): Promise<HardwareModuleInfo> {
+        try {
+            this.logService.debug('[DeviceOperation] USB[T]: Read left module version information');
+
+            const command = new Buffer([
+                UsbCommand.GetModuleProperty,
+                ModuleSlotToId.leftHalf,
+                ModulePropertyId.protocolVersions
+            ]);
+
+            const buffer = await this.device.write(command);
+            const uhkBuffer = UhkBuffer.fromArray(convertBufferToIntArray(buffer));
+            // skip the first 2 byte
+            uhkBuffer.readUInt16();
+
+            return {
+                moduleProtocolVersion: `${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}`,
+                firmwareVersion: `${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}`
+            };
+        }
+        catch (error) {
+            this.logService.error('[DeviceOperation] Could not read left module version information', error);
+        }
+
+        return {
+            moduleProtocolVersion: '',
+            firmwareVersion: ''
+        };
+    }
+
+    public async getRightModuleVersionInfo(): Promise<HardwareModuleInfo> {
+        this.logService.debug('[DeviceOperation] USB[T]: Read right module version information');
+
+        const command = new Buffer([UsbCommand.GetProperty, DevicePropertyIds.ProtocolVersions]);
+        const buffer = await this.device.write(command);
+        const uhkBuffer = UhkBuffer.fromArray(convertBufferToIntArray(buffer));
+        // skip the first byte
+        uhkBuffer.readUInt8();
+
+        return {
+            firmwareVersion: `${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}.${uhkBuffer.readUInt16()}`
+        };
+    }
+
     /**
      * IpcMain handler. Send the UserConfiguration to the UHK Device and send a response with the result.
      * @param {string} json - UserConfiguration in JSON format

packages/uhk-web/src/app/components/device/configuration/device-configuration.component.html

@@ -9,13 +9,13 @@
 
 <ul class="list-unstyled btn-list">
     <li>
-        Download device configuration in
-        <span role="button" class="btn-link" (click)="saveConfigurationInJSONFormat()">JSON</span> or
-        <span role="button" class="btn-link" (click)="saveConfigurationInBINFormat()">binary</span> format.
+        <button class="btn btn-default"
+                (click)="exportUserConfiguration($event)">Export device configuration
+        </button>
     </li>
     <li>
         <label class="btn btn-default btn-file">
-            Upload device configuration
+            Import device configuration
             <input type="file"
                    (change)="changeFile($event)">
         </label>

packages/uhk-web/src/app/components/device/configuration/device-configuration.component.ts

@@ -34,6 +34,14 @@ export class DeviceConfigurationComponent {
         this.store.dispatch(new SaveUserConfigInBinaryFileAction());
     }
 
+    exportUserConfiguration(event: MouseEvent) {
+        if (event.shiftKey) {
+            this.saveConfigurationInBINFormat();
+        } else {
+            this.saveConfigurationInJSONFormat();
+        }
+    }
+
     changeFile(event): void {
         const files = event.srcElement.files;
         const fileReader = new FileReader();

packages/uhk-web/src/app/components/device/firmware/device-firmware.component.html

@@ -6,23 +6,36 @@
                 <i class="fa fa-sliders"></i>
                 <span>Firmware</span>
             </h1>
+
             <p>
-                Flash firmware {{ (getAgentVersionInfo$ | async).firmwareVersion }} (bundled with Agent)
-                <button class="btn btn-primary"
-                        [disabled]="flashFirmwareButtonDisbabled$ | async"
-                        (click)="onUpdateFirmware()">Flash firmware
-                </button>
+                Firmware {{ hardwareModules.leftModuleInfo.firmwareVersion }} is running on the left keyboard half.<br>
+                Firmware {{ hardwareModules.rightModuleInfo.firmwareVersion }} is running on the right keyboard half.
+            </p>
+
+            <p>
+                <i>
+                    Please note that the firmware update process may sometimes fail. If if fails then
+                    simply retry until it succeeds. If the left half becomes unresponsive after a failed
+                    update then retry and follow the instructions displayed during the update to fix it.
+                    We'll make the firmware update process more robust.
+                </i>
             </p>
 
             <p>
-                Flash firmware file <input id="firmware-file-select"
-                                           type="file"
-                                           [disabled]="flashFirmwareButtonDisbabled$ | async"
-                                           (change)="changeFile($event)">
                 <button class="btn btn-primary"
                         [disabled]="flashFirmwareButtonDisbabled$ | async"
-                        (click)="onUpdateFirmwareWithFile()">Flash firmware
+                        (click)="onUpdateFirmware()">
+                    Flash firmware {{ (getAgentVersionInfo$ | async).firmwareVersion }} (bundled with Agent)
                 </button>
+                <label class="btn btn-primary btn-file"
+                       [class.disabled]="flashFirmwareButtonDisbabled$ | async">
+                    Choose firmware file and flash it
+                    <input id="firmware-file-select"
+                           type="file"
+                           accept=".tar.bz2"
+                           [disabled]="flashFirmwareButtonDisbabled$ | async"
+                           (change)="changeFile($event)">
+                </label>
             </p>
         </div>
 

packages/uhk-web/src/app/components/device/firmware/device-firmware.component.ts

@@ -2,9 +2,16 @@ import { Component, ElementRef, OnDestroy, ViewChild } from '@angular/core';
 import { Store } from '@ngrx/store';
 import { Observable } from 'rxjs/Observable';
 import { Subscription } from 'rxjs/Subscription';
-import { VersionInformation } from 'uhk-common';
+import { HardwareModules, VersionInformation } from 'uhk-common';
 
-import { AppState, firmwareOkButtonDisabled, flashFirmwareButtonDisbabled, getAgentVersionInfo, xtermLog } from '../../../store';
+import {
+    AppState,
+    firmwareOkButtonDisabled,
+    flashFirmwareButtonDisbabled,
+    getAgentVersionInfo,
+    getHardwareModules,
+    xtermLog
+} from '../../../store';
 import { UpdateFirmwareAction, UpdateFirmwareOkButtonAction, UpdateFirmwareWithAction } from '../../../store/actions/device';
 import { XtermLog } from '../../../models/xterm-log';
 
@@ -22,8 +29,9 @@ export class DeviceFirmwareComponent implements OnDestroy {
     xtermLogSubscription: Subscription;
     getAgentVersionInfo$: Observable<VersionInformation>;
     firmwareOkButtonDisabled$: Observable<boolean>;
+    hardwareModulesSubscription: Subscription;
+    hardwareModules: HardwareModules;
 
-    arrayBuffer: Uint8Array;
     @ViewChild('scrollMe') divElement: ElementRef;
 
     constructor(private store: Store<AppState>) {
@@ -38,24 +46,20 @@ export class DeviceFirmwareComponent implements OnDestroy {
         });
         this.getAgentVersionInfo$ = store.select(getAgentVersionInfo);
         this.firmwareOkButtonDisabled$ = store.select(firmwareOkButtonDisabled);
+        this.hardwareModulesSubscription = store.select(getHardwareModules).subscribe(data => {
+            this.hardwareModules = data;
+        });
     }
 
     ngOnDestroy(): void {
         this.xtermLogSubscription.unsubscribe();
+        this.hardwareModulesSubscription.unsubscribe();
     }
 
     onUpdateFirmware(): void {
         this.store.dispatch(new UpdateFirmwareAction());
     }
 
-    onUpdateFirmwareWithFile(): void {
-        if (!this.arrayBuffer) {
-            return;
-        }
-
-        this.store.dispatch(new UpdateFirmwareWithAction(Array.prototype.slice.call(this.arrayBuffer)));
-    }
-
     onOkButtonClick(): void {
         this.store.dispatch(new UpdateFirmwareOkButtonAction());
     }
@@ -64,14 +68,13 @@ export class DeviceFirmwareComponent implements OnDestroy {
         const files = event.srcElement.files;
 
         if (files.length === 0) {
-            this.arrayBuffer = null;
-
             return;
         }
 
         const fileReader = new FileReader();
         fileReader.onloadend = function () {
-            this.arrayBuffer = new Uint8Array(fileReader.result);
+            const arrayBuffer = new Uint8Array(fileReader.result);
+            this.store.dispatch(new UpdateFirmwareWithAction(Array.prototype.slice.call(arrayBuffer)));
         }.bind(this);
         fileReader.readAsArrayBuffer(files[0]);
     }

packages/uhk-web/src/app/components/popover/tab/keypress/keypress-tab.component.html

@@ -9,7 +9,7 @@
     ></select2>
     <icon name="question-circle"
           data-toggle="tooltip"
-          title="Looking for a non-US character, but can't find it? Please note that USB keyboards send scancodes, not characters to your computer. Then your operating system translates the scancodes to characters according to your current OS keyboard layout. This means that you have to select the US-equivalent character of the desired key in Agent."
+          title="Looking for a non-US character? Just pick the character of the desired key according to the US layout."
           data-placement="bottom"></icon>
     <capture-keystroke-button (capture)="onKeysCapture($event)" tabindex="0"></capture-keystroke-button>
 </div>

packages/uhk-web/src/app/components/popover/tab/keypress/keypress-tab.component.ts

@@ -1,6 +1,6 @@
 import { Component, Input, OnChanges } from '@angular/core';
 import { Select2OptionData, Select2TemplateFunction } from 'ng2-select2';
-import { KeyAction, KeystrokeAction, KeystrokeType } from 'uhk-common';
+import { KeyAction, KeystrokeAction, KeystrokeType, SCANCODES, SECONDARY_ROLES } from 'uhk-common';
 
 import { Tab } from '../tab';
 import { MapperService } from '../../../../services/mapper.service';
@@ -35,8 +35,8 @@ export class KeypressTabComponent extends Tab implements OnChanges {
             id: '0',
             text: 'None'
         }];
-        this.scanCodeGroups = this.scanCodeGroups.concat(require('./scancodes.json'));
-        this.secondaryRoleGroups = require('./secondaryRole.json');
+        this.scanCodeGroups = this.scanCodeGroups.concat(SCANCODES);
+        this.secondaryRoleGroups = SECONDARY_ROLES;
         this.leftModifierSelects = Array(this.leftModifiers.length).fill(false);
         this.rightModifierSelects = Array(this.rightModifiers.length).fill(false);
         this.selectedScancodeOption = this.scanCodeGroups[0];

packages/uhk-web/src/app/components/side-menu/side-menu.component.html

@@ -128,12 +128,14 @@
         <ul [@toggler]="animation['agent']">
             <li class="sidebar__level-2--item">
                 <div class="sidebar__level-2" [routerLinkActive]="['active']">
-                    <a [routerLink]="['/settings']">Settings</a>
+                    <a [routerLink]="['/settings']"
+                       [class.disabled]="updatingFirmware$ | async">Settings</a>
                 </div>
             </li>
             <li class="sidebar__level-2--item">
                 <div class="sidebar__level-2" [routerLinkActive]="['active']">
-                    <a [routerLink]="['/about']">About</a>
+                    <a [routerLink]="['/about']"
+                       [class.disabled]="updatingFirmware$ | async">About</a>
                 </div>
             </li>
         </ul>

packages/uhk-web/src/app/components/side-menu/side-menu.component.scss

@@ -9,6 +9,10 @@
 
 a {
     color: #333;
+
+    &.disabled {
+        opacity: 0.65;
+    }
 }
 
 // General list styles for the sidebar-menu.
@@ -112,6 +116,10 @@ ul {
                 &:focus {
                     text-decoration: none;
                 }
+
+                &.disabled {
+                    opacity: 0.65;
+                }
             }
         }
     }

packages/uhk-web/src/app/services/capture.service.ts

@@ -94,7 +94,7 @@ export class CaptureService {
         this.mapping.set(88, 27);  // X
         this.mapping.set(89, 28);  // Y
         this.mapping.set(90, 29);  // Z
-        this.mapping.set(93, 118);  // Menu
+        this.mapping.set(93, 101);  // Menu
         this.mapping.set(96, 98);  // Num pad 0
         this.mapping.set(97, 89);  // Num pad 1
         this.mapping.set(98, 90);  // Num pad 2

packages/uhk-web/src/app/services/mapper.service.ts

@@ -190,6 +190,7 @@ export class MapperService {
         this.basicScanCodeTextMap.set(98, ['Insert', '0']);
         this.basicScanCodeTextMap.set(99, ['Del', '.']);
         this.basicScanCodeTextMap.set(100, ['ISO key', '|']);
+        this.basicScanCodeTextMap.set(101, ['Menu']);
         this.basicScanCodeTextMap.set(104, ['F13']);
         this.basicScanCodeTextMap.set(105, ['F14']);
         this.basicScanCodeTextMap.set(106, ['F15']);
@@ -202,7 +203,6 @@ export class MapperService {
         this.basicScanCodeTextMap.set(113, ['F22']);
         this.basicScanCodeTextMap.set(114, ['F23']);
         this.basicScanCodeTextMap.set(115, ['F24']);
-        this.basicScanCodeTextMap.set(118, ['Menu']);
         this.basicScanCodeTextMap.set(176, ['00']);
         this.basicScanCodeTextMap.set(177, ['000']);
 
@@ -236,7 +236,7 @@ export class MapperService {
         this.basicScancodeIcons.set(80, 'icon-kbd__mod--arrow-left');
         this.basicScancodeIcons.set(81, 'icon-kbd__mod--arrow-down');
         this.basicScancodeIcons.set(82, 'icon-kbd__mod--arrow-up');
-        this.basicScancodeIcons.set(118, 'icon-kbd__mod--menu');
+        this.basicScancodeIcons.set(101, 'icon-kbd__mod--menu');
 
         this.mediaScancodeIcons = new Map<number, string>();
         this.mediaScancodeIcons.set(138, 'icon-kbd__fn--browser');

packages/uhk-web/src/app/store/actions/device.ts

@@ -1,5 +1,6 @@
 import { Action } from '@ngrx/store';
 import { DeviceConnectionState, IpcResponse, type } from 'uhk-common';
+import { HardwareModules } from '../../../../../uhk-common/src/models';
 
 const PREFIX = '[device] ';
 
@@ -22,7 +23,8 @@ export const ActionTypes = {
     UPDATE_FIRMWARE_REPLY: type(PREFIX + 'update firmware reply'),
     UPDATE_FIRMWARE_SUCCESS: type(PREFIX + 'update firmware success'),
     UPDATE_FIRMWARE_FAILED: type(PREFIX + 'update firmware failed'),
-    UPDATE_FIRMWARE_OK_BUTTON: type(PREFIX + 'update firmware ok button click')
+    UPDATE_FIRMWARE_OK_BUTTON: type(PREFIX + 'update firmware ok button click'),
+    MODULES_INFO_LOADED: type(PREFIX + 'module info loaded')
 };
 
 export class SetPrivilegeOnLinuxAction implements Action {
@@ -114,6 +116,13 @@ export class ResetMouseSpeedSettingsAction implements Action {
     type = ActionTypes.RESET_MOUSE_SPEED_SETTINGS;
 }
 
+export class HardwareModulesLoadedAction implements Action {
+    type = ActionTypes.MODULES_INFO_LOADED;
+
+    constructor(public payload: HardwareModules) {
+    }
+}
+
 export type Actions
     = SetPrivilegeOnLinuxAction
     | SetPrivilegeOnLinuxReplyAction
@@ -132,4 +141,5 @@ export type Actions
     | UpdateFirmwareSuccessAction
     | UpdateFirmwareFailedAction
     | UpdateFirmwareOkButtonAction
+    | HardwareModulesLoadedAction
     ;

packages/uhk-web/src/app/store/effects/user-config.ts

@@ -43,7 +43,7 @@ import {
     ShowNotificationAction,
     UndoLastAction
 } from '../actions/app';
-import { ShowSaveToKeyboardButtonAction } from '../actions/device';
+import { HardwareModulesLoadedAction, ShowSaveToKeyboardButtonAction } from '../actions/device';
 import { DeviceRendererService } from '../../services/device-renderer.service';
 import { UndoUserConfigData } from '../../models/undo-user-config-data';
 import { UploadFileData } from '../../models/upload-file-data';
@@ -173,6 +173,8 @@ export class UserConfigEffects {
                     }));
             }
 
+            result.push(new HardwareModulesLoadedAction(data.modules));
+
             this.router.navigate(['/']);
 
             return result;

packages/uhk-web/src/app/store/index.ts

@@ -77,3 +77,4 @@ export const xtermLog = createSelector(deviceState, fromDevice.xtermLog);
 export const firmwareOkButtonDisabled = createSelector(deviceState, fromDevice.firmwareOkButtonDisabled);
 // tslint:disable-next-line: max-line-length
 export const flashFirmwareButtonDisbabled = createSelector(runningInElectron, deviceState, (electron, state: fromDevice.State) => !electron || state.updatingFirmware);
+export const getHardwareModules = createSelector(deviceState, fromDevice.getHardwareModules);

packages/uhk-web/src/app/store/reducers/device.ts

@@ -1,8 +1,10 @@
 import { Action } from '@ngrx/store';
+import { HardwareModules } from 'uhk-common';
 
 import {
     ActionTypes,
     ConnectionStateChangedAction,
+    HardwareModulesLoadedAction,
     SaveConfigurationAction,
     UpdateFirmwareFailedAction
 } from '../actions/device';
@@ -16,6 +18,7 @@ export interface State {
     saveToKeyboard: ProgressButtonState;
     updatingFirmware: boolean;
     firmwareUpdateFinished: boolean;
+    modules: HardwareModules;
     log: Array<XtermLog>;
 }
 
@@ -25,6 +28,15 @@ export const initialState: State = {
     saveToKeyboard: initProgressButtonState,
     updatingFirmware: false,
     firmwareUpdateFinished: false,
+    modules: {
+        leftModuleInfo: {
+            firmwareVersion: '',
+            moduleProtocolVersion: ''
+        },
+        rightModuleInfo: {
+            firmwareVersion: ''
+        }
+    },
     log: [{message: '', cssClass: XtermCssClass.standard}]
 };
 
@@ -148,6 +160,13 @@ export function reducer(state = initialState, action: Action) {
                 log: [...state.log, logEntry]
             };
         }
+
+        case ActionTypes.MODULES_INFO_LOADED:
+            return {
+                ...state,
+                modules: (action as HardwareModulesLoadedAction).payload
+            };
+
         default:
             return state;
     }
@@ -159,3 +178,4 @@ export const hasDevicePermission = (state: State) => state.hasPermission;
 export const getSaveToKeyboardState = (state: State) => state.saveToKeyboard;
 export const xtermLog = (state: State) => state.log;
 export const firmwareOkButtonDisabled = (state: State) => !state.firmwareUpdateFinished;
+export const getHardwareModules = (state: State) => state.modules;

packages/usb/apply-config.js

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 const uhk = require('./uhk');
 
-const device = uhk.getUhkDevice();
-const sendData = new Buffer([uhk.usbCommands.applyConfig]);
-device.write(uhk.getTransferData(sendData));
-const response = Buffer.from(device.readSync());
-console.log(response);
+(async function() {
+    const device = uhk.getUhkDevice();
+    uhk.applyConfig(device);
+})();

packages/usb/eeprom.js

@@ -9,23 +9,5 @@ if (eepromTransfer === undefined) {
     process.exit(1);
 }
 
-const device = uhk.getUhkDevice();
-device.write(uhk.getTransferData(new Buffer([uhk.usbCommands.launchEepromTransfer, eepromTransfer.operation, eepromTransfer.configBuffer])));
-const buffer = Buffer.from(device.readSync());
-const responseCode = buffer[0];
-if (responseCode !== 0) {
-    console.error(`Write user config to eeprom failed. Response code: ${responseCode}`);
-    process.exit(1);
-}
+//    const buffer = await uhk.writeDevice(device, [uhk.usbCommands.launchEepromTransfer, eepromTransfer.operation, eepromTransfer.configBuffer]);
 
-function waitUntilKeyboardBusy() {
-
-    device.write(uhk.getTransferData(new Buffer([uhk.usbCommands.getDeviceState])));
-    const keyboardStateBuffer = Buffer.from(device.readSync());
-
-    if (keyboardStateBuffer[1] === 1) {
-        setTimeout(waitUntilKeyboardBusy, 200);
-    }
-}
-
-waitUntilKeyboardBusy();

packages/usb/factory-update.js

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const program = require('commander');
+const uhk = require('./uhk')
+require('shelljs/global');
+
+(async function() {
+    config.fatal = true;
+
+    program
+        .usage(`firmwarePath`)
+        .parse(process.argv);
+
+    if (program.args.length < 1) {
+        console.error('No firmware path specified.');
+        exit(1);
+    }
+    const firmwarePath = program.args[0];
+
+    if (program.args.length < 2) {
+        console.error('No layout specified.');
+        exit(1);
+    }
+    const layout = program.args[1];
+    if (!['ansi', 'iso'].includes(layout)) {
+        console.error('The specified layout is neither ansi nor iso.');
+        exit(1);
+    }
+    const isIso = layout === 'iso';
+
+    config.verbose = true;
+    await uhk.updateFirmwares(firmwarePath);
+    const device = uhk.getUhkDevice();
+    const configBuffer = fs.readFileSync(`${firmwarePath}/devices/uhk60-right/config.bin`);
+    await uhk.writeUca(device, configBuffer);
+    await uhk.writeHca(device, isIso);
+    await uhk.switchKeymap(device, 'TES');
+    console.log('All done!')
+    config.verbose = false;
+})();

packages/usb/get-debug-info.js

@@ -13,7 +13,8 @@ function getUint16(buffer, offset) {
 let prevGeneric, prevBasic, prevMedia, prevSystem, prevMouse;
 function getDebugInfo() {
 
-    const payload = new Buffer([uhk.usbCommands.getDebugInfo]);
+    const payload = new Buffer([uhk.usbCommands.getDebugBuffer]);
+    console.log(payload)
     console.log('Sending ', uhk.bufferToString(payload));
     device.write(uhk.getTransferData(payload));
     const rxBuffer = Buffer.from(device.readSync());

packages/usb/get-module-state.js

@@ -1,14 +1,7 @@
 #!/usr/bin/env node
 const uhk = require('./uhk');
-const device = uhk.getUhkDevice();
 
-function getModuleState() {
-    const payload = new Buffer([uhk.usbCommands.getModuleProperty, 1]);
-    console.log('Sending ', uhk.bufferToString(payload));
-    device.write(uhk.getTransferData(payload));
-    const receivedBuffer = device.readSync();
-    console.log('Received', uhk.bufferToString(receivedBuffer));
-    setTimeout(getModuleState, 500)
-}
-
-getModuleState();
+(async function() {
+    const device = uhk.getUhkDevice();
+    await uhk.getModuleProperty(device, 1, uhk.modulePropertyIds.protocolVersions);
+})();

packages/usb/switch-keymap.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+const uhk = require('./uhk');
+
+(async function() {
+    const keymapAbbreviation = process.argv[2];
+
+    if (keymapAbbreviation === undefined) {
+        console.log('Usage: switch-keymap.js keymapName');
+        return;
+    }
+
+    const device = uhk.getUhkDevice();
+    const sendData = await uhk.switchKeymap(device, keymapAbbreviation);
+    console.log(sendData)
+})();

packages/usb/uhk.js

@@ -1,7 +1,24 @@
 const util = require('util');
 const HID = require('node-hid');
-// const debug = process.env.DEBUG;
-const debug = true;
+const {HardwareConfiguration, UhkBuffer} = require('uhk-common');
+const {getTransferBuffers, ConfigBufferId, UhkHidDevice, UsbCommand} = require('uhk-usb');
+const Logger = require('./logger');
+const debug = process.env.DEBUG;
+
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+const kbootCommandIdToName = {
+    0: 'idle',
+    1: 'ping',
+    2: 'reset',
+};
+
+const eepromOperationIdToName = {
+    0: 'read',
+    1: 'write',
+}
 
 function bufferToString(buffer) {
     let str = '';
@@ -28,11 +45,27 @@ function uint32ToArray(value) {
 }
 
 function writeDevice(device, data, options={}) {
-    device.write(getTransferData(new Buffer(data)));
+    const dataBuffer = new Buffer(data);
+    if (!options.noDebug) {
+        writeLog('W: ', dataBuffer);
+    }
+    device.write(getTransferData(dataBuffer));
     if (options.noRead) {
         return Promise.resolve();
     }
-    return util.promisify(device.read.bind(device))();
+
+    return new Promise((resolve, reject) => {
+        device.read((err, data) => {
+            if (err) {
+                reject(err);
+            } else {
+                if (!options.noDebug) {
+                    writeLog('R: ', data);
+                }
+                resolve(data);
+            }
+        });
+    });
 }
 
 function getUhkDevice() {
@@ -119,12 +152,18 @@ function execRetry(command) {
     } while(code && --remainingRetries);
 }
 
-let configBufferIds = {
+const configBufferIds = {
     hardwareConfig: 0,
     stagingUserConfig: 1,
     validatedUserConfig: 2,
 };
 
+const configBufferIdToName = {
+    0: 'hardwareConfig',
+    1: 'stagingUserConfig',
+    2: 'validatedUserConfig',
+}
+
 let eepromOperations = {
     read: 0,
     write: 1,
@@ -199,14 +238,24 @@ function reenumerate(enumerationMode) {
 };
 
 async function sendKbootCommandToModule(device, kbootCommandId, i2cAddress) {
+    writeLog(`T: sendKbootCommandToModule kbootCommandId:${kbootCommandIdToName[kbootCommandId]} i2cAddress:${i2cAddress}`);
     return await uhk.writeDevice(device, [uhk.usbCommands.sendKbootCommandToModule, kbootCommandId, parseInt(i2cAddress)])
 };
 
 async function jumpToModuleBootloader(device, moduleSlotId) {
+    writeLog(`T: jumpToModuleBootloader moduleSlotId:${moduleSlotId}`);
     await uhk.writeDevice(device, [uhk.usbCommands.jumpToModuleBootloader, moduleSlotId]);
 };
 
+async function switchKeymap(device, keymapAbbreviation) {
+    writeLog(`T: switchKeymap keymapAbbreviation:${keymapAbbreviation}`);
+    const keymapAbbreviationAscii = keymapAbbreviation.split('').map(char => char.charCodeAt(0));
+    const payload = [uhk.usbCommands.switchKeymap, keymapAbbreviation.length, ...keymapAbbreviationAscii];
+    return await uhk.writeDevice(device, payload);
+}
+
 async function waitForKbootIdle(device) {
+    writeLog(`T: waitForKbootIdle`);
     const intervalMs = 100;
     const pingMessageInterval = 500;
     let timeoutMs = 10000;
@@ -256,12 +305,98 @@ async function updateModuleFirmware(i2cAddress, moduleSlotId, firmwareImage) {
     await uhk.reenumerate('normalKeyboard');
     device = uhk.getUhkDevice();
     await uhk.sendKbootCommandToModule(device, uhk.kbootCommands.reset, i2cAddress);
+    await sleep(1000);
     await uhk.sendKbootCommandToModule(device, uhk.kbootCommands.idle, i2cAddress);
     device.close();
     config.verbose = false;
     echo('Firmware updated successfully.');
 };
 
+async function updateFirmwares(firmwarePath) {
+    console.log('Updating right firmware');
+    await uhk.updateDeviceFirmware(`${firmwarePath}/devices/uhk60-right/firmware.hex`, 'hex');
+    await uhk.reenumerate('normalKeyboard');
+    console.log('Updating left firmware');
+    await uhk.updateModuleFirmware(uhk.moduleSlotToI2cAddress.leftHalf, uhk.moduleSlotToId.leftHalf, `${firmwarePath}/modules/uhk60-left.bin`);
+}
+
+async function writeConfig(device, configBuffer, isHardwareConfig) {
+    writeLog(`T: writeConfig isHardwareConfig:${isHardwareConfig}`);
+    const chunkSize = 60;
+    let offset = 0;
+    let chunkSizeToRead;
+    let buffer = await uhk.writeDevice(device, [uhk.usbCommands.getDeviceProperty, uhk.devicePropertyIds.configSizes]);
+    const hardwareConfigMaxSize = getUint16(buffer, 1);
+    const userConfigMaxSize = getUint16(buffer, 3);
+    const configMaxSize = isHardwareConfig ? hardwareConfigMaxSize : userConfigMaxSize;
+    const configSize = Math.min(configMaxSize, configBuffer.length);
+
+    writeLog('WR: ...');
+    while (offset < configSize) {
+        const usbCommand = isHardwareConfig ? uhk.usbCommands.writeHardwareConfig : uhk.usbCommands.writeStagingUserConfig;
+        chunkSizeToRead = Math.min(chunkSize, configSize - offset);
+
+        if (chunkSizeToRead === 0) {
+            break;
+        }
+
+        buffer = [
+            usbCommand, chunkSizeToRead, offset & 0xff, offset >> 8,
+            ...configBuffer.slice(offset, offset+chunkSizeToRead)
+        ];
+        await uhk.writeDevice(device, buffer, {noDebug:true})
+        offset += chunkSizeToRead;
+    }
+}
+
+async function applyConfig(device) {
+    writeLog(`T: applyConfig`);
+    await uhk.writeDevice(device, [uhk.usbCommands.applyConfig]);
+}
+
+async function launchEepromTransfer(device, operation, configBufferId) {
+    writeLog(`T: launchEepromTransfer operation:${eepromOperationIdToName[operation]}`);
+    const buffer = await uhk.writeDevice(device, [uhk.usbCommands.launchEepromTransfer, operation, configBufferId]);
+    isBusy = true;
+    writeLog(`T: getDeviceState`);
+    do {
+        const buffer = await uhk.writeDevice(device, [uhk.usbCommands.getDeviceState]);
+        isBusy = buffer[1] === 1;
+    } while (isBusy);
+};
+
+async function writeUca(device, configBuffer) {
+    await uhk.writeConfig(device, configBuffer, false);
+    await uhk.applyConfig(device);
+    await uhk.launchEepromTransfer(device, uhk.eepromOperations.write, configBufferIds.validatedUserConfig);
+}
+
+async function writeHca(device, isIso) {
+    const hardwareConfig = new HardwareConfiguration();
+
+    hardwareConfig.signature = 'UHK';
+    hardwareConfig.majorVersion = 1;
+    hardwareConfig.minorVersion = 0;
+    hardwareConfig.patchVersion = 0;
+    hardwareConfig.brandId = 0;
+    hardwareConfig.deviceId = 1;
+    hardwareConfig.uniqueId = Math.floor(2**32 * Math.random());
+    hardwareConfig.isVendorModeOn = false;
+    hardwareConfig.isIso = isIso;
+
+    const logger = new Logger();
+    const hardwareBuffer = new UhkBuffer();
+    hardwareConfig.toBinary(hardwareBuffer);
+    const buffer = hardwareBuffer.getBufferContent();
+
+    await uhk.writeConfig(device, buffer, true);
+    await uhk.launchEepromTransfer(device, uhk.eepromOperations.write, configBufferIds.hardwareConfig);
+}
+
+async function getModuleProperty(device, slotId, moduleProperty) {
+    await writeDevice(device, [uhk.usbCommands.getModuleProperty, slotId, moduleProperty]);
+}
+
 uhk = exports = module.exports = moduleExports = {
     bufferToString,
     getUint16,
@@ -279,8 +414,16 @@ uhk = exports = module.exports = moduleExports = {
     reenumerate,
     sendKbootCommandToModule,
     jumpToModuleBootloader,
+    switchKeymap,
     waitForKbootIdle,
     updateModuleFirmware,
+    updateFirmwares,
+    writeConfig,
+    applyConfig,
+    launchEepromTransfer,
+    writeUca,
+    writeHca,
+    getModuleProperty,
     usbCommands: {
         getDeviceProperty       : 0x00,
         reenumerate             : 0x01,
@@ -299,6 +442,7 @@ uhk = exports = module.exports = moduleExports = {
         getModuleProperty       : 0x0e,
         getSlaveI2cErrors       : 0x0f,
         setI2cBaudRate          : 0x10,
+        switchKeymap            : 0x11,
     },
     enumerationModes: {
         bootloader: 0,
@@ -332,24 +476,6 @@ uhk = exports = module.exports = moduleExports = {
     },
     configBufferIds,
     eepromOperations,
-    eepromTransfer: {
-        readHardwareConfig: {
-            operation: eepromOperations.read,
-            configBuffer: configBufferIds.hardwareConfig,
-        },
-        writeHardwareConfig: {
-            operation: eepromOperations.write,
-            configBuffer:configBufferIds.hardwareConfig,
-        },
-        readUserConfig: {
-            operation: eepromOperations.read,
-            configBuffer: configBufferIds.validatedUserConfig,
-        },
-        writeUserConfig: {
-            operation: eepromOperations.write,
-            configBuffer: configBufferIds.validatedUserConfig,
-        },
-    },
     kbootCommands: {
         idle: 0,
         ping: 1,
@@ -395,7 +521,11 @@ function writeLog(prefix, buffer) {
     if (!debug) {
         return;
     }
-    console.log(prefix + bufferToString(buffer))
+    if (buffer) {
+        console.log(prefix + bufferToString(buffer))
+    } else {
+        console.log(prefix);
+    }
 }
 
 function checkModuleSlot(moduleSlot, mapping) {

packages/usb/update-firmwares-and-configs.js

@@ -18,7 +18,7 @@ const firmwarePath = program.args[0];
 const layout = program.args[1];
 
 config.verbose = true;
-exec(`${__dirname}/update-all-firmwares.js --overwrite-user-config ${firmwarePath}`);
+exec(`${__dirname}/update-firmwares.js --overwrite-user-config ${firmwarePath}`);
 exec(`${__dirname}/write-hca.js ${layout}`);
 config.verbose = false;
 

packages/usb/update-firmwares.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+const fs = require('fs');
 const program = require('commander');
 const tmp = require('tmp');
 const decompress = require('decompress');
@@ -29,16 +30,14 @@ require('shelljs/global');
             firmwarePath = tmpObj.name;
         }
         config.verbose = true;
-        console.log('Updating right firmware');
-        await uhk.updateDeviceFirmware(`${firmwarePath}/devices/uhk60-right/firmware.hex`, 'hex');
-        await uhk.reenumerate('normalKeyboard');
-        console.log('Updating left firmware');
-        await uhk.updateModuleFirmware(uhk.moduleSlotToI2cAddress.leftHalf, uhk.moduleSlotToId.leftHalf, `${firmwarePath}/modules/uhk60-left.bin`);
+        await uhk.updateFirmwares(firmwarePath);
 
         if (program.overwriteUserConfig) {
-            exec(`${__dirname}/write-config.js ${firmwarePath}/devices/uhk60-right/config.bin`);
-            exec(`${__dirname}/apply-config.js`);
-            exec(`${__dirname}/eeprom.js writeUserConfig`);
+            const device = uhk.getUhkDevice();
+            const configBuffer = fs.readFileSync(`${firmwarePath}/devices/uhk60-right/config.bin`);
+            await uhk.writeConfig(device, configBuffer, false);
+            await uhk.applyConfig(device);
+            await uhk.launchEepromTransfer(device, uhk.eepromOperations.write, uhk.eepromTransfer.writeUserConfig);
         }
 
         config.verbose = false;

packages/usb/write-config.js

@@ -2,50 +2,25 @@
 const program = require('commander');
 const fs = require('fs');
 const uhk = require('./uhk');
-const device = uhk.getUhkDevice();
-require('shelljs/global');
 
-program
-    .usage(`config.bin`)
-    .option('-h, --hardware-config', 'Write the hardware config instead of the user config')
-    .parse(process.argv);
+(async function() {
+    const device = uhk.getUhkDevice();
+    require('shelljs/global');
 
-if (program.args.length == 0) {
-    console.error('No binary config file specified.');
-    exit(1);
-}
+    program
+        .usage(`config.bin`)
+        .option('-h, --hardware-config', 'Write the hardware config instead of the user config')
+        .parse(process.argv);
 
-const configBin = program.args[0];
-const chunkSize = 60;
-const isHardwareConfig = program.hardwareConfig;
-const configTypeString = isHardwareConfig ? 'hardware' : 'user';
-let offset = 0;
-let configBuffer = fs.readFileSync(configBin);
-let chunkSizeToRead;
-
-const payload = new Buffer([uhk.usbCommands.getDeviceProperty, uhk.devicePropertyIds.configSizes]);
-
-device.write(uhk.getTransferData(payload));
-let buffer = Buffer.from(device.readSync());
-const hardwareConfigMaxSize = buffer[1] + (buffer[2]<<8);
-const userConfigMaxSize = buffer[3] + (buffer[4]<<8);
-const configMaxSize = isHardwareConfig ? hardwareConfigMaxSize : userConfigMaxSize;
-const configSize = Math.min(configMaxSize, configBuffer.length);
-
-while (offset < configSize) {
-    const usbCommand = isHardwareConfig ? uhk.usbCommands.writeHardwareConfig : uhk.usbCommands.writeStagingUserConfig;
-    chunkSizeToRead = Math.min(chunkSize, configSize - offset);
-
-    if (chunkSizeToRead === 0) {
-        break;
+    if (program.args.length == 0) {
+        console.error('No binary config file specified.');
+        exit(1);
     }
 
-    buffer = Buffer.concat([
-        new Buffer([usbCommand, chunkSizeToRead, offset & 0xff, offset >> 8]),
-        configBuffer.slice(offset, offset+chunkSizeToRead)
-    ]);
+    const configBin = program.args[0];
+    const isHardwareConfig = program.hardwareConfig;
+    const configTypeString = isHardwareConfig ? 'hardware' : 'user';
+    const configBuffer = fs.readFileSync(configBin);
 
-    device.write(uhk.getTransferData(buffer));
-    device.readSync();
-    offset += chunkSizeToRead;
-}
+    await uhk.writeUserConfig(device, configBuffer, isHardwareConfig);
+})();

packages/usb/write-hca.js

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
-const {HardwareConfiguration, UhkBuffer} = require('uhk-common');
-const {EepromTransfer, getTransferBuffers, ConfigBufferId, UhkHidDevice, UsbCommand} = require('uhk-usb');
-const Logger = require('./logger');
+const uhk = require('./uhk');
 
 if (process.argv.length < 2) {
     console.log(`use: write-hca {iso|ansi}`);
@@ -14,36 +12,7 @@ if (layout !== 'iso' && layout !== 'ansi') {
     process.exit(1);
 }
 
-const hardwareConfig = new HardwareConfiguration();
-
-hardwareConfig.signature = 'UHK';
-hardwareConfig.majorVersion = 1;
-hardwareConfig.minorVersion = 0;
-hardwareConfig.patchVersion = 0;
-hardwareConfig.brandId = 0;
-hardwareConfig.deviceId = 1;
-hardwareConfig.uniqueId = Math.floor(2**32 * Math.random());
-hardwareConfig.isVendorModeOn = false;
-hardwareConfig.isIso = layout === 'iso';
-
-const logger = new Logger();
-
-async function writeHca() {
-    const device = new UhkHidDevice(logger);
-    const hardwareBuffer = new UhkBuffer();
-    hardwareConfig.toBinary(hardwareBuffer);
-    const buffer = hardwareBuffer.getBufferContent();
-    const fragments = getTransferBuffers(UsbCommand.WriteHardwareConfig, buffer);
-    logger.debug('USB[T]: Write hardware configuration to keyboard');
-    for (const fragment of fragments) {
-        await device.write(fragment);
-    }
-
-    logger.debug('USB[T]: Write hardware configuration to EEPROM');
-    await device.writeConfigToEeprom(ConfigBufferId.hardwareConfig);
-}
-
-writeHca()
+uhk.writeHca(layout === 'iso')
     .catch((err)=>{
         console.error(err);
     });

scripts/certs/.gitignore

@@ -0,0 +1,2 @@
+windows-cert.p12
+mac-cert.p12

scripts/release.js

@@ -2,7 +2,7 @@
 const jsonfile = require('jsonfile');
 const exec = require('child_process').execSync;
 
-const TEST_BUILD = process.env.TEST_BUILD;// set true if you would like to test on your local machine
+const TEST_BUILD = process.env.TEST_BUILD; // set true if you would like to test on your local machine
 // set true if running on your dev mac machine where yarn is installed or not need to install
 const RUNNING_IN_DEV_MODE = process.env.RUNNING_IN_DEV_MODE === 'true';
 const DIR = process.env.DIR;
@@ -42,13 +42,13 @@ if (!isReleaseCommit) {
     process.exit(0)
 }
 
-if (process.platform === 'darwin' && !RUNNING_IN_DEV_MODE) {
-    exec('brew install yarn --without-node');
-}
+// if (process.platform === 'darwin' && !RUNNING_IN_DEV_MODE) {
+//     exec('brew install yarn --without-node');
+// }
 
-if (!RUNNING_IN_DEV_MODE) {
-    exec("yarn add electron-builder");
-}
+// if (!RUNNING_IN_DEV_MODE) {
+//     exec("yarn add electron-builder");
+// }
 
 const path = require('path');
 const builder = require("electron-builder");
@@ -82,9 +82,13 @@ if (process.platform === 'darwin') {
     process.exit(1);
 }
 
-if (process.platform === 'darwin') {
-    // TODO: Remove comment when macOS certificates boughted and exported
-    //require('./setup-macos-keychain').registerKeyChain();
+if (process.platform === 'darwin' && process.env.CI) {
+    const encryptedFile = path.join(__dirname, './certs/mac-cert.p12.enc');
+    const decryptedFile = path.join(__dirname, './certs/mac-cert.p12');
+    exec(`openssl aes-256-cbc -K $CERT_KEY -iv $CERT_IV -in ${encryptedFile} -out ${decryptedFile} -d`);
+} else if (process.platform === 'win32') {
+    // decrypt windows certificate
+    exec('openssl aes-256-cbc -K %CERT_KEY% -iv %CERT_IV% -in scripts/certs/windows-cert.p12.enc -out scripts/certs/windows-cert.p12 -d')
 }
 
 if (TEST_BUILD || gitTag) {
@@ -114,10 +118,13 @@ if (TEST_BUILD || gitTag) {
             productName: 'UHK Agent',
             mac: {
                 category: 'public.app-category.utilities',
-                extraResources
+                extraResources,
+                identity: 'CMXCBCFHDG',
+                cscLink: path.join(__dirname, 'certs/mac-cert.p12')
             },
             win: {
-                extraResources
+                extraResources,
+                certificateFile: path.join(__dirname, 'certs/windows-cert.p12')
             },
             linux: {
                 extraResources
@@ -136,8 +143,7 @@ if (TEST_BUILD || gitTag) {
             console.error(`${error}`);
             process.exit(1);
         })
-}
-else {
+} else {
     console.log('No git tag');
     // TODO: Need it?
     process.exit(1);

scripts/setup-macos-keychain.js

@@ -1,20 +0,0 @@
-'use strict'
-
-const cp = require('child_process')
-const path = require('path')
-
-function registerKeyChain() {
-    const encryptedFile = path.join(__dirname, '../certs/developer-id-cert.p12.enc')
-    const decryptedFile = path.join(__dirname, '../certs/developer-id-cert.p12')
-    cp.execSync(`openssl aes-256-cbc -K $encrypted_04061b49eb95_key -iv $encrypted_04061b49eb95_iv -in ${encryptedFile} -out ${decryptedFile} -d`)
-
-    const keyChain = 'mac-build.keychain'
-    cp.execSync(`security create-keychain -p travis ${keyChain}`)
-    cp.execSync(`security default-keychain -s ${keyChain}`)
-    cp.execSync(`security unlock-keychain -p travis ${keyChain}`)
-    cp.execSync(`security set-keychain-settings -t 3600 -u ${keyChain}`)
-
-    cp.execSync(`security import ${decryptedFile} -k ${keyChain} -P $KEY_PASSWORD -T /usr/bin/codesign`)
-}
-
-module.exports.registerKeyChain = registerKeyChain