SecsConn

Object
- com.hume.SECS.SecsConn

All Implemented Interfaces:

DmhReceiveItf

Direct Known Subclasses:

SecsEquip, SecsHost
```
public abstract class SecsConn
extends Object
implements DmhReceiveItf
```
A base SECS connection class for Equipment or Host use.
In general we can trap and ignore Exceptions when communicating with the SECS server because we have installed a callback for receiving notification of Server errors using onServerError().

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TIMEOUT` "TIMEOUT" string constant which is used as a failure reply
`static int`	`TRACE_DEFAULT_BITS` default trace window initialization trace bits, value 0x440E
`static int`	`TRACE_READ_WRITE_IO` trace bit for low level read/write IO activity, 1
`static int`	`TRACE_RECV_HDR_HEX` trace bit for received header hex display, 0x0100
`static int`	`TRACE_RECV_HDR_INTERP` trace bit for received header interpretation, 0x0200
`static int`	`TRACE_RECV_MSG_HEXDUMP` trace bit for received message data hex display, 0x0800
`static int`	`TRACE_RECV_MSG_TSN` trace bit for received message as TSN text, 0x0004
`static int`	`TRACE_RECV_SF_DESC` trace bit for received message type description, 0x0400
`static int`	`TRACE_SEND_HDR_HEX` trace bit for sent header hex display, 0x1000
`static int`	`TRACE_SEND_HDR_INTERP` trace bit for sent header interpretation, 0x2000
`static int`	`TRACE_SEND_MSG_HEXDUMP` trace bit for sent message data hex display, 0x8000
`static int`	`TRACE_SEND_MSG_TSN` trace bit for sent message as TSN text, 0x0008
`static int`	`TRACE_SEND_SF_DESC` trace bit for sent message type description, 0x4000
`static int`	`TRACE_STATE_LOGIC` trace bit for state changes including connection attempts, 2

Constructor Summary

Constructors
Constructor and Description
`SecsConn(String name, String DmhGroup, boolean isEquip)` Initialize the SECS connection including the start of a child SECS Server process.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`binToInt(String binValue)` convert a SECS binary value formatted as hex 0xnn or base 10 to int
`abstract void`	`commDisable()` disable SECS communication
`abstract RcResult`	`commEnable()` enable SECS communication
`RcResult`	`connectTypeHsmsActive(String hostOrIpAddress, int port)` set the connection type to HSMS active
`RcResult`	`connectTypeHsmsPassive(int port)` set the connection type to HSMS passive
`RcResult`	`connectTypeSerial(String comDevice, int baudrate)` host only - set the connection type to a serial port
`abstract RcResult`	`connectTypeSet()` Apply current connection type data set as properties.
`RcResult`	`connectTypeTerminalServer(String host_or_ip, int port)` host only, set the connection type to a Terminal Server/IP connection
`static void`	`debugDmhStatus(boolean show)` show or hide the SECS Server DMH message system status window
`static void`	`debugInspect()` exec the Datahub SDK inspect debugger to debug the SECS Tcl server
`static void`	`debugTableWindow(boolean show)` show or hide the SECS server SQL table GUI
`static void`	`debugTclConsole(boolean show)` show or hide the SECS server Tcl command console
`void`	`debugTraceWindow(boolean show)` Show or hide the SECS server SECS trace window for this connection.
`void`	`dmhReceive(DmhClientItf dmh, String Data, String Dest, String ReplyMailbox)` This is a callback for this code to receive messages from the SECS server.
`int`	`getBAUD()` property value BAUD, default 9600
`static String`	`getBinDir()` directory where DMH executables are - a read-only value
`String`	`getCommState()` CommState value Possible literal text values are DISABLED, ENABLED {NOT COMMUNICATING}, COMMUNICATING
`int`	`getConnectionType()` property value ConnectionType See getConnectionType for details.
`String`	`getControlState()` property value ControlState A read-only value of the actual GEM Control State, which reflects your ControlIntentOnline value, your ControlModeRemote value, and host dynamics.
`int`	`getDEVID()` property value DEVID, the SECS device ID, default 0
`static DmhClientItf`	`getDmh()` DMH connection to the SECS Server - read-only
`static String`	`getDmhGroupName()` DMH Group name - read-only
`String`	`getHsmsHost()` property value HSMS Connection Hostname or IP address.
`boolean`	`getHsmsPassive()` property value HsmsPassive - whether to act as a passive server instead of an active client
`int`	`getHsmsPort()` property value HsmsPort - the HSMS socket port, default value is 5555
`static String`	`getJavaServerDir()` directory where SecsServer[.exe] or SecsServer.tcl is found treat it as a read-only property
`String`	`getName()` A unique name for the SECS connection, used as an identifier for saved data, Set during construction.
`String`	`getProcessProgramDir()` The Process Program Directory - you can set a relative path such as "./pp".
`int`	`getRTY()` property value SECS-I retry maximum
`String`	`getSerialPort()` property value SECS-I SerialPort, default is COM1 on Windows
`String`	`getState()` The low-level connection state, OFFLINE, LISTENING, COMMUNICATING and more, The value is null until the interface instance has been constructed in the SECS server process.
`int`	`getT1()` property value, SECS-I T1 timer
`int`	`getT2()` property value, SECS-I Protocol timeout timer
`int`	`getT3()` property value, SECS Reply timeout timer
`int`	`getT4()` property value, SECS-I interblock timeout timer
`int`	`getT5()` property value, HSMS re-connection attempt timer
`int`	`getT6()` property value, HSMS control transaction timeout.
`int`	`getT7()` property value, HSMS not selected timeout.
`int`	`getT8()`
`int`	`getTraceBits()` get the TraceBits which control tracing of SECS communication
`int`	`getTraceLogMaxWidth()` the maximum width of a line in characters when saving SECS communication trace data to log files, 0 = no limit, or >= 1000
`String`	`getTraceSaveDir()` the file system directory for trace data save files
`int`	`getTraceSaveMaxDayFiles()`
`String`	`getTraceSaveZipCmd()` The compression command which is executed in the saving directory with the additional argument of the day file name which has just been closed at midnight.
`int`	`getTracewinMaxWidth()`
`boolean`	`isEquip()` host or equipment role
`boolean`	`isHsms()` whether the connection type is HSMS or a non-standard variant
`boolean`	`isHsmsPassive()`
`boolean`	`isPPbodyFileMode()` Return the configured state of whether S7F3 and S7F6 process program transfers are direct with files bypassing memory.
`boolean`	`isTraceDataCompressed()`
`boolean`	`isTraceDataSaved()`
`static boolean`	`isWindows()` are we running on Windows? read-only
`boolean`	`linktest()` Synchronously test a COMMUNICATING HSMS connection to verify that the link is responsive.
`void`	`linktestAsync()` Cause a linktest HSMS control message to be sent to test if a healthy connection still exists.
`static String`	`listElement(String s, int index)` Parse text structured as a list for the nth element.
`static String`	`listElement(String s, int i, int j)` Parse a nested list - the ith element is parsed as a list for the jth item.
`static String`	`listElement(String s, int i, int j, int k)` Parse a doubly nested list - the ith element is parsed as a list for the jth item, then the jth item is parsed for the kth element.
`static String`	`listJoin(String[] list)` A convenience method to convert a string array to a list.
`static String[]`	`listSplit(String s)` A listSplit method that returns an empty list instead of an exception if the input text is not a valid list.
`void`	`messageTypeAdd(int stream, int function, SecsMessageReceiveItf callback)` Specify a SECS message type to be received and handled by your application.
`void`	`messageTypeRemove(int stream, int function)` Cancel receiving of a message type, either of a built-in message type handled by the SECS server, or one that is being handled in the Java application.
`SecsTraceItf`	`onSecsTrace(SecsTraceItf handler)` register a callback for SECS message traffic diagnostic tracing
`static ServerErrorItf`	`onServerError(ServerErrorItf handler)` SECS Server and DMH connection error delivery.
`ValueChangeItf`	`onStateChange(ValueChangeItf handler)` register a callback for the state change event
`void`	`sendAbort(int stream, int primaryFunction)` Send a function 0 abort message in lieu of a proper reply.
`void`	`sendReply(int stream, int function, int transactionID)` send a SECS reply message - header only, no data.
`void`	`sendReply(int stream, int function, int transactionID, String tsnData)` Send a SECS reply message with data.
`void`	`sendS9(int function, String header)` Send a Stream 9 error message: F1 bad device ID, F3 bad stream, F5 bad function, F7 bad data, F9 T3 reply timeout, F11 too much data, F13 conversation timeout
`RcResult`	`sendSecsMsg(int stream, int function, boolean wantReply, String tsnData, boolean waitForReply)` Send a primary SECS message, optionally indicating a reply is wanted, and optionally waiting for the reply message.
`static int`	`serverLicenseCheck()` Return a status code for the license when using SecsServer[.exe].
`static RcResult`	`serverReply(String tclCommand)` Send a Tcl command to the Server and wait for the reply.
`static void`	`serverSqlCmd(String cmd)` Send an SQL command to the SECS Server for evaluation without waiting for a reply.
`static String`	`serverSqlReply(String cmd)` Execute an SQL command in the Server process and wait for the reply
`static void`	`serverStart(String GroupName)` startup the SECS Server if not already started
`static void`	`serverStop()` disconnect from and possibly terminate the SECS Server
`static void`	`serverTclCmd(String cmd)` Send a Tcl command to the Server process without waiting for the reply.
`static String`	`serverTclReply(String cmd)` Send a Tcl command to the Server and wait for the reply.
`void`	`setBAUD(int baudrate)` property value BAUD, default 9600 must issue connect type call to use a new value
`void`	`setConnectionType(int v)` We recommend you use connectTypeHsmsPassive() or connectTypeHsmsActive() instead of this method.
`void`	`setDEVID(int DEVID)` property value DEVID, the SECS device ID, default 0
`void`	`setHsmsHost(String hostnameOrIpAddr)` property value HSMS Connection Hostname or IP address
`void`	`setHsmsPassive(boolean passive)` property value HsmsPassive - whether to act as a passive server instead of an active client
`void`	`setHsmsPort(int p)` property value HsmsPort - the HSMS socket port, default value is 5555
`void`	`setPPbodyFileMode(boolean isFileMode)` Specify if S7F3 and S7F6 process program transfers are direct with files bypassing possibly large memory allocations.
`void`	`setProcessProgramDir(String path)` The Process Program Directory Also known as the RecipeDirectory - a relative pathname value is relative to the SECS Server working directory not the Java program working directory.
`void`	`setRTY(int v)` SECS-I retry maximum, default 3, range 1..31
`void`	`setSerialPort(String SerialPort)` SECS-I serial port, default is COM1 on Windows
`void`	`setT1(int v)` SECS-I inter-character timeout, default 500, range 100..10000
`void`	`setT2(int v)` T2, SECS-I Protocol timeout, default 10000, range 200..25000
`void`	`setT3(int v)` T3, SECS reply timeout, default 45000, range 1000..120000
`void`	`setT4(int v)` T4, SECS-I interblock timeout, default 45000, range 1000..120000
`void`	`setT5(int v)` T5, HSMS delay between re-connection attempts.
`void`	`setT6(int v)` T6, HSMS control transaction timeout.
`void`	`setT7(int v)` T7, HSMS not selected timeout.
`void`	`setT8(int v)` T8 is not used
`void`	`setTraceBits(int TRACE)` used as a bitfield to control tracing of SECS communication
`void`	`setTraceLogMaxWidth(int v)` The maximum width of a line in characters when saving trace data to log files.
`RcResult`	`setTraceSaving(boolean save, boolean compress, int maxDayFiles, String saveDir, String zipCmd)` Control over saving of trace data as day files.
`void`	`setTracewinMaxWidth(int v)` the maximum width in characters for the display of trace data
`void`	`tclCmd(String tclCommand)` Send Tcl code to the SECS server command mailbox for evaluation without waiting for a reply.
`RcResult`	`tclReply(String tclCommand)` Send Tcl code to the SECS server command mailbox and wait for the evaluation result.
`void`	`traceWin(boolean show)` Show or hide the native Java trace window with logging configuration allowed.
`void`	`traceWin(boolean show, boolean allowLogging)` Show or hide the native Java trace window which displays the SECS connection status and activity.
`void`	`traceWinDeleted()` the Tracewin notifies us when disposed (internal call)
`static boolean`	`tsnTypeIsOk(String valueTsn)` A quick but non-rigorous validation of the TSN type code for a variable.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TIMEOUT
```
public static final String TIMEOUT
```
    "TIMEOUT" string constant which is used as a failure reply
    
    See Also:
    Constant Field Values
  - TRACE_DEFAULT_BITS
```
public static int TRACE_DEFAULT_BITS
```
    default trace window initialization trace bits, value 0x440E
  - TRACE_READ_WRITE_IO
```
public static int TRACE_READ_WRITE_IO
```
    trace bit for low level read/write IO activity, 1
  - TRACE_RECV_HDR_HEX
```
public static int TRACE_RECV_HDR_HEX
```
    trace bit for received header hex display, 0x0100
  - TRACE_RECV_HDR_INTERP
```
public static int TRACE_RECV_HDR_INTERP
```
    trace bit for received header interpretation, 0x0200
  - TRACE_RECV_MSG_HEXDUMP
```
public static int TRACE_RECV_MSG_HEXDUMP
```
    trace bit for received message data hex display, 0x0800
  - TRACE_RECV_MSG_TSN
```
public static int TRACE_RECV_MSG_TSN
```
    trace bit for received message as TSN text, 0x0004
  - TRACE_RECV_SF_DESC
```
public static int TRACE_RECV_SF_DESC
```
    trace bit for received message type description, 0x0400
  - TRACE_SEND_HDR_HEX
```
public static int TRACE_SEND_HDR_HEX
```
    trace bit for sent header hex display, 0x1000
  - TRACE_SEND_HDR_INTERP
```
public static int TRACE_SEND_HDR_INTERP
```
    trace bit for sent header interpretation, 0x2000
  - TRACE_SEND_MSG_HEXDUMP
```
public static int TRACE_SEND_MSG_HEXDUMP
```
    trace bit for sent message data hex display, 0x8000
  - TRACE_SEND_MSG_TSN
```
public static int TRACE_SEND_MSG_TSN
```
    trace bit for sent message as TSN text, 0x0008
  - TRACE_SEND_SF_DESC
```
public static int TRACE_SEND_SF_DESC
```
    trace bit for sent message type description, 0x4000
  - TRACE_STATE_LOGIC
```
public static int TRACE_STATE_LOGIC
```
    trace bit for state changes including connection attempts, 2
- Constructor Detail
  - SecsConn
```
public SecsConn(String name,
        String DmhGroup,
        boolean isEquip)
         throws Exception
```
    Initialize the SECS connection including the start of a child SECS Server process.
    
    Parameters:
    name - the connection name
    DmhGroup - DMH message system groupname
    isEquip - equipment or host usage
    
    Throws:
    
    Exception - if the connection name is improper or initialization of the SECS server process fails.
- Method Detail
  - binToInt
```
public int binToInt(String binValue)
```
    convert a SECS binary value formatted as hex 0xnn or base 10 to int
    
    Parameters:
    binValue - string representation of a hexadecimal or decimal integer
    
    Returns:
    integer value
  - commDisable
```
public abstract void commDisable()
```
    disable SECS communication
  - commEnable
```
public abstract RcResult commEnable()
```
    enable SECS communication
    
    Returns:
    RcResult
  - connectTypeHsmsActive
```
public RcResult connectTypeHsmsActive(String hostOrIpAddress,
                             int port)
```
    set the connection type to HSMS active
    
    Parameters:
    hostOrIpAddress - hostname or IP address
    port - TCP/IP port value
    
    Returns:
    RcResult
  - connectTypeHsmsPassive
```
public RcResult connectTypeHsmsPassive(int port)
```
    set the connection type to HSMS passive
    
    Parameters:
    port - TCP/IP port
    
    Returns:
    RcResult
  - connectTypeSerial
```
public RcResult connectTypeSerial(String comDevice,
                         int baudrate)
```
    host only - set the connection type to a serial port
    
    Parameters:
    comDevice -
    baudrate -
    
    Returns:
    RcResult
  - connectTypeSet
```
public abstract RcResult connectTypeSet()
```
    Apply current connection type data set as properties. There are different host and equipment versions
    
    Returns:
    RcResult
  - connectTypeTerminalServer
```
public RcResult connectTypeTerminalServer(String host_or_ip,
                                 int port)
```
    host only, set the connection type to a Terminal Server/IP connection
    
    Parameters:
    host_or_ip - the hostname or IP address of the terminal server
    port - TCP/IP port
    
    Returns:
    RcResult
  - debugDmhStatus
```
public static void debugDmhStatus(boolean show)
```
    show or hide the SECS Server DMH message system status window
    
    Parameters:
    show - true to show
  - debugInspect
```
public static void debugInspect()
```
    exec the Datahub SDK inspect debugger to debug the SECS Tcl server
  - debugTableWindow
```
public static void debugTableWindow(boolean show)
```
    show or hide the SECS server SQL table GUI
    
    Parameters:
    show -
  - debugTclConsole
```
public static void debugTclConsole(boolean show)
```
    show or hide the SECS server Tcl command console
    
    Parameters:
    show -
  - debugTraceWindow
```
public void debugTraceWindow(boolean show)
```
    Show or hide the SECS server SECS trace window for this connection. This is the Tcl/Tk version, you probably want to use the traceWin() method to show the native Java version.
    
    Parameters:
    show -
  - dmhReceive
```
public void dmhReceive(DmhClientItf dmh,
              String Data,
              String Dest,
              String ReplyMailbox)
                throws Exception
```
    This is a callback for this code to receive messages from the SECS server.
    
    Specified by:
    
    dmhReceive in interface DmhReceiveItf
    
    Parameters:
    Data - message data
    Dest - destination mailbox
    ReplyMailbox - reply mailbox
    dmh - the DMH connection instance
    
    Throws:
    
    Exception
  - getBAUD
```
public int getBAUD()
```
    property value BAUD, default 9600
    
    Returns:
    the baud rate
  - getBinDir
```
public static String getBinDir()
```
    directory where DMH executables are - a read-only value
    
    Returns:
    the directory pathname
  - getCommState
```
public String getCommState()
```
    CommState value Possible literal text values are
    DISABLED, ENABLED {NOT COMMUNICATING}, COMMUNICATING
    
    Returns:
    string literal
  - getConnectionType
```
public int getConnectionType()
```
    property value ConnectionType
    See getConnectionType for details.
    
    Returns:
    0, 1, 1993, or 1995
  - getControlState
```
public String getControlState()
```
    property value ControlState
    A read-only value of the actual GEM Control State, which reflects your ControlIntentOnline value, your ControlModeRemote value, and host dynamics. Possible values are ON-LINE LOCAL, and ON-LINE REMOTE, OFF-LINE Equipment, OFF-LINE Host, and OFF-LINE SeekOnline.
    
    Returns:
    literal String value
  - getDEVID
```
public int getDEVID()
```
    property value DEVID, the SECS device ID, default 0
    
    Returns:
    device ID
  - getDmh
```
public static DmhClientItf getDmh()
```
    DMH connection to the SECS Server - read-only
    
    Returns:
    a reference to the DMHClient instance
  - getDmhGroupName
```
public static String getDmhGroupName()
```
    DMH Group name - read-only
    
    Returns:
    the DMH group name
  - getHsmsHost
```
public String getHsmsHost()
```
    property value HSMS Connection Hostname or IP address.
    For an active HSMS connection, the TCP/IP hostname or IP address of the HSMS passive server.
    defaults to "localhost".
    
    Returns:
    the hostname or IP address string
  - getHsmsPassive
```
public boolean getHsmsPassive()
```
    property value HsmsPassive - whether to act as a passive server instead of an active client
    
    Returns:
    true if passive server
  - getHsmsPort
```
public int getHsmsPort()
```
    property value HsmsPort - the HSMS socket port, default value is 5555
    
    Returns:
    port value
  - getJavaServerDir
```
public static String getJavaServerDir()
```
    directory where SecsServer[.exe] or SecsServer.tcl is found treat it as a read-only property
    
    Returns:
    the directory pathname
  - getName
```
public String getName()
```
    A unique name for the SECS connection, used as an identifier for saved data, Set during construction.
    
    Returns:
    the connection name
  - getProcessProgramDir
```
public String getProcessProgramDir()
```
    The Process Program Directory - you can set a relative path such as "./pp". When you read the value, we always return the absolute path so there is no misunderstanding of which directory is being used. Internally we work with your set value, and pass it to the server.
    
    Returns:
    the absolute pathname
  - getRTY
```
public int getRTY()
```
    property value SECS-I retry maximum
    
    Returns:
    SECS-I retry maximum
  - getSerialPort
```
public String getSerialPort()
```
    property value SECS-I SerialPort, default is COM1 on Windows
    
    Returns:
    the serial port name
  - getState
```
public String getState()
```
    The low-level connection state, OFFLINE, LISTENING, COMMUNICATING and more, The value is null until the interface instance has been constructed in the SECS server process. Until this occurs, there is nothing in the Server process to configure as changes are made to the Java instance.
    
    Returns:
    the low-level connection state
  - getT1
```
public int getT1()
```
    property value, SECS-I T1 timer
    
    Returns:
    milliseconds
  - getT2
```
public int getT2()
```
    property value, SECS-I Protocol timeout timer
    
    Returns:
    milliseconds
  - getT3
```
public int getT3()
```
    property value, SECS Reply timeout timer
    
    Returns:
    milliseconds
  - getT4
```
public int getT4()
```
    property value, SECS-I interblock timeout timer
    
    Returns:
    milliseconds
  - getT5
```
public int getT5()
```
    property value, HSMS re-connection attempt timer
    
    Returns:
    milliseconds
  - getT6
```
public int getT6()
```
    property value, HSMS control transaction timeout.
    
    Returns:
    milliseconds
  - getT7
```
public int getT7()
```
    property value, HSMS not selected timeout.
    
    Returns:
    milliseconds
  - getT8
```
public int getT8()
```
  - getTraceBits
```
public int getTraceBits()
```
    get the TraceBits which control tracing of SECS communication
    
    Returns:
    integer bitfield
  - getTraceLogMaxWidth
```
public int getTraceLogMaxWidth()
```
    the maximum width of a line in characters when saving SECS communication trace data to log files, 0 = no limit, or >= 1000
    
    Returns:
    max characters per log file line
  - getTraceSaveDir
```
public String getTraceSaveDir()
```
    the file system directory for trace data save files
    
    Returns:
    directory pathname
  - getTraceSaveMaxDayFiles
```
public int getTraceSaveMaxDayFiles()
```
    Returns:
    the maximum number of trace day files allowed
  - getTraceSaveZipCmd
```
public String getTraceSaveZipCmd()
```
    The compression command which is executed in the saving directory with the additional argument of the day file name which has just been closed at midnight. For example, "zip.exe -m tracetxt.zip".
    
    Returns:
    the compression command
  - getTracewinMaxWidth
```
public int getTracewinMaxWidth()
```
    Returns:
    the maximum width in characters for the display of trace data
  - isEquip
```
public boolean isEquip()
```
    host or equipment role
    
    Returns:
    true if equipment
  - isHsms
```
public boolean isHsms()
```
    whether the connection type is HSMS or a non-standard variant
    
    Returns:
    true for HSMS connection types
  - isHsmsPassive
```
public boolean isHsmsPassive()
```
  - isPPbodyFileMode
```
public boolean isPPbodyFileMode()
```
    Return the configured state of whether S7F3 and S7F6 process program transfers are direct with files bypassing memory.
    
    Returns:
    true for large file transfer mode
  - isTraceDataCompressed
```
public boolean isTraceDataCompressed()
```
    Returns:
    whether saved trace data day files are to be compressed
  - isTraceDataSaved
```
public boolean isTraceDataSaved()
```
    Returns:
    whether trace data is configured to be saved
  - isWindows
```
public static boolean isWindows()
```
    are we running on Windows? read-only
    
    Returns:
    true if windows
  - linktest
```
public boolean linktest()
```
    Synchronously test a COMMUNICATING HSMS connection to verify that the link is responsive. May take up to timeout period T6 to return. On failure, the HSMS socket connection is closed and the CommState will no longer be COMMUNICATING. Useful for equipment to force a broken connection to be discovered just before important event reports so that the report messages are spooled or so that the app is in sync with the actual communication state.
    
    Returns:
    true if the link is up, false if the link is down
  - linktestAsync
```
public void linktestAsync()
```
    Cause a linktest HSMS control message to be sent to test if a healthy connection still exists. Forces discovery of a bad connection after a T6 timeout. If the linktest fails, the HSMS socket connection is closed and the CommState is no longer COMMUNICATING. Useful for periodic polling if there is an issue with broken connections not being discovered soon enough.
  - listElement
```
public static String listElement(String s,
                 int index)
```
    Parse text structured as a list for the nth element. Returns an empty value instead of an exception for an invalid list.
    
    Parameters:
    s - text structured as a white space separated list
    index - 0 based subscript
    
    Returns:
    list element value or empty string
  - listElement
```
public static String listElement(String s,
                 int i,
                 int j)
```
    Parse a nested list - the ith element is parsed as a list for the jth item. Indexing starts from 0. Returns an empty value instead of an exception for an invalid list.
    
    Parameters:
    s - text structured as a white space separated list
    i - index into list
    j - index into ith element of list
    
    Returns:
    the sublist element
  - listElement
```
public static String listElement(String s,
                 int i,
                 int j,
                 int k)
```
    Parse a doubly nested list - the ith element is parsed as a list for the jth item, then the jth item is parsed for the kth element. Indexing starts from 0. Returns an empty value instead of an exception for an invalid list.
    
    Parameters:
    s - text structured as a white space separated list
    i - index into list
    j - index into ith element of list
    k - index into jth element
    
    Returns:
    the sublist element
  - listJoin
```
public static String listJoin(String[] list)
```
    A convenience method to convert a string array to a list.
    
    Parameters:
    list -
    
    Returns:
    text formatted as a list
  - listSplit
```
public static String[] listSplit(String s)
```
    A listSplit method that returns an empty list instead of an exception if the input text is not a valid list.
    
    Parameters:
    s - text structured as a white space separated list
    
    Returns:
    an array of list elements, empty array if invalid data
  - messageTypeAdd
```
public void messageTypeAdd(int stream,
                  int function,
                  SecsMessageReceiveItf callback)
                    throws Exception
```
    Specify a SECS message type to be received and handled by your application.
    You can provide for new SECS message types, or you can replace the built-in handling of particular messages. However, you should not replace the basic Stream 1 message that manage communication and the control state model unless you are prepared to rewrite most of the Hume application.
    Most message types can only be exchanged when an online control state has been established, so be mindful of the communication and control state before sending or expecting to receive messages.
    Use the sendReply method to send reply messages.
    An equipment instance also uses sendS9 and sendAbort methods to indicate errors or to abort message conversations.
    
    Parameters:
    stream - message type Stream identifier
    function - message type Function identifier
    callback - an object that implements the SECS message receiving interface
    
    Throws:
    
    Exception
  - messageTypeRemove
```
public void messageTypeRemove(int stream,
                     int function)
```
    Cancel receiving of a message type, either of a built-in message type handled by the SECS server, or one that is being handled in the Java application.
    You should not cancel receiving of the basic messages which manage the communication and control states.
    
    Parameters:
    stream -
    function -
  - onSecsTrace
```
public SecsTraceItf onSecsTrace(SecsTraceItf handler)
```
    register a callback for SECS message traffic diagnostic tracing
    
    Parameters:
    handler -
    
    Returns:
    previous hander value
  - onServerError
```
public static ServerErrorItf onServerError(ServerErrorItf handler)
```
    SECS Server and DMH connection error delivery.
    Register a callback for a trapped error in SECS server.
    The SecsConn class reports Tcl programming errors that are trapped in the SECS Server process as ServerError events. An example would be trying to send an improperly formatted SECS message.
    Another source of error messages are trapped Java exceptions that occur during DMH whenMsg receiving or the DMH connection to the SECS server being lost.
    Programming error events may happen during development but are not expected once your application is debugged.
    
    Parameters:
    handler -
    
    Returns:
    previous handler value
  - onStateChange
```
public ValueChangeItf onStateChange(ValueChangeItf handler)
```
    register a callback for the state change event
    
    Parameters:
    handler -
    
    Returns:
    previous handler value
  - sendAbort
```
public void sendAbort(int stream,
             int primaryFunction)
               throws Exception
```
    Send a function 0 abort message in lieu of a proper reply.
    
    Parameters:
    stream -
    primaryFunction -
    
    Throws:
    
    Exception
  - sendReply
```
public void sendReply(int stream,
             int function,
             int transactionID)
```
    send a SECS reply message - header only, no data.
    
    Parameters:
    stream - the received stream message type value
    function - the received function value plus one
    transactionID - passed to you by the receiving callback
  - sendReply
```
public void sendReply(int stream,
             int function,
             int transactionID,
             String tsnData)
```
    Send a SECS reply message with data.
    
    Parameters:
    stream - the received stream message type value
    function - the received function value plus one
    transactionID - passed to you by the receiving callback
    tsnData - TSN formatted message data
  - sendS9
```
public void sendS9(int function,
          String header)
```
    Send a Stream 9 error message:
    F1 bad device ID,
    F3 bad stream,
    F5 bad function,
    F7 bad data,
    F9 T3 reply timeout,
    F11 too much data,
    F13 conversation timeout
    
    Parameters:
    function - value, usually 7 for improper data
    header - the header value from the receiving callback
  - sendSecsMsg
```
public RcResult sendSecsMsg(int stream,
                   int function,
                   boolean wantReply,
                   String tsnData,
                   boolean waitForReply)
```
    Send a primary SECS message, optionally indicating a reply is wanted, and optionally waiting for the reply message.
    
    Parameters:
    stream -
    function -
    wantReply - whether to request a reply message
    tsnData - can be null or blank for header only messages
    waitForReply - whether to wait for a reply or TIMEOUT
    
    Returns:
    the return code and result string
  - serverLicenseCheck
```
public static int serverLicenseCheck()
```
    Return a status code for the license when using SecsServer[.exe].
    
    Returns:
    -1 no SecsServer program found, 0 ok license, 1 no licenses.txt file, 2 improper licenses.txt file data, 3 no code for the system in the file, 4 bad code for the system in the licenses.txt file.
  - serverReply
```
public static RcResult serverReply(String tclCommand)
```
    Send a Tcl command to the Server and wait for the reply. Use this send for creating a SECS interface or other Server level actions. Once you have set the ConnectType(), in most situations use TclReply( ) to send commands to a SECS interface in order to have proper ordering and re-entrancy protection.
    
    Parameters:
    tclCommand - Tcl code for remote execution
    
    Returns:
    a parsed return code and result string
  - serverSqlCmd
```
public static void serverSqlCmd(String cmd)
```
    Send an SQL command to the SECS Server for evaluation without waiting for a reply.
    
    Parameters:
    cmd - SQL statement
  - serverSqlReply
```
public static String serverSqlReply(String cmd)
```
    Execute an SQL command in the Server process and wait for the reply
    
    Parameters:
    cmd - SQL command string
    
    Returns:
    the reply message or the literal text TIMEOUT
  - serverStart
```
public static void serverStart(String GroupName)
                        throws Exception
```
    startup the SECS Server if not already started
    
    Parameters:
    GroupName - the DMH group name
    
    Throws:
    
    Exception
  - serverStop
```
public static void serverStop()
```
    disconnect from and possibly terminate the SECS Server
  - serverTclCmd
```
public static void serverTclCmd(String cmd)
```
    Send a Tcl command to the Server process without waiting for the reply. Use this send for creating a SECS interface or other Server level actions. Once you have set the ConnectType(), in most situations use TclCmd( ) to send commands to a SECS interface in order to have proper ordering and re-entrancy protection.
    
    Parameters:
    cmd - Tcl language command string
  - serverTclReply
```
public static String serverTclReply(String cmd)
```
    Send a Tcl command to the Server and wait for the reply. Use this send for creating a SECS interface or other Server level actions. Once you have set the ConnectType(), in most situations use TclReply( ) to send commands to a SECS interface in order to have proper ordering and re-entrancy protection.
    
    Parameters:
    cmd -
    
    Returns:
    Tcl evaluation result or TIMEOUT
  - setBAUD
```
public void setBAUD(int baudrate)
```
    property value BAUD, default 9600
    must issue connect type call to use a new value
    
    Parameters:
    baudrate -
  - setConnectionType
```
public void setConnectionType(int v)
                       throws Exception
```
    We recommend you use connectTypeHsmsPassive() or connectTypeHsmsActive() instead of this method.
    ConnectionType, default is 1995,
    0 = serial SECS-I
    1 == terminal server SECS-I
    1993 == non-standard draft HSMS
    1995 == standard HSMS
    
    Parameters:
    v -
    
    Throws:
    
    Exception
  - setDEVID
```
public void setDEVID(int DEVID)
              throws Exception
```
    property value DEVID, the SECS device ID, default 0
    
    Parameters:
    DEVID -
    
    Throws:
    
    Exception
  - setHsmsHost
```
public void setHsmsHost(String hostnameOrIpAddr)
```
    property value HSMS Connection Hostname or IP address
    
    Parameters:
    hostnameOrIpAddr -
  - setHsmsPassive
```
public void setHsmsPassive(boolean passive)
```
    property value HsmsPassive - whether to act as a passive server instead of an active client
    default is true for equipment
    
    Parameters:
    passive -
  - setHsmsPort
```
public void setHsmsPort(int p)
```
    property value HsmsPort - the HSMS socket port, default value is 5555
    
    Parameters:
    p - port value
  - setPPbodyFileMode
```
public void setPPbodyFileMode(boolean isFileMode)
```
    Specify if S7F3 and S7F6 process program transfers are direct with files bypassing possibly large memory allocations. Recommended if process program sizes are 1 meg or more.
    
    Parameters:
    isFileMode -
  - setProcessProgramDir
```
public void setProcessProgramDir(String path)
```
    The Process Program Directory Also known as the RecipeDirectory - a relative pathname value is relative to the SECS Server working directory not the Java program working directory. The host side has logic to turn "" into subdirectory spname + "_recipes". The equipment side initializes to "./recipes".
    
    Parameters:
    path - pathname value
  - setRTY
```
public void setRTY(int v)
            throws Exception
```
    SECS-I retry maximum, default 3, range 1..31
    
    Parameters:
    v -
    
    Throws:
    
    Exception
  - setSerialPort
```
public void setSerialPort(String SerialPort)
```
    SECS-I serial port, default is COM1 on Windows
    
    Parameters:
    SerialPort -
  - setT1
```
public void setT1(int v)
           throws Exception
```
    SECS-I inter-character timeout, default 500, range 100..10000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT2
```
public void setT2(int v)
           throws Exception
```
    T2, SECS-I Protocol timeout, default 10000, range 200..25000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT3
```
public void setT3(int v)
           throws Exception
```
    T3, SECS reply timeout, default 45000, range 1000..120000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT4
```
public void setT4(int v)
           throws Exception
```
    T4, SECS-I interblock timeout, default 45000, range 1000..120000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT5
```
public void setT5(int v)
           throws Exception
```
    T5, HSMS delay between re-connection attempts. default 10000, range 1000..240000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT6
```
public void setT6(int v)
           throws Exception
```
    T6, HSMS control transaction timeout. default 5000, range 1000..240000
    
    Parameters:
    v - milliseconds
    
    Throws:
    
    Exception
  - setT7
```
public void setT7(int v)
           throws Exception
```
    T7, HSMS not selected timeout. default 10000, range 1000..240000
    
    Parameters:
    v -
    
    Throws:
    
    Exception
  - setT8
```
public void setT8(int v)
```
    T8 is not used
    
    Parameters:
    v -
  - setTraceBits
```
public void setTraceBits(int TRACE)
```
    used as a bitfield to control tracing of SECS communication
    
    Parameters:
    TRACE -
  - setTraceLogMaxWidth
```
public void setTraceLogMaxWidth(int v)
                         throws Exception
```
    The maximum width of a line in characters when saving trace data to log files. Longer SECS message data is trimmed and an explanation tag is appended.
    
    Parameters:
    v -
    
    Throws:
    
    Exception
  - setTraceSaving
```
public RcResult setTraceSaving(boolean save,
                      boolean compress,
                      int maxDayFiles,
                      String saveDir,
                      String zipCmd)
```
    Control over saving of trace data as day files. We want the configuration of four parameters changed atomically.
    The toolset software has the configurable feature of continuously saving the SECS communication trace data to files - one file per day, up to a maximum number per year, and optionally compressing the closed file from the previous day shortly after midnight. The setTraceSaving method is used to reconfigure the logging feature with the various properties being set atomically in one call. The saving logic writes each day's output to a distinct file, in the directory named by the saveDir argument. The maxDayFiles argument controls how many day files are saved per year. It can be configured between 1 and 366. When file saving is initiated, the output filename is set to traceNNN.txt where the NNN value is the current day of the year, 0 to 365, modulo the maxDayFiles value. If this file already exists and has been written to earlier in the same day, then the output is appended to it, otherwise the file is created as a new file. Note that if the maxDayFiles value is set to 1, each day's output is saved to the same filename, trace000.txt. The default values provide for saving the data from each connection in a separate directory. Separate directories are required for each connection. When trace data is being written, the compress argument controls whether the logic attempts to compress the output file when it is closed at the end of the day (midnight). For compression to occur, the maxDayFiles value must be greater than 1 and a non-blank compression command must exist as the zipCmd argument. The default assignment of zipCmd is similar to zip -m tracetxt.zip. This command causes the data file from the previous day to be moved into the tracetxt.zip archive, creating the archive if it does not exist. The compression logic appends the day file name to the configured command before execution. Only trusted persons should be allowed to configure the compression command because of the security considerations. The RcResult return value of setTraceSaving() is used as follows. If the rc value is less than 0 the arguments were not acceptable and an error message is provided as the result String. If the rc value is 0, the call succeeded. If the rc value is greater than 0, the call succeeded with an advisory message as the result String. For example, a message occurs if compression is set true but there is a maximum of only 1 file, so there is no distinct file for the previous day to compress.
    
    Parameters:
    save - whether to persist trace data
    compress - whether to compress saved day files
    maxDayFiles - maximum number of day files
    saveDir - saving directory
    zipCmd - compression command
    
    Returns:
    return code, rc, in the RcResult is < 0 for error, 0 for ok, > 0 for ok with warning.
  - setTracewinMaxWidth
```
public void setTracewinMaxWidth(int v)
                         throws Exception
```
    the maximum width in characters for the display of trace data
    
    Parameters:
    v -
    
    Throws:
    
    Exception
  - tclCmd
```
public void tclCmd(String tclCommand)
```
    Send Tcl code to the SECS server command mailbox for evaluation without waiting for a reply.
    
    Parameters:
    tclCommand -
  - tclReply
```
public RcResult tclReply(String tclCommand)
```
    Send Tcl code to the SECS server command mailbox and wait for the evaluation result.
    
    Parameters:
    tclCommand -
    
    Returns:
    RcResult
  - traceWin
```
public void traceWin(boolean show)
```
    Show or hide the native Java trace window with logging configuration allowed.
    
    Parameters:
    show -
  - traceWin
```
public void traceWin(boolean show,
            boolean allowLogging)
```
    Show or hide the native Java trace window which displays the SECS connection status and activity. Being able to turn on continuous saving of trace data to files is a configurable privilege since it has performance and file system usage implications.
    
    Parameters:
    show -
    allowLogging -
  - traceWinDeleted
```
public void traceWinDeleted()
```
    the Tracewin notifies us when disposed (internal call)
  - tsnTypeIsOk
```
public static boolean tsnTypeIsOk(String valueTsn)
```
    A quick but non-rigorous validation of the TSN type code for a variable. We are not rigorously checking V8000 - VFFFF or the optional length.
    
    Parameters:
    valueTsn -
    
    Returns:
    true for valid type code

Class SecsConn

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

TIMEOUT

TRACE_DEFAULT_BITS

TRACE_READ_WRITE_IO

TRACE_RECV_HDR_HEX

TRACE_RECV_HDR_INTERP

TRACE_RECV_MSG_HEXDUMP

TRACE_RECV_MSG_TSN

TRACE_RECV_SF_DESC

TRACE_SEND_HDR_HEX

TRACE_SEND_HDR_INTERP

TRACE_SEND_MSG_HEXDUMP

TRACE_SEND_MSG_TSN

TRACE_SEND_SF_DESC

TRACE_STATE_LOGIC

Constructor Detail

SecsConn

Method Detail

binToInt

commDisable

commEnable

connectTypeHsmsActive

connectTypeHsmsPassive

connectTypeSerial

connectTypeSet

connectTypeTerminalServer

debugDmhStatus

debugInspect

debugTableWindow

debugTclConsole

debugTraceWindow

dmhReceive

getBAUD

getBinDir

getCommState

getConnectionType

getControlState

getDEVID

getDmh

getDmhGroupName

getHsmsHost

getHsmsPassive

getHsmsPort

getJavaServerDir

getName

getProcessProgramDir

getRTY

getSerialPort

getState

getT1

getT2

getT3

getT4

getT5

getT6

getT7

getT8

getTraceBits

getTraceLogMaxWidth

getTraceSaveDir

getTraceSaveMaxDayFiles

getTraceSaveZipCmd

getTracewinMaxWidth

isEquip

isHsms

isHsmsPassive

isPPbodyFileMode

isTraceDataCompressed

isTraceDataSaved

isWindows

linktest

linktestAsync

listElement

listElement

listElement