This Action will run a script or an immediate script. When the Action is selected, you may be are presented with a number of options. As in many other Event Actions, there will be a Basic (standard) Editing Mode or Advanced Editing mode. You can tell what mode the Event Group is in by the 3rd icon at the top.
Standard is represented by a blue bird. Clicking on the icon will cause it to toggle into the other mode.
Advanced is represented by a red airplane
If you are in Basic Editing Mode and select the Action, you will see minimal options
Click on the red airplane and the Event will toggle into the Advanced Editing Mode
Here you can select a script to use. After selecting one and clicking on Submit, you will see the script in an editing window.
Here you can edit the script or leave it alone. If you do edit it, you must click on Save Script Edits to commit the changes to the script. There are also two windows, one to select a Subroutine or Function and the second to pass Parameters to the script. Both of these have pop-up editing boxes like most Event entries. In the script above there is only one Sub so it need not be named and two parameters can be passed - the Reference ID of a dimmer and the percentage (+-) to dim the device. Here it will increase the level of device 1234 by 10%. The parameters are passed to the script and the "Main" subroutine will be run.
You can also choose to run an Immediate Script Command. This is a single line scripting function that you can enter to be run with the action
Here is the hs.writelog command creating a single log entry with the Type "Trace" and the message "This is a test log entry.
This will simply create a log entry
Dec-28 12:34:46 PM Trace This is a test log entry
Creating scripts is beyond the scope of these threads, but this should allow you to run your own scripts or those form other authors. All scripts must be in the \HomeSeer HS3\scripts directory.
Standard is represented by a blue bird. Clicking on the icon will cause it to toggle into the other mode.
Advanced is represented by a red airplane
If you are in Basic Editing Mode and select the Action, you will see minimal options
Click on the red airplane and the Event will toggle into the Advanced Editing Mode
- Wait for script to finish before continuing will suspend further processing of actions until the script is completed
- Only allow a single instance to run at a time will prevent the script from being launched again if it is currently running
- Immediate script command allows running a single line scripting function. That will be covered below
Here you can select a script to use. After selecting one and clicking on Submit, you will see the script in an editing window.
Here you can edit the script or leave it alone. If you do edit it, you must click on Save Script Edits to commit the changes to the script. There are also two windows, one to select a Subroutine or Function and the second to pass Parameters to the script. Both of these have pop-up editing boxes like most Event entries. In the script above there is only one Sub so it need not be named and two parameters can be passed - the Reference ID of a dimmer and the percentage (+-) to dim the device. Here it will increase the level of device 1234 by 10%. The parameters are passed to the script and the "Main" subroutine will be run.
You can also choose to run an Immediate Script Command. This is a single line scripting function that you can enter to be run with the action
Here is the hs.writelog command creating a single log entry with the Type "Trace" and the message "This is a test log entry.
This will simply create a log entry
Dec-28 12:34:46 PM Trace This is a test log entry
Creating scripts is beyond the scope of these threads, but this should allow you to run your own scripts or those form other authors. All scripts must be in the \HomeSeer HS3\scripts directory.
Comment