Differences

This shows you the differences between two versions of the page.

--- AppleScript [2015/12/16 13:12]
ccstone
+++ AppleScript [2017/10/04 02:52]
peternlewis [Examples]
@@ Line 1: / Line 1: @@
-====== AppleScript Tips and Tricks for Keyboard Maestro ======
+====== Using AppleScript to Get and Set Keyboard Maestro Variables ======
-\\
-==== Create Keyboard Maestro variable using AppleScript. ====
+===== Get and Set Variables =====
+Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript.
+In AppleScript, you can tell the application "Keyboard Maestro Engine" to:
+    getvariable <KM Variable Name>
+    setvariable <KM Variable Name> to <New Value>
+where both the `<KM Variable Name>` and `<New Value>` are text values.
+==== Examples ====
+```applescript
+### Requires Keyboard Maestro 7.1+ ###
+--- Set AppleScript Variables to KM Variable Name and Value ---
+set myKMVar to "My KM Var Name"
+set myASVar to "TBD" -- default value of KM variable, will be updated
-<code>
-# Keyboard Maestro — Create variable "<variable name>"
 tell application "Keyboard Maestro Engine"
-  make new variable with properties {name:"MyVariableName", value:MyVariableValue}
+  ### GET ###
+  -- IF KM Variable does NOT exist, the AS Variable will be set to empty string --
+  -- Use Explicit Quoted Text --
+  set myASVar to getvariable "My KM Var Name"
+  -- OR, Use Previously Defined AppleScript Variables --
+  set myASVar to getvariable myKMVar
+  ### SET ###
+  -- IF KM Variable does NOT exist, it will be created --
+  -- Use Explicit Quoted Text --
+  setvariable "My KM Var Name" to "A new value"
+  -- OR, Use Previously Defined AppleScript Variables --
+  setvariable myKMVar to myASVar
 end tell
-</code>
+```
-Note – the variable name MUST be a string, although you can hold that string in a varible:
-<code>
-set someVariable to "MyVariableName"
-make new variable with properties {name:someVariable, value:MyVariableValue}
-</code>
-==== Set Keyboard Maestro variable using AppleScript. ====
+Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\
+Here's a real-world example, but with the error checking removed to simplify.
-<code>
+```applescript
-# Keyboard Maestro — Set value of variable "<variable name>"
+--- GET REQUIRED KM VARIABLES ---
-# Requires KM7.0.2 or higher.
-set myText to "whatever"
 tell application "Keyboard Maestro Engine"
-  if variable "myKMVariableName" exists then
+  set mainStr to getvariable "SCPT__MainString"
-    set value of variable "myKMVariableName" to myText
+  set subStr to getvariable "SCPT__StringToFind"
-  else
-    make new variable with properties {name:"myKMVariableName", value:myText}
-  end if
 end tell
-</code>
-==== Get Keyboard Maestro variable using AppleScript. ====
+--- PROCESS THESE KM VARIABLES ---
-<code>
+--- Get Start of StringToFind ---
-# Keyboard Maestro — Get value of variable "<variable name>"
+set posSubStr to offset of subStr in mainStr
-# Requires KM7.0.2 or higher.
+--- SET OUTPUT KM VARIABLE ---
+tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
+```
+To get or set local or instance variables, you must pass the macro execution instance to the `getvariable` or `setvariable` command.  The instance is passed in to your script via the KMINSTANCE environment variable (v8.0.3+).
+```applescript
+set inst to system attribute "KMINSTANCE"
 tell application "Keyboard Maestro Engine"
-  if variable "myKMVariableName" exists then
+	set v to getvariable "LocalVar" instance inst
-    set myAppleScriptVariableName to value of variable "myKMVariableName"
+	setvariable "LocalOut" instance inst to "FromAS"
-  end if
 end tell
-</code>
+v
+```
+**For more details, see [[manual:Scripting|Scripting article in the Manual Section]].**
+===== Get and Set Dictionary Values =====
+You can read and write dictionary values from AppleScript.
+```applescript
+tell application "Keyboard Maestro Engine"
+	name of dictionaries
+end tell
+```
+```applescript
+tell application "Keyboard Maestro Engine"
+	dictionary keys of dictionary "First Names"
+end tell
+```
+```applescript
+tell application "Keyboard Maestro Engine"
+	set value of dictionary key "P" of dictionary "First Names" to "Fred"
+end tell
+```
+===== Prior to Ver 7.1 =====
+  * All of the below scripts were designed for use with Keyboard Maestro prior to version 7.1, but they will still work with the latest version.
+  * They present an alternate method.
+==== Set Variable ====
+(will be created if necessary)
+```applescript
+my setKMVar("MY_KM_Variable", "some new value")
+on setKMVar(pKMVarNameStr, pValueStr)
+  --- Compatible with Keyboard Maestro 6+ ---
+  --     • Creates the KM Variable if does not exist (just like KM 7 setvariable)
+  --     • Returns true if new Variable was created
+  set varCreatedBool to false
+  tell application "Keyboard Maestro Engine"
+    try
+      set value of variable pKMVarNameStr to pValueStr
+    on error errMsg number errNum
+      if (errNum = -10006) then --- KM Variable Does NOT Exist ---
+        --- Create & Set KM Variable ---
+        make new variable with properties {name:pKMVarNameStr, value:pValueStr}
+        set varCreatedBool to true
+      else
+        error ("Error " & errNum & ":  " & errMsg)
+      end if
+      -- END on error
+    end try
+  end tell
+  return varCreatedBool
+end setKMVar
+```
+==== Get Variable ====
+(returns empty string "" if Variable does //not// exist)
+```applescript
+set myKMVar to my getKMVar("MY_KM_Variable")
+on getKMVar(pKMVarNameStr)
+  --- Compatible with Keyboard Maestro 6+ ---
+  --     • Returns "" if variable is not found (just like KM 7 getvariable)
+  tell application "Keyboard Maestro Engine"
+    try
+      set kmVar to value of variable pKMVarNameStr
+    on error errMsg number errNum
+      if (errNum = -1728) then
+        --- KM Variable NOT Found ---
+        set kmVar to ""
+      else
+        error errMsg
+      end if
+      -- END on error
+    end try
+  end tell
+  return kmVar
+end getKMVar
+```

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools