libsbp
v2.4.7
|
Data Structures | |
struct | msg_fileio_read_req_t |
struct | msg_fileio_read_resp_t |
struct | msg_fileio_read_dir_req_t |
struct | msg_fileio_read_dir_resp_t |
struct | msg_fileio_remove_t |
struct | msg_fileio_write_req_t |
struct | msg_fileio_write_resp_t |
Macros | |
#define | SBP_MSG_FILEIO_READ_REQ 0x00A8 |
Read file from the file system (host => device) More... | |
#define | SBP_MSG_FILEIO_READ_RESP 0x00A3 |
File read from the file system (host <= device) More... | |
#define | SBP_MSG_FILEIO_READ_DIR_REQ 0x00A9 |
List files in a directory (host => device) More... | |
#define | SBP_MSG_FILEIO_READ_DIR_RESP 0x00AA |
Files listed in a directory (host <= device) More... | |
#define | SBP_MSG_FILEIO_REMOVE 0x00AC |
Delete a file from the file system (host => device) More... | |
#define | SBP_MSG_FILEIO_WRITE_REQ 0x00AD |
Write to file (host => device) More... | |
#define | SBP_MSG_FILEIO_WRITE_RESP 0x00AB |
File written to (host <= device) More... | |
Note that some of these messages share the same message type ID for both the host request and the device response.
#define SBP_MSG_FILEIO_READ_DIR_REQ 0x00A9 |
List files in a directory (host => device)
The read directory message lists the files in a directory on the device's onboard flash file system. The offset parameter can be used to skip the first n elements of the file list. Returns a MSG_FILEIO_READ_DIR_RESP message containing the directory listings as a NULL delimited list. The listing is chunked over multiple SBP packets. The sequence number in the request will be returned in the response. If message is invalid, a followup MSG_PRINT message will print "Invalid fileio read message". A device will only respond to this message when it is received from sender ID 0x42.
#define SBP_MSG_FILEIO_READ_DIR_RESP 0x00AA |
Files listed in a directory (host <= device)
The read directory message lists the files in a directory on the device's onboard flash file system. Message contains the directory listings as a NULL delimited list. The listing is chunked over multiple SBP packets and the end of the list is identified by an entry containing just the character 0xFF. The sequence number in the response is preserved from the request.
#define SBP_MSG_FILEIO_READ_REQ 0x00A8 |
Read file from the file system (host => device)
The file read message reads a certain length (up to 255 bytes) from a given offset into a file, and returns the data in a MSG_FILEIO_READ_RESP message where the message length field indicates how many bytes were succesfully read.The sequence number in the request will be returned in the response. If the message is invalid, a followup MSG_PRINT message will print "Invalid fileio read message". A device will only respond to this message when it is received from sender ID 0x42.
#define SBP_MSG_FILEIO_READ_RESP 0x00A3 |
File read from the file system (host <= device)
The file read message reads a certain length (up to 255 bytes) from a given offset into a file, and returns the data in a message where the message length field indicates how many bytes were succesfully read. The sequence number in the response is preserved from the request.
#define SBP_MSG_FILEIO_REMOVE 0x00AC |
Delete a file from the file system (host => device)
The file remove message deletes a file from the file system. If the message is invalid, a followup MSG_PRINT message will print "Invalid fileio remove message". A device will only process this message when it is received from sender ID 0x42.
#define SBP_MSG_FILEIO_WRITE_REQ 0x00AD |
Write to file (host => device)
The file write message writes a certain length (up to 255 bytes) of data to a file at a given offset. Returns a copy of the original MSG_FILEIO_WRITE_RESP message to check integrity of the write. The sequence number in the request will be returned in the response. If message is invalid, a followup MSG_PRINT message will print "Invalid fileio write message". A device will only process this message when it is received from sender ID 0x42.
#define SBP_MSG_FILEIO_WRITE_RESP 0x00AB |
File written to (host <= device)
The file write message writes a certain length (up to 255 bytes) of data to a file at a given offset. The message is a copy of the original MSG_FILEIO_WRITE_REQ message to check integrity of the write. The sequence number in the response is preserved from the request.