ConnexLink User’s Manual
ConnexLink User’s Manual
ConnexLink User’s Manual
ConnexLink User’s Manual
7/11/2003
12
2.
2.
2.
2.
API Command Set
API Command Set
API Command Set
API Command Set
In API Mode, the Host and ConnexLink utilize a set of commands to program the EEPROM
parameters defined in Section 6, Configuring the AC5124C
Section 6, Configuring the AC5124C
Section 6, Configuring the AC5124C
Section 6, Configuring the AC5124C, as well as control and monitor
network communications. As mentioned in Section 4.3, Serial Interface Mode 03 – API
Section 4.3, Serial Interface Mode 03 – API
Section 4.3, Serial Interface Mode 03 – API
Section 4.3, Serial Interface Mode 03 – API, the
commands are grouped into two categories, System Commands and ConnexLink Commands.
Each group of commands are listed and defined in this section. It is important to note these
commands can only be used when a ConnexLink is operating in the API Mode, which is
accomplished by programming bits 0 and 1 of EEPROM address 4Ah to a value of 1. The
command format is defined as follows:
Command
Length
Data
Checksum
Command
Command
Command
Command (1 Byte) – Hex command as shown in Table 1 – System Command Set
Table 1 – System Command Set
Table 1 – System Command Set
Table 1 – System Command Set and
Table 2 – ConnexLink Command Set
Table 2 – ConnexLink Command Set
Table 2 – ConnexLink Command Set
Table 2 – ConnexLink Command Set.
Length
Length
Length
Length (2 Bytes) – This is the total size of the remaining data for this command. The
length field is in little endian format (i.e. low byte/high byte). This length does not include
the checksum.
Data
Data
Data
Data (N Bytes) – The actual data associated with the command or sub-command.
Checksum
Checksum
Checksum
Checksum (1 Byte) – The checksum is a byte-by-byte, bitwise “EXCLUSIVE OR” of the
Command, Length and Data block.
Here are some important facts to remember when operating in API Mode:
Here are some important facts to remember when operating in API Mode:
Here are some important facts to remember when operating in API Mode:
Here are some important facts to remember when operating in API Mode:
1)
All commands issued by the Host must receive an
Acknowledge
Acknowledge
Acknowledge
Acknowledge
command from the
ConnexLink to signal completion of the issued command. This serves as flow control for
the information going to the ConnexLink.
2)
When a command is issued by the ConnexLink to the Host, the Host must be ready to
accept the command and any data following the command. The ConnexLink will not get
an
Acknowledge
Acknowledge
Acknowledge
Acknowledge
command from the Host.
3)
Although the Host will receive an
Acknowledge
Acknowledge
Acknowledge
Acknowledge
command for every command sent to the
ConnexLink, the Host must be able to accept any command issued by the ConnexLink
prior to receiving the
Acknowledge
Acknowledge
Acknowledge
Acknowledge
command.