User Tools

Site Tools


manual:Scripting

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
manual:Scripting [2018/03/18 04:31]
peternlewis Keyboard Maestro editor
manual:Scripting [2019/07/15 03:33]
peternlewis [Controlling Keyboard Maestro via Scripting]
Line 18: Line 18:
 For example, the [[action:​Execute_an_AppleScript]] Action:\\ For example, the [[action:​Execute_an_AppleScript]] Action:\\
 {{:​km-7.3-execute-script.png?​nolink|}}\\ {{:​km-7.3-execute-script.png?​nolink|}}\\
 +
 +**There are two setup options:**
 +^ Setup Option ^ Choices\\ (Default shown first) ^
 +| Script location | Execute text script (type or paste script into Action text field)\\ Execute script file (This is faster if it is a compiled script file `.scpt`) |
 +| Script Results | Ignored.\\ Displayed in a floating window.\\ Displayed briefly in a Notification.\\ Typed in the current text field that has focus.\\ Pasted in text field that has focus.\\ Saved to a Keyboard Maestro Variable.\\ Saved to the System or Named Clipboard.\\ Ignore Results and run //​Asynchronously//​ (the script runs while the macro continues on to the next //​Action//​.) |
 +
  
 ==== Getting Script Results ==== ==== Getting Script Results ====
Line 207: Line 213:
 See the Keyboard Maestro AppleScript dictionary for more information. See the Keyboard Maestro AppleScript dictionary for more information.
  
-===== URL Schemes ​=====+===== Controlling Keyboard Maestro Engine via Scripting ​=====
  
-==== Editor ====+You can adjust Keyboard Maestro Engine windows with:
  
-Another way you can control ​Keyboard Maestro ​editor is using the "`keyboardmaestro`"​ URL scheme, which supports the following formats: +<code applescript>​ 
- +tell application "Keyboard Maestro ​Engine
-^ Example Editor URL Command ^ Description ^ +    set bounds of window ​"Clipboard History Switcher" ​to {10005020001200
-| `keyboardmaestro://​u=support%40stairways.com/​s=ABCDEFGH0123456789` | enter your username/​serial number. | +end tell 
-| `keyboardmaestro://​m=Activate%20Application%20Switcher`\\ `keyboardmaestro://​m=D2F427A1-51E3-4719-820B-4C25B6FF7329` | edit a specific macro or macro group.\\ You may used either the Macro Name, or UUID. | +</​code>​
-| `keyboardmaestro://​q=Activate` | filter macros with this keyword. | +
-| `keyboardmaestro://​g=All%20Macros/​q=Activate` | select a macro group and filter macros with this keyword. | +
-| `keyboardmaestro://​a=Execute` | filter actions with this keyword. | +
-| `keyboardmaestro://​c=All%20Actions/​a=Execute` | select action category and filter actions with this keyword. | +
- +
---- +
- +
-==== Triggers ==== +
- +
-You can trigger a macro (that is Active and Enabled) using the "`kmtrigger`" ​URL scheme. ​ The URL uses this format: +
- +
-`kmtrigger://​macro=<​Macro Name or UUID>​[&<​Trigger Value>​]` +
- +
-where +
-  * `<Macro Name or UUID>` is either the Macro NameORits UUID +
-  * `<​Trigger Value>` is the _optional_ Trigger Value +
-  * `[ ]` are _not_ included. ​ Used only to show _optional_ parameters +
-  * `&` must precede the Trigger Valueif it is provided. +
- +
-Note both Macro Name and Trigger Value must be URL encoded. +
- +
-You can easily get the Trigger URL by clicking on the "Or by Script"​ Trigger option, and selecting "Or by URL"​. +
- +
-{{:​manual:​km-7.3-macro-trigger-url-setup.png?​nolink|}+
- +
-{{:​manual:​km-7.3-macro-trigger-url-results.png?​nolink|}}+
  
-^ Example Trigger URL Command ^ Description ^ 
-| `kmtrigger://​macro=Your%20Macro%20Name` | Using the Macro Name | 
-| `kmtrigger://​macro=224AA8CB-07EB-4C92-8201-68FED82B6E9F` | Using the Macro UUID | 
-| `kmtrigger://​macro=Your%20Macro%20Name&​value=Your%20Trigger%20Value` | Using Macro Name with Trigger Value | 
-| `kmtrigger://​macro=224AA8CB-07EB-4C92-8201-68FED82B6E9F&​value=Your%20Trigger%20Value` | Using Macro UUID with Trigger Value  | 
  
manual/Scripting.txt · Last modified: 2019/07/15 03:33 by peternlewis