fixed things I broke and added an example

added OS Condition example
lima3w · Apr 11, 2021 · 60b331f · 60b331f
1 parent 46cb54b
commit 60b331f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/README-adv.md b/README-adv.md
@@ -28,6 +28,8 @@ Example: String OS = "Linux";
 ```
 Otherwise, for auto-detection leave it blank.
 
+You may also use the global variable ```OS``` within your hotkey definitions.
+
 You can also dynamically set the HostOS at boot time by holding down one of the top 4 keys when the device powers on.
 [1] = Windows, [2] = MacOS, [3] = Linux, [4] = Other
 
@@ -171,6 +173,14 @@ your OS, so use with caution.  The Hack Hotkey also will most likely not be able
 The code also does not properly identify mobile OS', and may identify them as Mac, Linux or unsure.
 ```c
 Usage: osCondition("Windows Value","MacOS Value","Linux Value","Unsure");
+
+Example: 
+
+String key5[] = {
+         "I love using my hacker hotkey on "+OS+"\n",
+         osCondition("yay Bill Gates!\n","yay Steve Jobs!\n","yay Linus Torvalds!\n","yay!\n")
+};
+
 ```
 Always include each argument even if it is a blank string ("");
 

diff --git a/hackerHotKey/hackerHotKey.ino b/hackerHotKey/hackerHotKey.ino
@@ -50,19 +50,19 @@ void loop() {
     delay(200);
   }
   else if (digitalRead(BTN5) == LOW) {
-    Keyboard.println("!vote 4\n");
+    Keyboard.println("!vote 4");
     delay(200);
   }
   else if (digitalRead(BTN6) == LOW) {
-    Keyboard.println("!vote 3\n");
+    Keyboard.println("!vote 3");
     delay(200);
   }
   else if (digitalRead(BTN7) == LOW) {
-    Keyboard.println("!vote 2\n");
+    Keyboard.println("!vote 2");
     delay(200);
   }
   else if (digitalRead(BTN8) == LOW) {
-    Keyboard.println("!vote 1\n");
+    Keyboard.println("!vote 1");
     delay(200);
   }
 }
diff --git a/hackerhotkey-adv/hackerhotkey-adv.ino b/hackerhotkey-adv/hackerhotkey-adv.ino
@@ -26,6 +26,8 @@
      If you want to force Hacker Hotkey to act as if it's connected to a specific OS, set it here.  
      Valid options are "Windows", "MacOS", "Linux", "Other". Example:  String OS = "Linux";
      Otherwise, for auto-detection leave it blank.
+
+     You may also use the global varialbe "OS" within your hotkey definitions.
   */
 
 String OS = ""; 
@@ -204,7 +206,13 @@ void defineHotkeys() {
      your OS, so use with caution.  The Hack Hotkey also will most likely not be able to identify a host within a VM.
      The code also does not properly identify mobile OS', and may identify them as Mac, Linux or unsure.
 
-     Usage: osCondition("Windows Value","MacOS Value","Linux Value","Unsure");
+     Usage: osCondition("Windows Value","MacOS Value","Linux Value","Unsure")
+
+     Example: 
+       String key5[] = {
+                  "I love using my hacker hotkey on "+OS+"\n",
+                  osCondition("yay bill gates!\n","yay Steve Jobs!\n","yay Linus Torvalds!\n","yay!\n")
+       };
 
      Always include each argument even if it is a blank string ("");