diff options
Diffstat (limited to 'doc/BLEFS.md')
| -rw-r--r-- | doc/BLEFS.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/BLEFS.md b/doc/BLEFS.md index 519d84a9..5374fd87 100644 --- a/doc/BLEFS.md +++ b/doc/BLEFS.md @@ -1,4 +1,5 @@ # BLE FS + --- The BLE FS protocol in InfiniTime is mostly Adafruit's BLE file transfer protocol, as described in [adafruit/Adafruit_CircuitPython_BLE_File_Transfer](https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer). There are some deviations, such as the status codes. These will be described later in the document. @@ -13,7 +14,7 @@ There are two relevant UUIDs in this protocol: the version characteristic, and t UUID: `adaf0100-4669-6c65-5472-616e73666572` -The version characteristic returns the version of the protocol to which the sender adheres. It returns a single unsigned 32-bit integer. The latest version at the time of writing this is 4. +The version characteristic returns the version of the protocol to which the sender adheres. It returns a single unsigned 32-bit integer. The latest version at the time of writing this is 4. ### Transfer @@ -125,7 +126,7 @@ Paths returned by this command are relative to the path given in the request - Unsigned 16-bit integer encoding the length of the file path. - File path: UTF-8 encoded string that is _not_ null terminated. -The response to this packet will be as follows. Responses will be sent until the final entry, which will have entry number == total entries +The response to this packet will be as follows. Responses will be sent until the final entry, which will have entry number == total entries - Command (single byte): `0x51` - Status (signed 8-bit integer) @@ -133,9 +134,9 @@ The response to this packet will be as follows. Responses will be sent until the - Unsigned 32-bit integer encoding the entry number - Unsigned 32-bit integer encoding the total amount of entries - Flags: unsigned 32-bit integer - + Bit 0: Set when entry is a directory - + Bits 1-7: Reserved -- Unsigned 64-bit integer encoding the unix timestamp of the modification time with nanosecond resolution + - Bit 0: Set when entry is a directory + - Bits 1-7: Reserved +- Unsigned 64-bit integer encoding the unix timestamp of the modification time with nanosecond resolution - Unsigned 32-bit integer encoding the size of the file - Path: UTF-8 encoded string that is _not_ null terminated. @@ -164,4 +165,4 @@ This section describes the differences between Adafruit's spec and InfiniTime's The status codes returned by InfiniTime are a signed 8-bit integer, rather than an unsigned one as described in the spec. -InfiniTime uses LittleFS error codes rather than the ones described in the spec. Those codes can be found in [lfs.h](https://github.com/littlefs-project/littlefs/blob/master/lfs.h#L70).
\ No newline at end of file +InfiniTime uses LittleFS error codes rather than the ones described in the spec. Those codes can be found in [lfs.h](https://github.com/littlefs-project/littlefs/blob/master/lfs.h#L70). |