TCP/IP Protocol in Pivotware

Communication
The Infinity station connects to the TCP/IP Asset connects, and the TCP/IP Asset accepts the
connection. The TCP/IP Asset is the TCP server and the Infinity station is the TCP client.
The protocol used is TCP/IP.
Only 1 connection must be allowed by the TCP/IP Asset
The Infinity station uses the IP Address and the Port Number defined in the Asset Manager to
establish the communication with the TCP/IP Asset.

Messages structure
All information sent over the communication links is ASCII format.
A message consists of three parts; Data field, end character, and Message ID in the beginning that is
optional.
The Message Length, the Separator and the End Character are defined in the Asset Manager. It is the
same for all the messages.
The End Character is not included in the calculation of the Message Length.

Request Message
Example with Message ID

This following example shows a request message with the following elements:
- Message length: 20
- Separator: ;
- End Character: NUL
Spaces must be added to pad and reach the defined message length. The End Character is not
included in the calculation of the message length.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
NUL
1 0 0 0 ; D A T A 1 ; A

The message ID: “0000” can’t be used as it’s reserved for the alarm events.
Example without Message ID

The following example shows a request message with the same elements as the previous example
but without the message ID.

Spaces can be added to pad and reach the defined message length but in no case it can exceed this
value. The End Character is not included in the calculation of the message length.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
D A T A 1 ; D A T A 2 ; D A T A 3 ; NUL

3rd Parameter
1st Parameter

2nd Parameter

Message Reply
Example with Message ID

In the reply the Message ID must be the same as the one from the request.
The second element of the reply is the status which can be “1” for “Pass” and “0” for “Fail”.

This following example shows a reply message with the following elements:
- Message length: 20
- Separator: ;
- End Character: NUL
- Status: Pass
Spaces must be added to pad and reach the defined message length. The End Character is not
included in the calculation of the message length.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
NUL
1 0 0 0 ; 1 ; 1 2 3 5 6 ; L O W

As many result data can be added to the reply (as long as the message length doesn’t exceed the
maximum). Every result data will be stored individually in the traceability.
Example without Message ID

In the reply, each field is considered as a Data. There is no Message ID or Status.

This following example shows a reply message with the following elements:
- Message length: 20
- Separator: ;
- End Character: NUL
Spaces can be added to pad and reach the defined message length but in no case it can exceed this
value. The End Character is not included in the calculation of the message length.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
D A T A 1 ; D A T A 2 ; D A T A 3 ; NUL

As many result data can be added to the reply (as long as the message length doesn’t exceed the
maximum). Every result data will be stored individually in the traceability.

Keep Alive
In case the TCP/IP Asset needs a “keep alive”, it can be activated in the Asset Manager. The “Keep
Alive Message” must be defined.
The exchanged message is the “Keep Alive Message”. The message must be padded with space to
meet the Message Length.
In case the TCP/IP Asset doesn’t reply within X seconds, defined in the Asset Manager, the Infinity
station will stop the communication and try to re-establish a new communication every 5 seconds.
Example

This following example shows a keep alive message with the following elements:
- Message length: 20
- End Character: NUL
- Keep Alive Message: A1234
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
NUL
A 1 2 3 4
Alarm messages
It is possible to activate some Alarm Event. An Alarm Event will always have the Message ID “0000”.
The formatting of an Alarm Event will have to follow the following rule:
Description Comment Length
Message ID (Alarm Event) 0000 4 chars
Separator As defined in the TCP/IP Asset 1 char
Protocol version always 00 2 chars
Separator As defined in the TCP/IP Asset 1 char
Alarm ID Define by TCP/IP Asset, must be an ASCII representation 4 chars
of an integer between 0000 and 9999
Separator As defined in the TCP/IP Asset 1 char
Level 1: Info / 2: Warning / 3: Error 1 char
Separator As defined in the TCP/IP Asset 1 char
Display Time If equal to 0, must be acknowledge by an operator 2 chars
If greater than 0, display time in seconds Must be an
Integer
Separator As defined in the TCP/IP Asset 1 char
Alarm Message Message to display on screen <= Message
Length - 18

Example

This following example shows an Alarm Event message with the following elements:
- Message length: 31
- End Character: NUL
- Alarm ID: 1234
- Separator: “;”
- Level: Info
- Display Time : Until an operator acknowledge it
- Alarm Message: My message
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
0 0 0 0 ; 0 0 ; 1 2 3 4 ; 1 ; 0 0 ; M y m e s s a g e NUL
Example 2

This following example shows an Alarm Event message with the following elements:
- Message length: 31
- End Character: NUL
- Alarm ID: 4563
- Separator: “;”
- Level: Error
- Display Time: 30 seconds
- Alarm Message: Help

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
0 0 0 0 ; 0 0 ; 4 5 6 3 ; 3 ; 3 0 ; H e l p NUL