ultimate-nag52-fw/README.md

1.4 KiB

Firmware for Ultimate NAG52 (Open source 722.6 TCM with CANBUS support)

EARLY WIP. See the main repository for details about the project and the wiki

For context on this project, checkout my video playlist showing the TCM in action and progress on it!

DISCLAIMER

I am in no way responsible if your gearbox or car dies as a result of using this firmware! Although this firmware is being tested actively, there are loads of unknowns which may occur rarely during operation that are not tested yet.

IMPORTANT

If you have just built your board, or are updating to firmware after 30/11/22, please look at this guide! Your TCU will be bricked until you follow it!

NOTICE ABOUT COPIED CODE (For PRs or change requests)

This project contains code built from the ground up, or code based on black-box style reverse engineering of the behaviour of the standard EGS52 module. Submitions of code pull requests based on unethically sourced documentation or code will be immediatly deleted and closed.

Generating the code documentation

  1. Install doxygen
  2. Clone doxygen-awesome-css submodule with git submodule update --init --recursive
  3. Run doxygen
  4. View code documentation in the generated html folder