diff --git a/CAN Wireless Transceiver/README.md b/CAN Wireless Transceiver/README.md index 19fbdb665c50285b1d08f72aa3d3da59fe8e6beb..efed6d491db20295aa5f9ceb941c960866e9b9ad 100644 --- a/CAN Wireless Transceiver/README.md +++ b/CAN Wireless Transceiver/README.md @@ -12,11 +12,9 @@ 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 - if a period of _2ms_ of inactivity is seen on the network, the buffered frames are transfered to the Xbee S2C 802.15.4, provided the - CTS pin is not de-asserted (HIGH) by the Xbee inicated its internal buffer is full. +Monitors the attached CAN network and stores all frames sent over that CAN network. The frames are buffered within the 328p and if a period of _2ms_ of inactivity is seen on the network, the buffered frames are transfered to the Xbee S2C 802.15.4, provided the CTS pin is not de-asserted (HIGH) by the Xbee inicated its internal buffer is full. - The format used for transmissing CAN messages is the following: +The format used for transmissing CAN messages is the following: --------------------------------------------------- | | | | @@ -24,9 +22,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. - Currently, there is no receiving functionality built into the firmware, only transmitting. +Currently, there is no receiving functionality built into the firmware, only transmitting. ## Maintainers * Nathan - _nrs1g15@soton.ac.uk_ @@ -38,6 +36,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 Wireless Transceiver CHANGELOG](https://git.soton.ac.uk/SUFST/sufst-firmware/blob/master/CAN%20Wireless%20Transceiver/CHANGELOG.md) for further details on changes. * **v1.0** - Initial release. \ No newline at end of file