CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


software:gui-designer:system-manager:system-properties

Differences

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

Link to this comparison view

software:gui-designer:system-manager:system-properties [2012/09/04 05:40]
jarrod
software:gui-designer:system-manager:system-properties [2015/01/29 05:57] (current)
jarrod [Ports]
Line 1: Line 1:
 ====== System Properties ====== ====== System Properties ======
  
-{{:​software:​gui-designer:​system_properties_tcp.png?​nolink|}}+{{:​software:​gui-designer:​system-manager:​system_properties_tcp.png?​nolink|}}
  
 ==== System Name ==== ==== System Name ====
Line 21: Line 21:
  
 ==== Ports ==== ==== Ports ====
-There are two port settings available for each system, the destination port (labeled simply '​port'​) and the origin port.\\+There are two port settings available for each system, the destination port (labeled simply '​port'​) and the origin port (source port).\\
 The destination port is the port number the external system is accepting connections on, whilst the origin port is the port number that iViewer is sending messages from. Some systems require commands to be sent to a specific port, but replies are sent on a different port (common amongst UDP systems mainly).\\ The destination port is the port number the external system is accepting connections on, whilst the origin port is the port number that iViewer is sending messages from. Some systems require commands to be sent to a specific port, but replies are sent on a different port (common amongst UDP systems mainly).\\
 You only have to enter the '​Port'​ setting most of the time (the origin port will use the destination port setting if it is not explicitly set).\\ You only have to enter the '​Port'​ setting most of the time (the origin port will use the destination port setting if it is not explicitly set).\\
-The port numbers must be in the range 1 to 65535. See http://​www.iana.org/​assignments/​port-numbers for more details on port number usage in general.+The port numbers must be in the range 1 to 65535. See http://​www.iana.org/​assignments/​port-numbers for more details on port number usage in general.\\ 
 +**Note that you cannot use UDP ports below 1024 on Android platform. This is a limitation of Android.**
  
 +=== For UDP systems ===
 +If the origin port is set to ''​0'',​ it will use the same port number as the destination port.\\
 +If the origin port is set to ''​-1'',​ iViewer will randomly assign an available source port - but //ONLY// if the system is //not// set to accept incoming data (it will use the destination port in this case).
 ==== Accept Broadcast Messages ==== ==== Accept Broadcast Messages ====
 When in UDP mode, this allows the system to receive UDP broadcast packets. When in UDP mode, this allows the system to receive UDP broadcast packets.
Line 39: Line 43:
  
 ==== Maintain constant connection ==== ==== Maintain constant connection ====
-When this setting is enabled, the [[software:gui-designer:​system-manager:​feedback-parsing:​viewers|Viewer]] running the GUI project will attempt to connect to the system on startup, and maintain the connection if any dropouts occur by attempting reconnection every 3 seconds.\\+When this setting is enabled, the [[:software:start|Viewer]] running the GUI project will attempt to connect to the system on startup, and maintain the connection if any dropouts occur by attempting reconnection every 3 seconds.\\
 When this setting is disabled, the connection is only established when a Command or Macro needs to be sent, and is disconnected again a short time after the command/​macro has finished sending.\\ When this setting is disabled, the connection is only established when a Command or Macro needs to be sent, and is disconnected again a short time after the command/​macro has finished sending.\\
 We recommend always enabling this option unless you have a reason not to - it makes sending commands and macros much quicker, with less latency. We recommend always enabling this option unless you have a reason not to - it makes sending commands and macros much quicker, with less latency.
  
 ==== Heartbeat Properties ==== ==== Heartbeat Properties ====
-Some systems require a heartbeat message to be sent every so often to ensure the connection is kept alive. The '​Heartbeat Mode' dropdown menu works alongside the '​Heartbeat Rx' and '​Heartbeat Tx' properties.\\ +Some systems require a heartbeat message to be sent every so often to ensure the connection is kept alive. The ''​Heartbeat Mode'' dropdown menu works alongside the ''​Heartbeat Rx'' and ''​Heartbeat Tx'' properties.\\ 
-When reply mode is selected, the Viewer will reply to any '​Heartbeat Rx' messages with the '​Heartbeat Tx' message (if both are defined). \\ +When reply mode is selected, the Viewer will reply to any '​Heartbeat Rx' messages with the ''​Heartbeat Tx'' message (if both are defined). \\ 
-When initiate mode is selected, the Viewer will be responsible for managing the heartbeat, and will send the '​Heartbeat Tx' message every 3 seconds. If no '​Heartbeat Rx' message is detected within ​10 seconds, it will close the connection and attempt to reconnect.\\+When initiate mode is selected, the Viewer will be responsible for managing the heartbeat, and will send the ''​Heartbeat Tx'' message every 3 seconds.\\ 
 +If no ''​Heartbeat Rx''​ message is detected within 7 seconds, iViewer will show a popup message indicating the intermittent connect issue (only if debug mode is enabled in [[software:​gui-designer:​project-properties|Project Properties]])\\ 
 +If no ''​Heartbeat Rx'' message is detected within ​15 seconds, it will close the connection and attempt to reconnect.\\
 If no heartbeat mode is selected, no heartbeat management will take place (most common).\\ If no heartbeat mode is selected, no heartbeat management will take place (most common).\\
-Hex data must be entered in xFF format, see Entering Hex Data for more details.+Hex data must be entered in \xFF format, see [[software:​gui-designer:​hex-data|Entering Hex Data]] for more details.
  
 ==== EOM (End Of Message) ==== ==== EOM (End Of Message) ====
-Feedback parsing works best when an EOM string is defined for the system. Most systems end each message with a unique character (or string of characters). A common example is a carriage return (x0D).\\+Feedback parsing works best when an EOM string is defined for the system. Most systems end each message with a unique character (or string of characters). A common example is a carriage return (\x0D).\\
 By entering the EOM string used by the system, it allows the feedback from the system to correctly split up each message and parse each message through the feedback system (comparing against feedback Regular Expressions,​ etc).\\ By entering the EOM string used by the system, it allows the feedback from the system to correctly split up each message and parse each message through the feedback system (comparing against feedback Regular Expressions,​ etc).\\
 If no EOM string is used by the system, messages will be declared a single message when they arrive on the ethernet stack. If the system sends lots of messages quickly, this could result in multiple messages being concatenated or split in strange places, causing the feedback parsing system to not work as expected in some cases. So if possible, always enter the EOM string for your specific system.\\ If no EOM string is used by the system, messages will be declared a single message when they arrive on the ethernet stack. If the system sends lots of messages quickly, this could result in multiple messages being concatenated or split in strange places, causing the feedback parsing system to not work as expected in some cases. So if possible, always enter the EOM string for your specific system.\\
-**Note: The EOM string is NOT appended to outgoing commands for the system. It is only used for splitting up messages when feedback arrives.**\\ 
-Hex data must be entered in xFF format, see Entering Hex Data for more details. 
  
 +**Note: The EOM string is NOT appended to outgoing commands for the system. It is only used for splitting up messages when feedback arrives.**
 +
 +Hex data must be entered in \xFF format, see [[software:​gui-designer:​hex-data|Entering Hex Data]] for more details.
 ==== Connection Join ==== ==== Connection Join ====
 For systems using TCP/IP, the '​connection join' will be held high as long as the system is currently connected.\\ For systems using TCP/IP, the '​connection join' will be held high as long as the system is currently connected.\\
Line 73: Line 80:
 ==== Startup Macro ==== ==== Startup Macro ====
  
-Each system can specify a macro to be sent every time the system is successfully connected to. This allows you to perform a macro of commands upon startup.\\+Each system can specify a [[software:​gui-designer:​system-manager:​macros|macro]] to be sent every time the system is successfully connected to. This allows you to perform a macro of commands upon startup.\\
 If no startup macro is required, simply select '​None'​ from the drop down list. If no startup macro is required, simply select '​None'​ from the drop down list.
  
software/gui-designer/system-manager/system-properties.1346737208.txt.gz · Last modified: 2012/09/04 05:40 by jarrod