User Tools

Site Tools


AppleScript

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
AppleScript [2017/01/13 20:37]
JMichaelTX Last update for @Tom LOL
AppleScript [2019/03/28 14:41] (current)
JMichaelTX ADD tell block to first example.
Line 1: Line 1:
 ====== Using AppleScript to Get and Set Keyboard Maestro Variables ====== ====== Using AppleScript to Get and Set Keyboard Maestro Variables ======
-\\ 
-===== Get and Set Variables ===== 
  
 Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript. Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript.
Line 7: Line 5:
 In AppleScript,​ you can tell the application "​Keyboard Maestro Engine"​ to: In AppleScript,​ you can tell the application "​Keyboard Maestro Engine"​ to:
  
 +```applescript
 +tell application "​Keyboard Maestro Engine"​
     getvariable <KM Variable Name>     getvariable <KM Variable Name>
     setvariable <KM Variable Name> to <New Value>     setvariable <KM Variable Name> to <New Value>
 +end tell
 +```
  
 where both the `<KM Variable Name>` and `<New Value>` are text values. where both the `<KM Variable Name>` and `<New Value>` are text values.
  
-==== Examples ​====+**For more details, see:** 
 +  - [[manual:​Scripting|Scripting article in the Manual Section]]. 
 +  - [[action:​Execute_an_AppleScript|Execute AppleScript Action]]. 
 + 
 +===== Global Variables ​===== 
 + 
 +Global Variables (available in //all// macros) may be got and set like this:
  
 ```applescript ```applescript
Line 44: Line 52:
 ``` ```
  
 +**Real-World Example**
  
 Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\ Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\
Line 50: Line 58:
  
 ```applescript ```applescript
 +### Requires Keyboard Maestro 7.1+ ###
 +
 --- GET REQUIRED KM VARIABLES --- --- GET REQUIRED KM VARIABLES ---
  
Line 67: Line 77:
 ``` ```
  
 +===== Local & Instance Variables =====
  
-**For more details, see [[manual:​Scripting|Scripting article in the Manual Section]].** 
  
-----+To get or set [[manual:​Variables#​Instance_Variables_v8|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+).
  
-===== Prior to Ver 7.1 =====+  * //Local Variables// are denoted by a Variable with the prefix of "​Local"​. 
 +  * //Instance Variables// are denoted by a Variable with the prefix of "​Instance"​.
  
-  * 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. +```applescript 
-  * They present an alternate method.+### Requires ​Keyboard Maestro ​8.0.3+ ###
  
-==== Create & Set Variable ​====+set kmInst to system attribute "​KMINSTANCE"​ 
 +tell application "​Keyboard Maestro Engine"​ 
 + set kmLocalVar1 to getvariable "​Local__SomeLocalVariable"​ instance kmInst 
 + setvariable "​Local__FromAS"​ instance kmInst to "Variable ​set in AppleScript."​ 
 +end tell
  
-```applescript +log kmLocalVar1 
---- Requires KM 7.0.2+ ---+```
  
---- Set AppleScript Variables to KM Variable Name and Value --- 
-set myKMVar to "My KM Var Name" 
-set myASVar to "My data" 
  
 +===== Dictionary Values =====
 +
 +You can read and write [[manual:​Dictionaries|Dictionary]] values from AppleScript.
 +
 +```applescript
 +### Requires Keyboard Maestro 8.0+ ###
  
 tell application "​Keyboard Maestro Engine"​ tell application "​Keyboard Maestro Engine"​
-  if variable myKMVar exists then + set kmDictList to name of dictionaries 
-    --- SET KM Variable --- + set dictKeyList ​to dictionary keys of dictionary "First Names" 
-    ​set value of variable myKMVar ​to myASVar + 
-  else + set value of dictionary key "​P"​ of dictionary "First Names" to "​Fred"​
-    --- Create & Set KM Variable --- +
-    make new variable with properties {name:​myKMVar, ​value:myASVar} +
-  end if+
 end tell end tell
 ``` ```
  
-==== Get Existing ​Variable ====+===== 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 ```applescript
---- Requires KM 7.0.2+ ---+my setKMVar("​MY_KM_Variable",​ "some new value"​)
  
---- Set AppleScript Variables to KM Variable ​Name and Value --- +on setKMVar(pKMVarNameStr,​ pValueStr) 
-set myKMVar ​to "My KM Var Name+   
-set myASVar ​to "​TBD" ​-- default value of KM variable, ​will be updated+  ​--- 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:​pKMVarNameStrvalue:​pValueStr} 
 +        set varCreatedBool to true 
 +         
 +      else 
 +        error ("​Error " & errNum & ": ​ " & errMsg) 
 +      end if 
 +      -- END on error 
 +       
 +    end try 
 +  end tell 
 +   
 +  return varCreatedBool 
 +   
 +end setKMVar 
 +```
  
-tell application ​"Keyboard Maestro Engine" + 
-  ​if variable ​myKMVar ​exists then +==== Get Variable ==== 
-    --- GET Existing KM Variable ​--- +(returns empty string ​""​ if Variable does //not// exist) 
-    set myASVar ​to value of variable ​myKMVar + 
-  else +```applescript 
-    --- KM Variable NOT Found --- + 
-    set myASVar ​to ""​ +set myKMVar ​to my getKMVar("​MY_KM_Variable"​) 
-    -- Optionally, throw an AppleScript ​error -- + 
-    ​error "​[ERROR] KM Variable '"​ & myKMVar & "'​ was NOT found."​ +on getKMVar(pKMVarNameStr) 
-  end if + 
-end tell+  ​--- 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
 ``` ```
AppleScript.1484357859.txt.gz · Last modified: 2017/01/13 20:37 by JMichaelTX