Update README.MD

first very limited readme to get a start
This commit is contained in:
Tobi177 2020-04-03 23:27:28 +02:00 committed by GitHub
parent 824bac51d5
commit 0a134626a5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,18 +1,27 @@
1. License
=========================
# License
- MIT License
- Use this project at your own risk
2. Description
=========================
# Description
This project embeds the Chargery BMS to a Vcitron Enegery Venus OS device to monitor the battery cells. Examples:
![Overview](https://raw.githubusercontent.com/Tobi177/venus-chargerybms/master/examples/overview.png)
![ChargeryBMS](https://raw.githubusercontent.com/Tobi177/venus-chargerybms/master/examples/chargerybms.png)
![ChargeryBMS Cells](https://raw.githubusercontent.com/Tobi177/venus-chargerybms/master/examples/chargerybmscells.png)
# Requirements
3. Requirements
=========================
- Chargery BMS
- Venus OS device
- FTDI Adapter FT232RL USB TTL Serial (IMPORTANT: Must be flashed with FT_PROG software to invert tx mode)
- ...
# Installation
- TBD
4. Installation
=========================
# Notes
- Only the Chargery BMS16T is currently supported. However the sources can very easily be changed to support BMS8T and BMS24T as well.
- No multiple languages
- No scripts to resetup the changes automatically on update of Venus OS