Description

Access the XBee module’s file system.

The frame content varies based on the File System Command sent in the request. Payloads for each command and their respective responses are included.

For more information about the file system, see File system.

Format

The following table provides the contents of the frame. For more 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

0x3B

4

8-bit

Frame ID

Identifies the data frame for the host to correlate with a subsequent response. If set to 0, the device will not emit a response frame.

5

8-bit

File System Command

See File System Commands for valid values.

6-n

variable

Request Parameters

Variable content based on File System Commands.

EOF

8-bit

Checksum

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

File System Commands

Value Command

0x01

File Open - 0x01

0x02

File Close - 0x02

0x03

File Read - 0x03

0x04

File Write - 0x04

0x08

File Hash - 0x08

0x10

Directory Create - 0x10

0x11

Directory Open - 0x11

0x12

Directory Close - 0x12

0x13

Directory Read - 0x13

0x1C

Get Path ID - 0x1C

0x2F

Delete - 0x2F

0x40

Volume Info - 0x40

0x4F

Volume Format - 0x4F

Notes

  • Multiple commands take a 16-bit Path ID, which allows the use of relative pathnames (using "/" as the path separator and using ".." to refer to a parent directory) as command parameters. The default of 0x0000 refers to the root directory (/). See the Get Path ID - 0x1C command for details on creation and use of temporary values in order to use relative pathnames.

  • For the Directory Open - 0x11 and Get Path ID - 0x1C commands, using an empty Pathname field is equivalent to using "." – both refer to the directory designated by the Path ID.

  • Local File System Request - 0x3B and Local File System Response - 0xBB Response describe the frame contents starting with the File System Command field (and excluding the Checksum field).

  • Local File System Response - 0xBB lists the fields following the Status byte when 0 (indicating a successful operation), and is only listed for commands with additional fields after the Status byte.

  • See Local File System Response - 0xBB for non-zero (error) Status values in the Response.

  • Variable-length names are NOT null terminated. The frame length determines the length of the field.