Add note on embedded system

dalathegreat · Jun 30, 2024 · eb228f7 · eb228f7
1 parent 77b1ad2
commit eb228f7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
 ### Contributing to the Battery-Emulator project
 
+## Notes on embedded system
+The Battery-Emulator is a real-time control system, which performs lots of time critical operations. Some operations, like contactor control, need to complete within 10 milliseconds periodically. The resources of the ESP32 microcontroller is limited, so keeping track of CPU and memory usage is essential. Keep this in mind when coding for the system! Performance profiling the system can be done by enabling the FUNCTION_TIME_MEASUREMENT option in the USER_SETTINGS.h file
+
 ## Code formatting
 The project enforces a specific code formatting in the workflows. To get your code formatted properly, it is easiest to use a pre-commit hook before pushing the code to a pull request.