Command/response AEh, Ethernet configuration
The following table describes the structure of the report packet containing the application file. All data in the packet flows from the data collector to the receiver.
|
Byte |
Item |
Type |
Value |
Notes |
|---|---|---|---|---|
|
0 |
STX |
1 (Char) |
02h |
Start transmission. |
|
1 |
STATUS |
1 (Char) |
See Receiver status byte. |
Receiver status indicator. |
|
2 |
PACKET TYPE |
1 (Char) |
AEh |
Command/Response packet AEh. |
|
3 |
LENGTH |
1 (Char) |
Data byte count. |
|
|
4 |
SUBTYPE |
1 (Char) |
00h, 01h, 02h, 0Ch, 0Dh, 0Eh, 0Fh, 10h |
Subtypes can be: 00h: Get DHCP and IP Address |
|
|
CHECKSUM |
1 (Char) |
Checksum value. |
|
|
|
ETX |
1 (Char) |
03h |
End transmission. |
Subtypes
The subtypes are:
-
00h: command sent from the data collector to the receiver this will cause the receiver to respond with the type 01h subtype message.
-
01h: response from the receiver giving the DHCP and IP Address status of the unit. For the response packets, see Subtype 1: Response DHCP and IP Address.
-
02h: command sent from the data collector to the receiver setting the DHCP and IP Address status of the unit. For the structure of the command packet, see Subtype 2: Set DHCP and IP Address. It must include all fields even if DHCP is enabled (address fields can be set to 00h if DHCP is used).
-
0Ch: command sent from the data collector to the receiver this will cause the receiver to respond with the type 0Dh subtype message.
-
0Dh: response from the receiver giving the IP port summary of the unit. For the response packets, see Subtype 0Dh: Response IP Port Summary.
-
0Eh: command sent from the data collector to the receiver this will cause the receiver to respond with the type 0Fh subtype message. See Subtype 0Eh: Get Individual IP Port Configuration.
-
0Fh: response from the receiver giving the IP port configuration for a specific port of the unit. For the response packets, see Subtype 0Fh: Response Individual IP Port Configuration.
-
10h: command sent from the data collector to the receiver setting the IP port configuration for a specific port of the unit. For the structure of the command packet, see Subtype 10h: Set Individual IP Port Configuration.
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
DHCP ACTIVE |
1 (Char) |
00h–01h |
Set if DHCP is active, otherwise Static IP addresses are used. |
|
6–9 |
IP ADDRESS |
4 (Chars) |
00h–FFh |
Each byte gives one of the integers (0-255) in the dot-decimal notation of the IP v4 IP address assigned. |
|
10–13 |
NETMASK |
4 (Chars) |
00h–FFh |
|
|
14–17 |
BROADCAST ADDRESS |
4 (Chars) |
00h–FFh |
|
|
18–21 |
GATEWAY |
4 (Chars) |
00h–FFh |
|
|
22–25 |
DNS SERVER ADDRESS |
4 (Chars) |
00h–FFh |
|
|
---------- End of Subtype 1 ---------- |
||||
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
DHCP ACTIVE |
1 (Char) |
00h–01h |
Set if DHCP is active, otherwise Static IP addresses are used. |
|
6–9 |
IP ADDRESS |
4 (Chars) |
00h–FFh |
Each byte gives one of the integers (0-255) in the dot-decimal notation of the IP v4 IP address assigned when in a static IP mode (if DHCP is active, this is determined from the DHCP server and can be left as four 00h characters). |
|
10–13 |
NETMASK |
4 (Chars) |
00h–FFh |
|
|
14–17 |
BROADCAST ADDRESS |
4 (Chars) |
00h–FFh |
|
|
18–21 |
GATEWAY |
4 (Chars) |
00h–FFh |
|
|
22–25 |
DNS SERVER ADDRESS |
4 (Chars) |
00h–FFh |
|
|
---------- End of Subtype 2 ---------- |
||||
After the 02h subtype message is sent, the receivers will ACK or NAK this command.
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
FIRST VIRTUAL PORT |
1 (Char) |
00h–FFh |
The lowest numbered virtual receiver port allocated to the Ethernet interface (zero-based, see Port number values). |
|
6 |
LAST VIRTUAL PORT |
1 (Char) |
00h–FFh |
The highest numbered virtual receiver port allocated to the Ethernet interface (zero-based, see Port number values). |
|
7 |
NUMBER OF ACTIVE VIRTUAL PORTS |
1 (Char) |
00h–FFh |
The number of active virtual ports. This specifies the number of bytes to follow. |
|
?? |
ACTIVE VIRTUAL PORTS |
1 (Char) |
00h–FFh |
List of virtual port numbers set up as active IP ports. Each byte gives the virtual port ID for a single virtual port. |
|
---------- End of Subtype 0Dh ---------- |
||||
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
VIRTUAL PORT |
1 (Char) |
00h–FFh |
The numbered virtual receiver port whose configuration will be returned (zero-based, see Port number values). |
|
---------- End of Subtype 0Eh ---------- |
||||
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
VIRTUAL PORT |
1 (Char) |
00h–FFh |
The numbered virtual receiver port whose configuration has been returned (zero-based, see Port number values). |
|
6 |
ACTIVE |
1 (Char) |
00h–01h |
Set if the virtual port is active. |
|
7–8 |
IP PORT |
2 (Chars) |
0000h–FFFFh |
The IP port number for this virtual port. |
|
9 |
MODE |
1 (Char) |
00h–FFh |
0 (TCP) or 1 (UDP) |
|
10 |
UDP TIMEOUT |
1 (Char) |
00h–FFh |
UDP Timeout in seconds. |
|
11 |
OUTPUT ONLY |
1 (Char) |
00h–FFh |
If set, the port will operate in an output-only mode and allow multiple connections. |
|
12 |
RESERVED |
1 (Char) |
00h |
Reserved (set to zero). |
|
13 |
INITIATE CONNECTION |
1 (Char) |
00h–01h |
The port will operate in a client mode if set (in client mode, "OUTPUT ONLY" must be disabled). |
|
14–15 |
REMOTE IP PORT |
2 (Chars) |
0000h–FFFFh |
The IP port to connect to if initiating a connection in client mode. |
|
16–22 |
RESERVED |
7 (Chars) |
00h |
Reserved (set to zero). |
|
23 |
REMOTE IP ADDR LENGTH |
1 (Char) |
00h–FFh |
Number of bytes to follow in the REMOTE IP ADDRESS. |
|
24–?? |
REMOTE IP ADDRESS |
?? Chars |
00h–FFh |
The IP address to connect to if initiating a connection in client mode. Each byte is converted to its ASCII character value. |
|
---------- End of Subtype 0Fh ---------- |
||||
|
Byte |
Item |
Type |
Value |
Meaning |
|---|---|---|---|---|
|
5 |
VIRTUAL PORT |
1 (Char) |
00h–FFh |
The numbered virtual receiver port whose configuration has been returned (zero-based, see Port number values). |
|
6 |
ACTIVE |
1 (Char) |
00h–01h |
Set if the virtual port is active. |
|
7–8 |
IP PORT |
2 (Chars) |
0000h–FFFFh |
The IP port number for this virtual port. |
|
9 |
MODE |
1 (Char) |
00h–FFh |
0 (TCP) or 1 (UDP) |
|
10 |
UDP TIMEOUT |
1 (Char) |
00h–FFh |
UDP Timeout in seconds. |
|
11 |
OUTPUT ONLY |
1 (Char) |
00h–FFh |
If set, the port will operate in an output-only mode and allow multiple connections. |
|
12 |
RESERVED |
1 (Char) |
00h |
Reserved (set to zero). |
|
13 |
INITIATE CONNECTION |
1 (Char) |
00h–01h |
The port will operate in a client mode if set (in client mode, "OUTPUT ONLY" must be disabled). |
|
14–15 |
REMOTE IP PORT |
2 (Chars) |
0000h–FFFFh |
The IP port to connect to if initiating a connection in client mode. |
|
16–22 |
RESERVED |
7 (Chars) |
00h |
Reserved (set to zero). |
|
23 |
REMOTE IP ADDR LENGTH |
1 (Char) |
00h–FFh |
Number of bytes to follow in the REMOTE IP ADDRESS. |
|
24–?? |
REMOTE IP ADDRESS |
?? Chars |
00h–FFh |
The IP address to connect to if initiating a connection in client mode. Each byte is converted from its ASCII character value. |
|
---------- End of Subtype 10h ---------- |
||||
After the 10h subtype message is sent, the receivers will ACK or NAK this command.