| Copyright | Copyright (C) 2015 Swift Navigation, Inc. |
|---|---|
| License | LGPL-3 |
| Maintainer | Mark Fine <dev@swiftnav.com> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
SwiftNav.SBP.FileIo
Description
Messages for using device's onboard flash filesystem functionality. This allows data to be stored persistently in the device's program flash with wear-levelling using a simple filesystem interface. The file system interface (CFS) defines an abstract API for reading directories and for reading and writing files. Note that some of these messages share the same message type ID for both the host request and the device response.
- msgFileioReadReq :: Word16
- data MsgFileioReadReq = MsgFileioReadReq {}
- msgFileioReadReq_sequence :: Lens' MsgFileioReadReq Word32
- msgFileioReadReq_offset :: Lens' MsgFileioReadReq Word32
- msgFileioReadReq_filename :: Lens' MsgFileioReadReq ByteString
- msgFileioReadReq_chunk_size :: Lens' MsgFileioReadReq Word8
- msgFileioReadResp :: Word16
- data MsgFileioReadResp = MsgFileioReadResp {}
- msgFileioReadResp_sequence :: Lens' MsgFileioReadResp Word32
- msgFileioReadResp_contents :: Lens' MsgFileioReadResp [Word8]
- msgFileioReadDirReq :: Word16
- data MsgFileioReadDirReq = MsgFileioReadDirReq {}
- msgFileioReadDirReq_sequence :: Lens' MsgFileioReadDirReq Word32
- msgFileioReadDirReq_offset :: Lens' MsgFileioReadDirReq Word32
- msgFileioReadDirReq_dirname :: Lens' MsgFileioReadDirReq ByteString
- msgFileioReadDirResp :: Word16
- data MsgFileioReadDirResp = MsgFileioReadDirResp {}
- msgFileioReadDirResp_sequence :: Lens' MsgFileioReadDirResp Word32
- msgFileioReadDirResp_contents :: Lens' MsgFileioReadDirResp [Word8]
- msgFileioRemove :: Word16
- data MsgFileioRemove = MsgFileioRemove {}
- msgFileioRemove_filename :: Iso' MsgFileioRemove ByteString
- msgFileioWriteReq :: Word16
- data MsgFileioWriteReq = MsgFileioWriteReq {}
- msgFileioWriteReq_sequence :: Lens' MsgFileioWriteReq Word32
- msgFileioWriteReq_offset :: Lens' MsgFileioWriteReq Word32
- msgFileioWriteReq_filename :: Lens' MsgFileioWriteReq ByteString
- msgFileioWriteReq_data :: Lens' MsgFileioWriteReq [Word8]
- msgFileioWriteResp :: Word16
- data MsgFileioWriteResp = MsgFileioWriteResp {}
- msgFileioWriteResp_sequence :: Iso' MsgFileioWriteResp Word32
Documentation
data MsgFileioReadReq Source
SBP class for message MSG_FILEIO_READ_REQ (0x00A8).
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.
Constructors
| MsgFileioReadReq | |
Fields
| |
data MsgFileioReadResp Source
SBP class for message MSG_FILEIO_READ_RESP (0x00A3).
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.
Constructors
| MsgFileioReadResp | |
Fields
| |
data MsgFileioReadDirReq Source
SBP class for message MSG_FILEIO_READ_DIR_REQ (0x00A9).
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.
Constructors
| MsgFileioReadDirReq | |
Fields
| |
data MsgFileioReadDirResp Source
SBP class for message MSG_FILEIO_READ_DIR_RESP (0x00AA).
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.
Constructors
| MsgFileioReadDirResp | |
Fields
| |
data MsgFileioRemove Source
SBP class for message MSG_FILEIO_REMOVE (0x00AC).
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.
Constructors
| MsgFileioRemove | |
Fields
| |
data MsgFileioWriteReq Source
SBP class for message MSG_FILEIO_WRITE_REQ (0x00AD).
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.
Constructors
| MsgFileioWriteReq | |
Fields
| |
data MsgFileioWriteResp Source
SBP class for message MSG_FILEIO_WRITE_RESP (0x00AB).
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.
Constructors
| MsgFileioWriteResp | |
Fields
| |