Description

Reports the status of requests made with the Socket Option Request - 0x41 frame.

Format

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

Offset Size Frame Field 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

0xC1

4

8-bit

Frame ID

A reference identifier used to match status responses.

5

8-bit

Socket ID

A unique socket ID to address the socket.

If the status field value is non-zero, this field is 0xFF.

6

8-bit

Option ID

Identifier of the parameter requested.

7

8-bit

Status

Status codes:

  • 0x00: Success

  • 0x01: Invalid parameters

  • 0x02: Failed to retrieve Option Value

  • 0x20: Bad Socket ID

8

variable

Option Data

Current effective value of the option.

This field is only present if the corresponding request was a query (empty value).

EOF

8-bit

Checksum

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