AMiT Websocket communication protocol

Supported device types and versions
Communication line configuration
Communication station configuration
I/O tag configuration 
Literature
Changes and modifications
Document revisions

Supported device types and versions


The protocol supports communication with AMiT devices via Websockets. The communication does not require the installation of any additional drivers. The communication was tested and debugged on the ADiS4 (Gen2 E+) device with the AD4-CPS central unit.

Communication line configuration



Communication line parameters

Communication line - configuration dialog box - the Protocol parameter tab.
Parameters defined in the field have an effect on some optional protocol parameters. The following line protocol parameters can be defined:

Table 1

Full nameDescriptionUnits / sizeDefault value

User Name

Username used for communication. If not specified, the username/password will not be used for communication.
Note: AMiT devices do not require sending username and password if they have no users configured.

--

Password

Password used for communication.--

Protocol

The protocol used for communication. The following variants are available:

  • MessagePack - binary protocol (this is essentially binary encoded JSON).
  • JSON - standard text protocol.

AMiT devices have a limit of 16 KB for the size of received and sent Websocket messages, so both requests and responses must fit within this size. Therefore, the MessagePack variant is recommended, as it is also less CPU-intensive.

MessagePack

JSON

MessagePack

Wait Timeout

Response waiting time. In case of larger requests, or due to higher latencies (e.g., on a mobile network or when communicating over WAN/VPN), this value may need to be increased.ss:mss01:000

Communication station configuration



Communication station parameters

Communication station - configuration dialog box - tab Protocol parameter.
Parameters defined in the field influence some optional protocol parameters. The following station protocol parameters can be defined:

Table 2

Full nameMeaningUnit/ sizeDefault value

Batch Size

Batch size when reading, i.e. the number of I/O tags that are read at once. AMiT devices have a limit of 16 KB for the size of received and sent Websocket messages, so both requests and responses must fit within this size. In the case of larger objects (fields, text variables), it may be necessary to reduce the default value, or create multiple stations on the line - one for arrays (small Batch Size value), the other for simple variables (larger Batch Size).

1-1000256

I/O tag configuration


Possible I/O tag types: Ai, Ao, Ci, Co, Di, Do, TxtI, TxtO, TiA, ToA, TiR, ToR.

I/O tag address consists of:


Note: An I/O tag of type TiA/ToA is understood as the number of seconds since 1.1.1970 (Unix time), since AMiT does not have objects of type absolute time.


Literature


Changes and modifications


Document revisions



Communication protocols