Directory Read - 0X13; Get Path Id - 0X1C - Digi XBee 3 Cellular LTE-M User Manual

File system API frames
Request
Offset Size
5 8-bit
6 16-bit

Directory Read - 0x13

Description
Read entries from the directory.
Request
Offset Size
5 8-bit
6 16-bit
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.
If the Path ID field of a Request is 0x0000, the Response contains a newly-allocated Path ID
n
for use in later Requests.
If the Path ID field of a Request is non-zero (such as one returned in a previous Get Path ID
n
Response), the XBee module updates the path for that ID.
To release a Path ID when no longer needed (instead of waiting for a timeout), send a Request
n
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.
Allocated Path ID values expire after 2 minutes if not used. You can refresh that timeout by
n
sending a Get Path ID request with the Path ID and an empty or single period (".") Pathname.
The full, absolute path of the Path ID is included in the Response only if can fit. Any code used
n
to process the response needs to take that into account and handle an empty Full Pathname
field.
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
Frame Field
File System Command
Directory Handle
Frame Field
File System Command
Directory Handle
Local File System Request - 0x3B
Description
Directory Close - 0x12
Value returned in initial Directory Open Response.
Directory Open
Description
Directory Read - 0x13
Value returned from
previous Directory Open
Response or Directory
Read Response.
Request.
296