Description

This frame type is emitted when a transmit request completes. The status field of this frame indicates whether the request succeeded or failed and the reason.

This frame is only emitted if the Frame ID in the request is non-zero.

Format

The following table provides the contents of the frame. For details on frame structure, see API Frames.

Offset Size Field Name Description

0

8-bit

Start Delimiter

Indicates the start of an API frame.

1

16-bit

Length

Number of bytes between the length and checksum.

3

8-bit

Frame Type

Transmit Status - 0X89.

4

8-bit

Frame ID

Identifies the data frame for the host to correlate with a prior request.

5

8-bit

Delivery status

Complete list of delivery statuses:

  • 0x00 = Success

  • 0x01 = (Invalid parameter) Sending to invalid port or socket

  • 0x31 = Internal error

  • 0x32 = Resource error - lack of free buffers, timers, etc.

  • 0x33 = Transmission attempted with no payload

  • 0x74 = Message too long

  • 0x76 = Socket closed unexpectedly

  • 0x7C = Invalid interface. See User Data Relay Input - 0x2D.

  • 0x7D = Interface not accepting frames. See User Data Relay Input - 0x2D.

  • 0x7E = A modem update is in progress. Try again after the update is complete.

  • 0x85 = Unknown error

EOF

8-bit

Checksum

0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).