From d11c532ea4591df98fbf2c9e1e2170fb20cd8cd2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= <laci@monda.hu>
Date: Tue, 22 May 2018 00:38:27 +0200
Subject: [PATCH] Add a lot of useful instructions to the firmware page.

---
 packages/uhk-common/src/util/constants.ts      |  1 +
 .../firmware/device-firmware.component.html    | 18 ++++++++++--------
 .../firmware/device-firmware.component.scss    |  4 ++++
 .../firmware/device-firmware.component.ts      |  7 +++++++
 4 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/packages/uhk-common/src/util/constants.ts b/packages/uhk-common/src/util/constants.ts
index c9cc8a3d..9157901d 100644
--- a/packages/uhk-common/src/util/constants.ts
+++ b/packages/uhk-common/src/util/constants.ts
@@ -1,3 +1,4 @@
 export namespace Constants {
     export const AGENT_GITHUB_URL = 'https://github.com/UltimateHackingKeyboard/agent';
+    export const FIRMWARE_GITHUB_ISSUE_URL = 'https://github.com/UltimateHackingKeyboard/agent/issues/567';
 }
diff --git a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.html b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.html
index 1c537cac..62f72578 100644
--- a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.html
+++ b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.html
@@ -12,14 +12,16 @@
                 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>
+            If the update process fails, consider the following points:
+            <ol>
+                <li>Windows 7, Windows Vista, and Windows XP are not supported. Use Linux, OSX, Windows 10, or Windows 8.</li>
+                <li>Connect your UHK directly to the host computer. Don't use USB hubs or KVM switches.</li>
+                <li>Run Agent directly on the host operating system. Don't use VirtualBox or VMware Workstation.</li>
+                <li>Give a try to every USB port of your computer.</li>
+                <li>If the left half becomes unresponsive after a failed update then retry and follow the instructions displayed during the update to fix it.</li>
+                <li>If the above fails, retry a couple of times.</li>
+                <li>If everything else fails, please add a new comment to <a class="link-github" (click)="openFirmwareGitHubIssuePage($event)">the GitHub issue</a>, and attach the update log.</li>
+            </ol>
 
             <p>
                 <button class="btn btn-primary"
diff --git a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.scss b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.scss
index 79021377..808a0a4a 100644
--- a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.scss
+++ b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.scss
@@ -5,3 +5,7 @@
     min-height: 100%;
     width: 100%;
 }
+
+.link-github {
+    cursor: pointer;
+}
diff --git a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.ts b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.ts
index c100a4c2..67b4dc1c 100644
--- a/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.ts
+++ b/packages/uhk-web/src/app/components/device/firmware/device-firmware.component.ts
@@ -3,6 +3,8 @@ import { Store } from '@ngrx/store';
 import { Observable } from 'rxjs/Observable';
 import { Subscription } from 'rxjs/Subscription';
 import { HardwareModules, VersionInformation } from 'uhk-common';
+import { Constants } from 'uhk-common';
+import { OpenUrlInNewWindowAction } from '../../../store/actions/app';
 
 import {
     AppState,
@@ -60,4 +62,9 @@ export class DeviceFirmwareComponent implements OnDestroy {
         }.bind(this);
         fileReader.readAsArrayBuffer(files[0]);
     }
+
+    openFirmwareGitHubIssuePage(event): void {
+        event.preventDefault();
+        this.store.dispatch(new OpenUrlInNewWindowAction(Constants.FIRMWARE_GITHUB_ISSUE_URL));
+    }
 }