File Open - 0X01 - Digi XBee 3 Cellular LTE-M User Manual

File system API frames
Notes
Multiple commands take a 16-bit Path ID, which allows the use of relative pathnames (using
n
"/" 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
command for details on creation and use of temporary values in order to use relative
pathnames.
For the Directory Open
n
equivalent to using "." – both refer to the directory designated by the Path ID.
Request and
n
Command field (and excluding the Checksum field).
Success Response
n
operation), and is only listed for commands with additional fields after the Status byte.
See Local File System Response - 0xBB
n
Variable-length names are NOT null terminated. The frame length determines the length of the
n
field.

File Open - 0x01

Description
Open a file for reading and/or writing.
Requests must have at least READ or WRITE bit set in the Options field.
n
Use the SECURE bit (0x80) of the Options byte to upload a write-only file (one that cannot be
n
downloaded or viewed). This is useful for protecting MicroPython source code on the device.
The SECURE bit is only valid when also setting the WRITE bit and either creating a new file
n
(CREATE + EXCLUSIVE) or replacing an existing file (TRUNCATE).
Request
Offset Size
5 8-bit
6 16-bit
Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide
and Get Path ID
Success Response describe the frame contents starting with the File System
lists the fields following the Status byte when 0 (indicating a successful
Frame Field
File System Command
Path ID
Local File System Request - 0x3B
commands, using an empty Pathname field is
for non-zero (error) Status values in the Response.
Description
File Open - 0x01
See Get Path ID - 0x1C
Get Path ID - 0x1C
for a description.
290