Differences

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

--- programmatic_host_connection_status [2020/05/12 17:54]
wikiadmin
+++ programmatic_host_connection_status [2021/04/13 20:32] (current)
wikiadmin
@@ Line 1: / Line 1: @@
-HostConnectionStatus
+====Programmatic TransSECS Host Connection Status====
 After building a GEM Host in TransSECS you can register to receive the current status of the connection:
@@ Line 12: / Line 12: @@
     });
 </code>
+/** include the wiki page "TransSECS_GEM_Host_Connection_States" here in its entirety*/
-The possible connection states are:
+{{page>TransSECS_GEM_Host_Connection_States&notitle&nouser&nodate&nofooter}}
-<code java>
+**JavaScript Example for MIStudio/TransSECS**
-  /** Possible connection states */
-  public static enum ConnectionStates {
-    ENABLE_ALL_EVENTS_FAILED(-80),
-    ENABLE_EVENTS_FAILED(-70),
-    LINK_REPORTS_FAILED(-60),
-    CREATE_REPORTS_FAILED(-50),
-    ENABLE_ALARMS_FAILED(-40),
-    ONLINE_FAILED(-30),
-    COMMUNICATION_FAILED(-20),
-    CONNECT_FAILED(-10),
-    DISCONNECTED(-1),
-    OPERATIONAL(0),  // connection complete and ready
-    CONNECTED(10);  // connection to tool.  Configuration starting
-</code>
-For normal operation, the status must be OPERATIONAL - 0 Any other state is an either an error (negative numbers) or transient (CONNECTED). The description of the states, with corrective action (if any) are:
-  *     CONNECTED: The host has successfully connected to the tool and is beginning configuration of the tool.
-  *     OPERATIONAL - This is the required status for normal operation
-  *     DISCONNECTED - Indicates that the host has been disconnected from the tool. You need take no action on this status. The host will automatically attempt to reconnect so ideally the next status should be CONNECTED
-  *     CONNECT_FAILED - The host has attempted to connect to the tool but the connection was not accepted. This typically means that the tool is not listening for a connection or there is a networking error. Check that the port definitions in the host and tool match and that you can "ping" the tool from from the host computer.
-  *     COMMUNICATION_FAILED - The host successfully made a connection to the tool but the tool did not respond to the S1F13 message sent by the host.
-  *     ONLINE_FAILED - the host has a successful connection to the tool, but the tool rejected a request to go online. The comment may provide more information. This is typically because the online/offline switch at the tool is set to offline. Corrective action is to switch the tool from offline to online
-  *     ENABLE_ALARMS_FAILED - This indicates that an attempt to enable alarms failed. If you receive this status the tool may still go to "OPERATIONAL" but you will not receive any alarm notifications (S5F1 messages). You should correct the error and restart the host.
-  *     CREATE_REPORTS_FAILED - The tool rejected the host request to create event reports. This is usually because one of the reports contains a VID that is not known to the tool. The host will not go to OPERATIONAL. You must correct the error and restart the host.
-  *     LINK_REPORTS_FAILED - The tool rejected the host request to link event reports. This is usually because one of the configured CEIDs is not known to the tool. The host will not go to OPERATIONAL. You must correct the error and restart the host.
-  *     ENABLE_EVENTS_FAILED - The tool rejected the host request to enable event reports. This is usually because one of the configured CEIDs is not known to the tool. The host will not go to OPERATIONAL. You must correct the error and restart the host.
-  *
----
-JavaScript Example for MIStudio/TransSECS
 Trigger this script at startup. This script pushes data to two BroadcastServers (StatusListenerCommand and StatusListenerValue) whenever there is a connection status change.