From 579c15cc950e09d6ae925f8a71322adf36e2f436 Mon Sep 17 00:00:00 2001 From: Sam Perry <17242713+sdp8483@users.noreply.github.com> Date: Tue, 13 Dec 2022 20:07:06 -0500 Subject: [PATCH] formatting, add todo item --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 68a4360..c324f0e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Arduino Library for the ESP32 CAN Bus (ESP32-Arduino-CAN) ## V2.0 -This is a rewrite of the original library created by [miwagner](https://github.com/miwagner/ESP32-Arduino-CAN). The old version of this library used registry commands to configure the TWAI[^1] peripheral. Newer versions of the Espressif IDF have built in functions to configure the TWAI peripheral that are more reliable. V2.0 of this library incorporates these new IDF functions in the original function calls of the ESP32-Arduino-CAN library. +This is a rewrite of the original library created by [miwagner](https://github.com/miwagner/ESP32-Arduino-CAN). The old version of this library used registry commands to configure the TWAI[^1] peripheral and has not been updated in years. Newer versions of the Espressif IDF have built in functions to configure the TWAI peripheral that are more reliable. V2.0 of this library incorporates these new IDF functions in the original function calls of the ESP32-Arduino-CAN library. ## Features * Easily configure the ESP32 TWAI[^1] peripheral -* CAN Bus messages send and receive +* Send and receive CAN Bus messages * Various bus speeds * Standard (11bit) and extended (29bit) frames * ~~CAN Message Filter~~ @@ -20,6 +20,7 @@ https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/periph ## TODO - [ ] Advanced example with RTOS tasks +- [ ] Release to main branch, no push to miwagner version - [ ] Implement CAN Message Filter [^1]: TWAI is the name that Esperssif uses for the CAN peripheral. It stands for *two wire automotive interface* \ No newline at end of file