
File system API frames
Local File System Request - 0x3B
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
296
Request
Offset
Size
Frame Field
Description
5
8-bit
File System Command
Directory Close - 0x12
6
16-bit
Directory Handle
Value returned in initial
Directory Open Response
.
Directory Read - 0x13
Description
Read entries from the directory.
Request
Offset
Size
Frame Field
Description
5
8-bit
File System Command
Directory Read - 0x13
6
16-bit
Directory Handle
Value returned from
previous
or
Directory
Read Response
.
Success Response
A
Directory Read Request
sends a response identical to a
.
Get Path ID - 0x1C
Description
Many commands include a 16-bit field for the
Path ID
. If set to 0x0000, pathnames in the frame are
relative to the root directory of the filesystem (/). Use the
Get Path ID
request to generate a
Path ID
for any subdirectory of the file system to allow the use of shorter relative pathnames in later
requests.
n
If the
Path ID
field of a Request is 0x0000, the
Response
contains a newly-allocated
Path ID
for use in later
Requests
.
n
If the
Path ID
field of a
Request
is non-zero (such as one returned in a previous
Get Path ID
Response
), the XBee module updates the path for that ID.
n
To release a
Path ID
when no longer needed (instead of waiting for a timeout), send a
Request
with the
Path ID
and a single slash ("/") as the
Pathname
. Any
Get Path ID Request
that
resolves to the root directory will release the
Path ID
and return a 0x0000 ID.
n
Allocated
Path ID
values expire after 2 minutes if not used. You can refresh that timeout by
sending a
Get Path ID
request with the
Path ID
and an empty or single period (".")
Pathname
.
n
The full, absolute path of the
Path ID
is included in the Response only if can fit. Any code used
to process the response needs to take that into account and handle an empty
Full Pathname
field.