lmoskala/ESP32_Arduino_CAN
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

formatting, add todo item

Browse source
This commit is contained in:
Sam Perry 2022-12-13 20:07:06 -05:00
parent 0aa21c7df8
commit 579c15cc95
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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*