CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


hardware:rules

Differences

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

Link to this comparison view

hardware:rules [2014/01/13 04:56]
jarrod created
hardware:rules [2015/12/23 00:26] (current)
jarrod [Rule Properties]
Line 15: Line 15:
  
   * **Name** = A name given to the rule for your records. The name has no effect on anything, it's just a way to remember what a rule was created for.   * **Name** = A name given to the rule for your records. The name has no effect on anything, it's just a way to remember what a rule was created for.
-  * **Search String** = A search pattern to match an outgoing CFLink message (as well as incoming TCP/UDP packets for LAN Bridge rules). When this search pattern matches ​any the message, the rule is triggered.\\ Search strings can contain wildcard match characters as follows:+  * **Search String** = A search pattern to match an outgoing CFLink message (as well as incoming TCP/UDP packets for LAN Bridge rules). When this search pattern matches ​message, the rule is triggered.\\ Search strings can contain wildcard match characters as follows:
     * ''​*''​ (asterisk) means match any character zero or more times, until the next defined character in the search string is found, or until the end of the message.     * ''​*''​ (asterisk) means match any character zero or more times, until the next defined character in the search string is found, or until the end of the message.
     * ''​.''​ (period) means match any character a single time.     * ''​.''​ (period) means match any character a single time.
Line 29: Line 29:
     * **Delay** = The delay before the command data for this action is sent. This delay is sequential, meaning its the delay from the action above it, NOT a delay from the start of the macro. The delay occurs BEFORE the command is sent. Use a delay of 0 (zero) to instantly send the command data.     * **Delay** = The delay before the command data for this action is sent. This delay is sequential, meaning its the delay from the action above it, NOT a delay from the start of the macro. The delay occurs BEFORE the command is sent. Use a delay of 0 (zero) to instantly send the command data.
  
 +====== System Commander Rules Tab ======
 +The rules tab within [[software:​system-commander|System Commander]] allows you to create and add macros and rules to be run on your device. This tab is identical across all CommandFusion hardware that supports our Rules Engine.
  
-===== CFLink Protocol =====+{{:​hardware:​lan-bridge:​lan-bridge-configuration:​lan_bridge_rules_tab.png?​nolink|}} 
 + 
 +A detailed explanation of how to program macros and rules can be found in our [[software:​system-commander:​quick-start-guide:​quick-start-page-3|System Commander Quick Start Guide here.]] 
 + 
 +===== 1 - Rules ===== 
 +A rule watches for a specific event, then runs a macro when that event occurs. 
 + 
 +===== 2 - Macro/​Action ===== 
 +A macro must always be created first, as a rule will trigger a macro. A macro is a pre-defined set of actions to be run when triggered by a rule. 
 + 
 +===== 3 - Buttons ===== 
 +==== Backup to File ==== 
 +This button allows you to backup your rules and macros to a local file. This can be file can be kept as a backup, or used to load the rules and macros onto a different device. 
 + 
 +==== Restore to File ==== 
 +This button allows you to choose a locally stored backup file to load macros/​rules onto the current device. 
 + 
 +==== Clear Device Rules ==== 
 +Erases all rules all rules and macros from the current device. 
 + 
 +==== Load From Device ==== 
 +Loads the rules and macros currently stored on the device and shows them in System Commander. 
 + 
 +==== Save to Device ==== 
 +Saves all changes made to the device. 
 + 
 +====== CFLink Protocol ​======
 For details on the CFLink protocol used to create and delete rules, please see the [[hardware:​cflink:​rules|Rules Protocol wiki entry]]. For details on the CFLink protocol used to create and delete rules, please see the [[hardware:​cflink:​rules|Rules Protocol wiki entry]].
hardware/rules.1389588979.txt.gz · Last modified: 2014/01/13 04:56 by jarrod