IOEX User Guide
Home ] Up ]


Overview

Input / Output Executive manages inter-component communications, as well as communications with remote units. The various NTMC components may reside on one computer, or on several computers on a LAN or a WAN.

BTE recommends that IOEX parameters be edited by qualified engineers only.

In most cases parameter changes go into effect after NTMC is restarted.

More overview can be found here.

Commands:

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
Startup Started automatically by MCEX. N/A No
Shutdown Gets shut down by MCEX automatically. Manual command, if invoked,  is followed by a prompt which must be confirmed by selecting the OK button. The standard operating system user interface shortcut button (X) has been disabled to prevent accidental component shutdown. CCEX Exit No
View Events Starts MCEV and loads the appropriate event log file. View Event Log Yes
Help Displays help documentation. Help NTMC Yes - F1
About IOEX Displays currently running component version, and licensed user id. Help About IOEX Yes

 

Operator

Users must log on to every NTMC component before they can use it. Security commands are listed below.

 

Communications

The following commands deal with communications clients. These are client type communications channels.

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
New... Creates new client.
  1. Select Comm Client New.
  2. Select client type
  3. Enter new client id.
No
Edit... Edits an existing client.
  1. Select Comm Client Edit.
  2. Select client type.
  3. Select client id.
  4. Edit the client parameters.
  5. Press Save and Exit.
No
Delete... Deletes an existing client.
  1. Select Comm Client Delete.
  2. Select client type.
  3. Select client id.
  4. Confirm your intention.
No

 

The following commands deal with communications servers. These are server type communications channels.

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
New... Creates new server.
  1. Select Comm Server New.
  2. Select server type
  3. Enter new server id.
No
Edit... Edits an existing server.
  1. Select Comm Server Edit.
  2. Select server type.
  3. Select server id.
  4. Edit the server parameters.
  5. Press Save and Exit.
No
Delete... Deletes an existing server.
  1. Select Comm Server Delete.
  2. Select server type.
  3. Select server id.
  4. Confirm your intention.
No

 

Applications / Protocols

The following commands deal with application clients. These are client side application protocol managers layered above communications (physical layer) clients.

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
New... Creates new client.
  1. Select App Client New.
  2. Select application / protocol id
  3. Select communications client id
  4. Enter new manager id
No
Edit... Edits an existing client.
  1. Select App Client Edit.
  2. Select client id.
  3. Edit the client parameters.
  4. Press Save and Exit.
No
Delete... Deletes an existing client.
  1. Select App Client Delete.
  2. Select client id.
  3. Confirm your intention.
No

 

The following commands deal with application servers. These are server side application protocol managers layered above communications servers.

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
New... Creates new server.
  1. Select App Server New.
  2. Select application / protocol id
  3. Select communications server id
  4. Enter new manager id
No
Edit... Edits an existing server.
  1. Select App Server Edit.
  2. Select server id.
  3. Edit the server parameters.
  4. Press Save and Exit.
No
Delete... Deletes an existing server.
  1. Select App Server Delete.
  2. Select server id.
  3. Confirm your intention.
No

 

Placement of Clients and Servers On-line and Off-line

Commands below place application clients and servers on-line and off-line. When placed on-line, they are managed by IOEX in real time, and are made available to other NTMC components as communications channels.

COMMAND DESCRIPTION HOW TO EXECUTE BUTTON SHORTCUT
Add... Puts application client on-line.
  1. Select External Client Add.
  2. Select client id
No
Remove... Puts application client off-line.
  1. Select External Client Remove.
  2. Select client id
No
Add... Puts application server on-line.
  1. Select External Server Add.
  2. Select server id
No
Remove... Puts application server off-line.
  1. Select External Server Remove.
  2. Select server id
No

 

Configuration

Parameters common to all communications clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting client / server type, and finally the client / server itself.

PARAMETER DESCRIPTION
Channel Id Channel identifier, used for communications channel identification purposes.
Connect T.O. (ms) Connect time out, specified in milliseconds. If client is unable to connect to server in the given time, operation fails and the failure is logged in the event log file.
Wait T.O. (ms) Wait time out, specified in milliseconds. If client, once connected,  is unable to receive a reply from the server in the given time, operation fails and the failure is logged in the event log file.
Input FIFO Records Size of input 'First In First Out' buffer, in records. Used for buffering incoming message. Number should be increased for busy channels.
Input Record Width Input FIFO buffer width, in bytes. Determines maximum allowed incoming message length.
Output FIFO Records Size of output 'First In First Out' buffer, in records. Used for buffering outgoing message. Number should be increased for busy channels.
Output Record Width Output FIFO buffer width, in bytes. Determines maximum allowed outgoing message length.
Input Recording When Enabled all incoming messages get recorded in the Recording Input File. This parameter should be Disabled except during system debugging (see parameter below).
Recording Input File Incoming message recording file id (see above parameter).
Input File Records Capacity of Recording Input File, in records. File is a FIFO, oldest messages get overwritten when file is full.
Input File Record Width Incoming message recording file record width, in bytes. Determines maximum allowed incoming message length.
Output Recording When Enabled all outgoing messages get recorded in the Recording Output File. This parameter should be Disabled except during system debugging (see parameter below).
Recording Output File Outgoing message recording file id (see above parameter).
Output File Records Capacity of Recording Output File, in records. File is a FIFO, oldest messages get overwritten when file is full.
Output File Record Width Outgoing message recording file record width, in bytes. Determines maximum allowed outgoing message length.
Message Format Format in which input and output messages are recorded. When set to ASCII, messages are recorded as simple ASCII characters. When set to Binary, numeric value of each byte is recorded in hexadecimal notation.

 

Parameters common to named pipe communications clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting Named Pipe Client / Server, and finally the client / server itself.

PARAMETER DESCRIPTION
Pipe Name Named pipe identifier. Must be unique within the host computer.  Identifier must conform to standard named pipe naming conventions. 

 

Parameters common to Windows Sockets communications clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting Windows Sockets Client / Server, and finally the client / server itself.

PARAMETER DESCRIPTION
Windows Sockets Major Version Major version number of Windows Sockets library IOEX is to initialize and use for communications.
Windows Sockets Minor Version Minor version number of Windows Sockets library IOEX is to initialize and use for communications.
Port Number TCP/IP port number to be used for communications.
Server Address Windows Sockets clients only use this address to connect appropriate server.
Address Type Parameter specifies how above address is specified. Possible choices are NetBios Name (address must be server network name), URL (address must be server universal resource locator, such as http://www.btecentral.com), IPv4 Address (address must be server IP version 4 32 bit address, such as 123.456.789.001), and IPv6 Address (address must be server IP version 6 128 bit address).

 

Parameters common to serial communications clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting Serial Client / Server, and finally the client / server itself.

PARAMETER DESCRIPTION
Port Id Serial port identifier.  Must be of the form COMn, where n = 1, 2, 3, ... 
Baud Rate Specifies communications channel speed, in bits / second.
Data bits Number of data bits used in communications over this channel.
Stop Bits Number of stop bits used in communications over this channel.
Parity Parity (error checking) used in communications over this channel.

 

Parameters common to telephone line clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting Telephone Line Client / Server, and finally the client / server itself.

PARAMETER DESCRIPTION
Port Id Serial port identifier.  Must be of the form COMn, where n = 1, 2, 3, ... 
Modem Initialization String String sent to the modem on above port when NTMC is restarted.
Modem Connect String String sent to the modem when dialing the telephone number. The latter is appended to the Connect String when dialing the number.
Modem Disconnect String String sent to the modem when 'hanging up' the phone.
Baud Rate Specifies communications channel speed, in bits / second.
Data bits Number of data bits used in communications over this channel.
Stop Bits Number of stop bits used in communications over this channel.
Parity Parity (error checking) used in communications over this channel.

 

Parameters common to file communications clients / servers. Parameters can be reached by selecting Comm Client / Server Edit, then selecting File Client / Server, and finally the client / server itself.

PARAMETER DESCRIPTION
File Id Full path of the file used for data I/O.
File Open Mode Specifies how IOEX is to open above file. Possible choices are: Create New (Creates a new file. The function fails if the specified file already exists), 
Create Always (Creates a new file. If the file exists, the function overwrites the file and clears the existing attributes), Open Existing (Opens the file. The function fails if the file does not exist), Open Always (Opens the file, if it exists. If the file does not exist, the function creates the file as if parameter  were Create New), Truncate Existing (Opens the file. Once opened, the file is truncated so that its size is zero bytes. The calling process must open the file with at least generic write access. The function fails if the file does not exist).
Close File After Write Specifies that IOEX must close above file after data is written to the file.
Close File After Read Specifies that IOEX must close above file after data is read from the file.
Delete File After Read Specifies that IOEX must delete above file after data is read from the file.

 

Parameters common to all application clients. Parameters can be reached by selecting App Client Edit, then selecting the client.

PARAMETER DESCRIPTION
Channel Id Channel identifier, used for application channel identification purposes. This identifier shows up in RUEX remote unit Remote Client Id parameter choice list when selecting remote unit communications link.
Comm. Client File Id Specifies File id which identifies communications channel  used by this application client.
Application Id Specifies application type / communications protocol used over this channel.
Destination Address (or NONE) Parameter specifies addressing within a common communications channel. Example: telephone number.
Destination Port Number (or NONE) Parameter specifies port number within a common communications channel.
Connect On Init When Enabled, IOEX connects the client to the server at channel initialization time, i.e. when IOEX starts up. When Disabled, communications channel is initialized, however connection with the server is not attempted.
Disconnect on Idle (sec, 0 = disabled) Parameter specifies the number of seconds of channel inactivity before connection with the server is terminated. The value of 0 disables this function.
Disconnect on Read Failure When Enabled IOEX disconnects the channel on server query failure. The feature is turned off when this parameter is Disabled.
Channel Flushing Communications channel is flushed, and FIFOs reset periodically when this parameter is Enabled. This cleans up chatter on noisy lines. Caution: This parameter must be Disabled on all channels expecting unsolicited (quiescent) messages.

 

Parameters common to  DNP 3.0 application clients. Parameters can be reached by selecting App Client Edit, then selecting the client.

PARAMETER DESCRIPTION
Resident on Master Station Possible choices are Yes (this station is a DNP client), and  No (this station is a DNP server).
Station Address Specifies this station address in the DNP network.
Data Link Confirmations Possible choices are Enabled (data link layer confirmations are enabled), and Disabled (data link layer confirmations are disabled). 
Data Link Retries (on Error)) Parameter specifies number of times data link layer must retry communicating when errors occur.
Data Link Status Polling Period (ms, 0 = off) Specifies how often (in milliseconds) data link is to query the other station when the latter is reporting busy. The value of 0 disabled this function.
Data Link Delay Between Transmissions (ms) Specifies how many milliseconds are to transpire between outgoing messages. This parameter can be used to pace communications when dealing with slower devices, and when confirmations are turned off. 
Data Link Busy Station Timeout Period (ms) Specifies how long data link is to wait (polling for status) for a busy station to report ready. 
Data Link Forces DFC = 0 (User Link Available) Parameter should be set to No in normal circumstances. It can be set to Yes when debugging the system.
Application Layer Fragment Size Limit (bytes) Parameter specifies maximum size of application layer fragment the station is allowed to transmit.
Application Layer Retries (on Error) Parameter specifies number of times application layer must retry communicating when errors occur.
Application Layer Confirmations Possible choices are Enabled (application  layer confirmations are enabled), and Disabled (application layer confirmations are disabled). 
Application Layer Time Out Period Specifies how long application layer is to wait for a station to respond.

 

Parameters common to Telescada ARS application clients. Parameters can be reached by selecting App Client Edit, then selecting the client.

PARAMETER DESCRIPTION
Baud Rate Specifies communications channel speed, in bits / second. Parameter does not control the speed. The value is used by clients in calculations of internal timing parameters.
CCU Board Number CCU7C can have two boards. This parameter identifies the board used by this channel.
CCU Board Channel Number CCU7C boards can have two ports. This parameter identifies the port used by this channel.
Function Tone (Hz) Tone frequency used by CCU7C when controlling radio transmitters.

 

Parameters common to B&B Electronics Digital Relay I/O clients. A  client of this type, as implemented in IOEX, monitors two other IOEX application clients which share the same communications channel out of IOEX host computer, but separate into two physically distinct channels downstream. Switching between the two is done by monitoring communications traffic passing through the two channels, and switching a relay which physically connects one channel or the other channel with the host computer. This application client controls that relay by sending commands to the Digital Relay I/O module via its own comm. client channel.

Parameters can be reached by selecting App Client Edit, then selecting the client.

PARAMETER DESCRIPTION
Primary Monitored Client Id Id of the first application client being monitored as described above.
Secondary Monitored Client Id Id of the second application client being monitored as described above.
Set First Relay to State 0 Command Command string sent via this client's underlying comm. client when traffic is detected through primary monitored client. This operates primary relay connecting the host computer with the primary monitored client's communications channel.
Set First Relay to State 1 Command Command string sent via this client's underlying comm. client when traffic is detected through secondary monitored client. This operates primary relay connecting the host computer with the secondary monitored client's communications channel.
Get Relay States Command Command string sent via this client's underlying comm. client to obtain all I/O module relay states.
State Switch Delay (ms) Number of milliseconds communications traffic is delayed through either of the two monitored clients after relay state is changed.

 

Parameters common to all application servers. Parameters can be reached by selecting App Server Edit, then selecting the server.

PARAMETER DESCRIPTION
Channel Id Channel identifier, used for application channel identification purposes. When this server is to be paired with an application client, both client and server must have the same Id.
Comm. Client File Id Specifies File id which identifies communications channel  used by this application server. When this server is to be paired with an application client, both client and server must have the same Comm. Client File Id.
 

Parameters common to  DNP 3.0 application servers. Parameters can be reached by selecting App Server Edit, then selecting the server.

PARAMETER DESCRIPTION
Resident on Master Station Possible choices are Yes (this station is a DNP client), and  No (this station is a DNP server).
Station Address Specifies this station address in the DNP network.
Data Link Confirmations Possible choices are Enabled (data link layer confirmations are enabled), and Disabled (data link layer confirmations are disabled). 
Data Link Retries (on Error)) Parameter specifies number of times data link layer must retry communicating when errors occur.
Data Link Status Polling Period (ms, 0 = off) Specifies how often (in milliseconds) data link is to query the other station when the latter is reporting busy. The value of 0 disabled this function.
Data Link Delay Between Transmissions (ms) Specifies how many milliseconds are to transpire between outgoing messages. This parameter can be used to pace communications when dealing with slower devices, and when confirmations are turned off. 
Data Link Busy Station Timeout Period (ms) Specifies how long data link is to wait (polling for status) for a busy station to report ready. 
Data Link Forces DFC = 0 (User Link Available) Parameter should be set to No in normal circumstances. It can be set to Yes when debugging the system.
Application Layer Fragment Size Limit (bytes) Parameter specifies maximum size of application layer fragment the station is allowed to transmit.
Application Layer Retries (on Error) Parameter specifies number of times application layer must retry communicating when errors occur.
Application Layer Confirmations Possible choices are Enabled (application  layer confirmations are enabled), and Disabled (application layer confirmations are disabled). 
Application Layer Time Out Period Specifies how long application layer is to wait for a station to respond.

 

Parameters common to all NPPD servers. Parameters can be reached by selecting App Server Edit, then selecting the NPPD type server. These servers are used by the state of Nebraska NTMC users to receive load management waiver messages from Nebraska Public Power District.

PARAMETER DESCRIPTION
Waiver Message Execution NTMC accepts load management waiver messages from NPPD when this parameter is set to Enabled. Waiver messages are ignored when the parameter is set to Disabled.
Emergency Message Execution NTMC accepts emergency load management messages from NPPD when this parameter is set to Enabled. Emergency messages are ignored when the parameter is set to Disabled.
Group Designation Parameter value defined NPPD customer group designation. NPPD messages are ignored unless they contain matching group designation.
Zone Designation Parameter value defined NPPD customer zone designation. NPPD messages are ignored unless they contain matching zone designation.
District Designation Parameter value defined NPPD customer district designation. NPPD messages are ignored unless they contain matching district designation.
Modem Usage Parameter specifies if modem is used (Enabled) or not (Disabled) when checking for messages from NPPD.
Modem Answers on Ring # The value specifies how many rings the modem must receive in order to answer the call.
Modem Usage Specifies whether or not the server must manage a modem. When Enabled, the server sends out modem initialization string once per hour ensuring that modem is in Auto Answer mode.

 

 

        [ Contact Us]  [Terms of Service]  [Privacy Statement]  [Customer References]  [Top of Page]

This web site developed and managed by BTE Corporation.
Copyright 1998 - 2013, BTE Corporation, All Rights Reserved
Equal Employment Opportunity Statement