Protocol specifications

Configuration File

OPTOMUX uses a configuration file named OPTOMUX.INI. This file must reside in the default (working) folder, where the OPTOMUX.EXE is saved.

OPTOMUX.INI is a text file, that you may create and edit using Notepad. You may also access it via a menu shortcut on the OPTOMUX-IPS menu bar (under File).

OPTOMUX.INI is divided into sections. Each section starts with the name of the section between square brackets.

The following sections are defined at the moment:

[PORT]

[UNET]

[DRIVER]

[WATCHDOG]

Within each section, you define parameters using a 'key' followed by the "=" sign and followed by one or more alpha-numeric arguments.

Parameters within the section may be arranged in any order.

Multiple arguments must be separated by spaces, a dot, or a comma.

A comment line starts with "/".

The following keys are defined at the moment:

Section: [PORT]

Parameter

Description

Default value

COM

Sets the COM port used.
The COM may be any serial port or TCP or TCP or UDP.
TCP and UDP use port 504.

COM=COM1

BAUDS

Communication speed. Only applies to serial communications ports

SPEED=19200

PARITY

0=NONE, 1=ODD, 2=EVEN 3=MARK 4=SPACE. Only applies to serial communications ports

PARITY=0

STOP

Stop bits. 1 or 2. Only applies to serial communications ports

STOP=1

DATA

Data bits. 7 or 8. Only applies to serial communications ports

DATA=8

MODE

Accepts a string of the form baud=9600 parity=N data=8.

parity=E data=8 stops=1

SOCKET

TCP/UDP Port number

SOCKET=504

Section: [UNET]

NODE

The identifier for this IPS on the UDP (UNET) network.

NODE=1

RESET

The index of the register in the data table that will be used for remote reset. Writing to this register causes the IPS to re-read the configuration file.

None. No reset register.

SNAP

The index of the register in the data table that will be used for remote protocol capture. Writing 1 this register causes the IPS to produce a capture file. It is equivalent to clicking TRACE -> Capture.

None. No snapshot register.

Section: [DRIVER]

TIMEOUT

The time in milliseconds that this station will wait for a response before trying again.
. The default value is 250.

ENABLE

This parameter decides how the "ENABLE" registers operate for each cluster of points. If ENABLE=0, the cluster communicates as long as its ENABLE register is on. If ENABLE=1, the cluster triggers a communication when the ENABLE register is turned on and automatically turns the ENABLE register off when the communication is confirmed by the station
. The default value is 0.

REMOTE

Specifies the IP of a remote micro-server used to communicate with the OPTOMUX station when using TCP or UDP. Each remote is defined by 5 decimal numbers. The first number is the OPTOMUX address. The next 4 are the IP of the micro-server.

Micro-servers must be listening on port 504

You may include up to 64 "REMOTE" lines in the file.

DI Defines a cluster of binary inputs to be received from a remote OPTOMUX address. Each "DI" definition consists of 6 numbers.

You may include up to 64 "DI" definitions in the file.

FIRST, QTY, NODE, POS, ALERT, ENABLE

FIRST the index of the first register of the block at the requesting IPS.
QTY The number of binary inputs to transfer (maximum 16), starting at and including the first register.
NODE the OPTOMUX address of the station the data will be coming from.
POS the position of the first binary input at the station
ALERT the index of the register at the IPS, to be set in case a communication error or time-out occurs when this particular block is transferred

ENABLE

the index of the register at the IPS to trigger the transfer
When this register is set to 1, the transfer is initiated. If the ENABLE parameter is set to 1, once the transfer is confirmed by the station, this register is set to 0.
R0001 (index 0) may not be used as a ENABLE register. If ENABLE is 0, the cluster communicates continuously.

AI Defines a cluster of analog inputs to be received from a remote station. Each "AI" definition consists of 6 numbers. You may include up to 64 "AI" definitions in the file.

FIRST, QTY, NODE, POS, ALERT,ENABLE,PROBE

FIRST

the index of the first register of the block at the requesting IPS.

QTY

the number of analog inputs to transfer, starting at and including the first register. (maximum 16)

NODE

the OPTOMUX address of the station that the values will be coming from.

POS

the index of the first analog input at the station.

ALERT

the index of the register at the IPS to be set in case a communication error or time-out occurs when this particular block is transferred

ENABLE

the index of the register at the IPS to trigger the transfer
When this register is set to 1, the transfer is initiated. If the ENABLE parameter is set to 1, once the transfer is confirmed by the station, this register is set to 0.
R0001 (index 0) may not be used as a ENABLE register. If ENABLE is 0, the cluster communicates continuously.

.

PROBE

If 0, request the counts from the OPTOMUX board and use them as raw values.
If >0, request the EXTENDED TEMPERATURE READINGS for the probe type corresponding to the value of PROBE. The value of PROBE must match the analog input module type you use:

1ICDT
2 10 OHM RTD
3 100 OHM RTD
4 TYPE J THERMOCOUPLE
5 TYPE K THERMOCOUPLE
6 TYPE R THERMOCOUPLE
7 TYPE S THERMOCOUPLE
8 TYPE T THERMOCOUPLE
9 TYPE E THERMOCOUPLE

DO

Defines a cluster of binary outputs to be sent to a remote station. Each "DO" definition consists of 6 numbers. You may include up to 64 "DO" definitions in the file.

FIRST, QTY, NODE, POS, ALERT,ENABLE

FIRST

the index of the first register of the block at the originating IPS.

QTY

the number of digital outputs to transfer, starting at and including the first register. (Maximum 16)

NODE

the OPTOMUX address of the station the data will be sent to.

POS

the position of the first binary output at the station.

ALERT

the index of the register at the IPS to be set in case a communication error or time-out occurs when this particular block is transferred

ENABLE

the index of the register at the IPS to trigger the transfer
When this register is set to 1, the transfer is initiated. If the ENABLE parameter is set to 1, once the transfer is confirmed by the station, this register is set to 0.
R0001 (index 0) may not be used as a ENABLE register. If ENABLE is 0, the cluster communicates continuously.

.

AO

Defines a cluster of analog outputs to be sent to a remote station. Each "AO" definition consists of 6 numbers. You may include up to 64 "AO" definitions in the file.

FIRST, QTY, NODE, POS, ALERT, ENABLE

FIRST

the index of the first register of the block at the originating IPS.

QTY

the number of registers to transfer, starting at and including the first register. (Maximum 16).

NODE

the OPTOMUX address of the station that the values are sent to.

POS

the position of the first analog output at the station.

ALERT

the index of the register at the IPS to be set in case a communication error or time-out occurs when this particular block is transferred

ENABLE

the index of the register at the IPS to trigger the transfer
When this register is set to 1, the transfer is initiated. If the ENABLE parameter is set to 1, once the transfer is confirmed by the station, this register is set to 0.
R0001 (index 0) may not be used as a ENABLE register. If ENABLE is 0, the cluster communicates continuously.

.

Section: [WATCHDOG]

ACTIVE

Enable/Disable the watchdog. When enabled, all the outputs turn off after a delay when the IPS no longer receives commands from a RTES32.

ACTIVE=1

TIME

The delay in milliseconds after which the outputs turn off when the watchdog is enabled.

TIME=1000.