From 9c430d893bf7441345048d3f2eafd3bd5646f0c8 Mon Sep 17 00:00:00 2001 From: nrs1g15 <nrs1g15@soton.ac.uk> Date: Sat, 29 Jun 2019 23:35:58 +0100 Subject: [PATCH] Update README.md --- CAN SD Card Logger/README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/CAN SD Card Logger/README.md b/CAN SD Card Logger/README.md index 4a1a0c8..e46eeac 100644 --- a/CAN SD Card Logger/README.md +++ b/CAN SD Card Logger/README.md @@ -12,9 +12,8 @@ Please read the [master README.md](https://git.soton.ac.uk/SUFST/susft-firmware/ * **/README.md** - This file. ## Documentation - Monitors the attached CAN network and stores all frames sent over that CAN network. The frames are buffered within the 328p and - every _100ms_ the buffer is saved to the sd card in a binary format within the file _DATA.BIN_. - The format consists of the following: +Monitors the attached CAN network and stores all frames sent over that CAN network. The frames are buffered within the 328p and every _100ms_ the buffer is saved to the sd card in a binary format within the file _DATA.BIN_. +The format consists of the following: --------------------------------------------------- | | | | @@ -22,10 +21,9 @@ Please read the [master README.md](https://git.soton.ac.uk/SUFST/susft-firmware/ | (1-byte) | (1-byte) | (8-bytes) | --------------------------------------------------- - For example, the ECU CAN ID 0x2001 message of [1, 2, 3, 4, 5, 6, 7, 8] is saved as 0x20, 0x01, 1, 2, 3, 4, 5, 6, 7, 8. +For example, the ECU CAN ID 0x2001 message of [1, 2, 3, 4, 5, 6, 7, 8] is saved as 0x20, 0x01, 1, 2, 3, 4, 5, 6, 7, 8. - The saving in binary form allows for the fasted possible save speed. The _100ms_ delay between writes gives the sd card time - to internally save the written bytes. +The saving in binary form allows for the fasted possible save speed. The _100ms_ delay between writes gives the sd card time to internally save the written bytes. ## Maintainers * Nathan - _nrs1g15@soton.ac.uk_ @@ -37,6 +35,6 @@ Please read the [master README.md](https://git.soton.ac.uk/SUFST/susft-firmware/ * Adomas - TO ADD ## Version History - Please see the [CAN Wireless Transceiver CHANGELOG](https://git.soton.ac.uk/SUFST/susft-firmware/blob/master/CHANGELOG.md) for further details on changes. +Please see the [CAN SD Card Logger CHANGELOG](https://git.soton.ac.uk/SUFST/susft-firmware/blob/master/CAN%20SD%20Card%20Logger/CHANGELOG.md) for further details on changes. * **v1.0** - Initial release. \ No newline at end of file -- GitLab