Skip to content

Commit 9d37df6

Browse files
csamselcsamsel
committed
rework README.md [ci skip]
1 parent ccd1c40 commit 9d37df6

1 file changed

Lines changed: 69 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 69 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,100 @@
11
![SteVe](src/main/resources/webapp/static/images/logo.png)
2-
=====
2+
33
[![Build Status](https://travis-ci.org/RWTH-i5-IDSG/steve.svg)](https://travis-ci.org/RWTH-i5-IDSG/steve)
44
[![Coverity Status](https://scan.coverity.com/projects/6601/badge.svg)](https://scan.coverity.com/projects/rwth-i5-idsg-steve)
55

6+
7+
# Introduction
8+
69
SteVe was developed at the RWTH Aachen University and means Steckdosenverwaltung, namely socket administration in German. The aim of SteVe is to support the deployment and popularity of electric mobility, so it is easy to install and to use. SteVe provides basic functions for the administration of charge points, user data, and RFID cards for user authentication and was tested successfully in operation.
710

811
SteVe is considered as an open platform to implement, test and evaluate novel ideas for electric mobility, like authentication protocols, reservation mechanisms for charge points, and business models for electric mobility. SteVe is distributed under [GPL](LICENSE.txt) and is free to use. If you are going to deploy SteVe we are happy to see the [logo](website/logo/managed-by-steve.pdf) on a charge point.
912

10-
Supported OCPP protocols
11-
-----
13+
### Charging Station Support
14+
15+
Electric Charging Stations supporting the following OCPP versions are supported:
1216

1317
* OCPP1.2S
1418
* OCPP1.5S
1519
* OCPP1.2J
1620
* OCPP1.5J
1721

18-
Requirements & Configuration
19-
-----
22+
We have successfully tested SteVe with Charging Stations manufractured by EBG and Mennekes.
23+
24+
### System Requirements
25+
26+
SteVe requires
27+
* JDK 8 (both Oracle JDK and OpenJDK are supported)
28+
* Maven
29+
* MySQL database (MariaDB works aswell)
30+
to build and run.
2031

21-
1. You need JDK 8, Maven and MySQL.
32+
SteVe is designed to run standalone, a java servlet container / web server (e.g. Apache Tomcat), is NOT required.
2233

23-
2. The charge points must be configured to communicate with following addresses. Depending on the OCPP version of the charge point, SteVe will automatically route messages to the version-specific implementation.
24-
- SOAP: `http://<your-server-ip>:<port>/steve/services/CentralSystemService`
25-
- WebSocket/JSON: `ws://<your-server-ip>:<port>/steve/websocket/CentralSystemService/<chargeBoxId>`
26-
27-
3. The following MySQL statements can be used as database initialization (adjust according to your setup):
34+
# Configuration and Installation
35+
36+
1. Database preparation:
37+
38+
The following MySQL statements can be used as database initialization (adjust according to your setup):
2839

2940
```
3041
CREATE DATABASE stevedb;
3142
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost' IDENTIFIED BY 'changeme';
3243
GRANT SELECT ON mysql.proc TO 'steve'@'localhost' IDENTIFIED BY 'changeme';
3344
```
3445
35-
4. Basic Configuration is defined in [main.properties](src/main/resources/config/prod/main.properties):
36-
- You _must_ change [database configuration](src/main/resources/config/prod/main.properties#L3-L7)
37-
- You _must_ change [the host](src/main/resources/config/prod/main.properties#L16) to the correct IP address of your server. Using `0.0.0.0` to bind to all Interfaces should work as well, but might have security implications
38-
- You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L11-L12)
39-
- You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L25-L28)
40-
41-
5. Log File Configuration is defined in [log4j2.xml](src/main/resources/config/prod/log4j2.xml):
42-
- You _can_ change the [log directory](src/main/resources/config/prod/log4j2.xml#L10).
43-
The default location is `$HOME/logs/steve.log`. A more suitable location might be `/var/log/steve/steve.log` (remember to set directory permissions accordingly)
44-
- You _can_ change the [log level](src/main/resources/config/prod/log4j2.xml#L32)
46+
2. Download and extract tarball:
4547
46-
How to use?
47-
-----
48+
You can download and extract the SteVe releases using the following commands (replace X.X.X with the desired version number):
49+
```
50+
wget https://github.com/RWTH-i5-IDSG/steve/archive/steve-X.X.X.tar.gz
51+
tar xzvf steve-X.X.X.tar.gz
52+
cd steve-X.X.X
53+
```
4854
49-
Compile and build an archive ready to run:
55+
3. Configure SteVe **before** building:
5056
51-
mvn package
52-
53-
Start the application (please do not run SteVe as root):
57+
The basic configuration is defined in [main.properties](src/main/resources/config/prod/main.properties):
58+
- You _must_ change [database configuration](src/main/resources/config/prod/main.properties#L3-L7)
59+
- You _must_ change [the host](src/main/resources/config/prod/main.properties#L16) to the correct IP address of your server. Using `0.0.0.0` to bind to all Interfaces should work as well, but might have security implications
60+
- You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L11-L12)
61+
- You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L25-L28)
62+
63+
For advanced configuration please see the [Configuration wiki](https://github.com/RWTH-i5-IDSG/steve/wiki/Configuration)
5464
55-
java -jar target/steve-*.jar
65+
4. Build SteVe:
5666
57-
Access the Web interface:
67+
To compile SteVe simply use Maven. A runnable `jar` file containing the application and configuration will be created in the subdirectory `steve/`.
5868
59-
http://<your-server-ip>:<port>/steve/manager
69+
```
70+
# mvn package
71+
```
72+
73+
5. Run SteVe:
74+
75+
To start the application run (please do not run SteVe as root):
76+
77+
```
78+
# java -jar target/steve-*.jar
79+
```
80+
81+
# First Steps
82+
83+
After SteVe is succefully started you can access the SteVe web interface using the configured credentials under:
84+
85+
http://<your-server-ip>:8080/steve/manager
86+
87+
### Add a charging point
88+
89+
The charge points must be configured to communicate with following addresses. Depending on the OCPP version of the charge point, SteVe will automatically route messages to the version-specific implementation.
90+
- SOAP: `http://<your-server-ip>:8080/steve/services/CentralSystemService`
91+
- WebSocket/JSON: `ws://<your-server-ip>:8080/steve/websocket/CentralSystemService/<chargeBoxId>`
92+
93+
To add a charging point to SteVe select *Data Management* >> *Charge Points* >> *Add*. Enter the ChargeBox ID configured in the Charging Station and confirm.
94+
95+
As soon as a Heartbeat is received you should see the Status of the Charging Station in the SteVe Dashboard.
96+
97+
*Have fun!*
6098
6199
Screenshots
62100
-----
@@ -74,3 +112,4 @@ Screenshots
74112
Are you having issues?
75113
-----
76114
See the [FAQ](https://github.com/RWTH-i5-IDSG/steve/wiki/FAQ)
115+

0 commit comments

Comments
 (0)