Differences

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

Link to this comparison view

Next revision		 Previous revision
indigo_7.3_documentation:plugins:growl_1 [2019/01/25 22:53] – external edit 127.0.0.1indigo_7.3_documentation:plugins:growl_1 [2025/04/14 20:10] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Growl Plugin ======
 +
 +
 +The Growl Plugin for Indigo allows you to send growl messages via a plugin action in the Actions UI tab. Before you try to use this plugin you need to install [[http://www.growl.info/|Growl]].
 +
 +<color red>Note</color>: Version 1.0.5 and later of this plugin supports both Growl 1.2 and 1.3. However, you must select the correct version in the plugin preferences because the Growl API is specific to the version being used.
 +==== Notification Types ====
 +
 +
 +The Growl Plugin creates 8 "notifications", which show up in the Growl preference pane. You can customize each of these notification types as desired in Growl. You can also change the names (and remove them entirely if desired) via the plugin's preferences:
 +
 +{{:plugins:growl_preferences.png?nolink|Growl Preferences Image}}
 +
 +By leaving any of the notifications blank, you can remove that notification type. It won't show up in the action config dialog or in Growl as a notification type.
 +
 +==== Notification Action ====
 +
 +When you're ready to send a notification, you just add a "Notification" action and adjust its options via the action config dialog:
 +
 +{{:plugins:growl_action_config.png?nolink|Growl Action Configuration Image}}
 +
 +There are 5 fields for each notify action described below
 +
 +  - Type - this specifies the notification type (see above to configure those)
 +  - Title† - this is the title of the notification - typically shown at the top of the notification window
 +  - Description† - this is the description of the notification, typically shown in the main content area of the notification
 +  - Priority - that's the Growl-defined priority (not used by most Growl themes)
 +  - Sticky - that indicates whether the notification will require the user to manually close it or if Growl will close it automatically after some period of time
 +
 +† - the title and description fields may contain substitution markup. So, as you can see from the example above, we're substituting the value of variable ID 867446802 in the title and variable ID 264884531 in the description. See [[variable_substitution|Substitutions]] for more information.
 +
 +
 +===== Scripting Support =====
 +
 +As with all plugins, actions defined by this plugin may be executed by [[indigo_7.3_documentation:plugin_scripting_tutorial&#scripting_indigo_plugins|Python scripts]]. Here's the information you need to script the actions in this plugin.
 +
 +**Plugin ID**: com.perceptiveautomation.indigoplugin.Airfoil
 +
 +==== Action specific properties ====
 +
 +=== Notify ===
 +
 +**Action id**: notify
 +
 +Properties for scripting:
 +
 +|  //''type''//  |the string key of the notification type, must be one of: 'notification1', 'notification2', 'notification3', 'notification4', 'notification5', 'notification6', 'notification7', 'notification7' and must be enabled in the preferences (see preferences above) |
 +|  //''title''//  |the title of the growl notification |
 +|  //''descString''//  |the full text of the notification |
 +|  //''priority''//  |the optional number priority for the notification: -2 (very low) through 2 (emergency) - defaults to 0 (normal priority) |
 +|  //''sticky''//  |optional boolean that will cause the notification to stick (not automatically disappear) - defaults to False |
 +
 +Example:
 +
 +<code>growlPlugin = indigo.server.getPlugin("com.perceptiveautomation.indigoplugin.growl")
 +if growlPlugin.isEnabled():
 + growlPlugin.executeAction("notify", props={'type':"notification1", 'title':"Growl Title", 'descString':"Description of Growl Notification", 'priority':0, 'sticky':False})</code>
 +
 +===== Support and Troubleshooting =====
 +
 +For usage or troubleshooting tips [[https://forums.indigodomo.com/viewforum.php?f=94|discuss this plugin]] on our forum.