Add Readme

This commit is contained in:
Carsten Schmiemann 2022-04-06 00:37:39 +02:00
parent e418d3ab82
commit 8d40995708

61
README.MD Normal file
View file

@ -0,0 +1,61 @@
# OVMS3 Fork
I forked OVMS3 Original project to work on a vehicle integration for my Renault Zoe Phase 2.
Orignal project: https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3
## Firmware-Version
The fork is fixed at Version 3.3.002 with their provided modified ESP-IDF
## To-Do List
* Integrate PIDs for reading values like odometer, battery cell voltage and so on, via OBD connector (because of gateway read-only)
* Accessing CAN bus after gateway to get full access to controllers use all available CAN bus interfaces OVMS hardware has
* Get more useful PIDs with direct access of CAN busses
* Try to control things like wake-up, charge control
* Implement own control routines like stopping charge after certain soc, try to control Cabine heaters to heat while charging (use debug commands to enable them)
## Releases
Successful build will be uploaded to my own ovms-server at https://ovms.bit-cloud.de/firmware or under Releases tab so self host them
## Build
Clone my repository
```
git clone https://git.bit-cloud.de/carsten.schmiemann/OVMS3.git --recurse-submodules
```
Install provided ESP IoT Development Framework
```
cd OVMS.V3-idf/
./install.sh
```
Enable IDF
```
cd OVMS.V3-idf/
source export.sh
```
Go to OVMS Folder and build firmware
```
cd OVMS.V3/
make -jX
```
X = number of cpu cores to speed up build process
Then upload built firmware to your webserver and flash it via OTA function in OVMS webinterface
## Security concerns
The OVMS3 project use an outdated and modified IDF, there are many security problems with them. Major problem is missing firewall so your webinterface and services like SSH is open to public ip of 3G/LTE interface. Most providers use an CG-NAT, but this is no a reliable protection at all.
Many of used libraries are outdated too. For example mongoose webserver has a lot of security problems fixed with newer versions.
I cannot fix these issues because I am not an experienced C programmer, I will focus on my vehicle integration.
I hope original project maintainers will fix them in the future, I know it is not an easy task because there a lot of changes in the IDF and dependencies.