yetangitu/Battery-Emulator
1
0
Fork 0
mirror of https://github.com/dalathegreat/Battery-Emulator.git synced 2025-10-03 01:39:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Daniel Öster 2025-03-11 23:27:13 +02:00 • committed by GitHub
parent b6defac4f9
commit 49918a4572
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -1,5 +1,20 @@
### Contributing to the Battery-Emulator project
What can I do?
--------------
**"Help - I want to contribute something, but I don't know what?"**
You're in luck. There's various sources to contribute:
- Improve the [Wiki documentation](https://github.com/dalathegreat/Battery-Emulator/wiki)
- Especially battery/inverter specific pages need updating. Attach pictures of batteries, wiring diagrams, helpful info etc.
- Have a look at the [issue tracker](https://github.com/dalathegreat/Battery-Emulator/issues), especially issues with labels:
- [good first issue](https://github.com/dalathegreat/Battery-Emulator/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)!
- Use your favorite text editor to find `TODO` comments in the code
- Ask us!
- [Discussion page](https://github.com/dalathegreat/Battery-Emulator/discussions)
- [Discord server](https://www.patreon.com/dala)
## 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