Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xBlaz3kx committed Nov 5, 2022
1 parent 08caba9 commit 160d3d2
Showing 1 changed file with 14 additions and 30 deletions.
44 changes: 14 additions & 30 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# ⚡ ChargePi-go

⚡ChargePi is an open-source Raspberry Pi 4 based ⚡Charging Point🔌 project, which supports multiple EVSEs and simple
connectors🔌. You can also add an RFID/NFC reader and a display to the Charging Point. It is configurable, simple to
make and uses off-the-shelf hardware.
ChargePi is an open-source Linux based OCPP-enabled ⚡Charging Point🔌 project. It is configurable, simple to make and
uses off-the-shelf hardware.

A connector🔌 consists of an indicator (🚥 RGB LED strip), a relay and a ⚡ power meter. The client is written in Go and
requires installation of a few C libraries.
It supports multiple connectors🔌, which consist of an indicator (🚥 RGB LED strip), a EV Charge Controller and a ⚡ power
meter. Optionally, the charge point supports an RFID/NFC reader and a display as an user interface.

ChargePi-go client can be deployed/run in multiple ways:

Expand All @@ -14,30 +13,10 @@ ChargePi-go client can be deployed/run in multiple ways:

## 🔌 Charge point specifications

| OCPP version | Core functionalities | Offline charging | Local authorization | Charging profiles |
|:-------------:|:--------------------:|:-------------------:|:-------------------:|:-----------------:|
| 1.6 JSON/WS | ✔️ | ✔️(partial) | ✔️ ||
| 2.0.1 JSON/WS | Will be implemented | Will be implemented | Will be implemented ||

### 🛠️ Configuration and settings

To configure the ChargePi client, check out the [configuration guide](/docs/client/configuration.md). Client comes with
default settings which require minimal configuration.

### 📑 Logging

Debugging and insight of the charge point made simple. ChargePi supports multiple logging outputs specifying the format
the [settings](/configs/settings.json) file.

Supported formats:

| Logging type | Supported |
|:-----------------------------------:|:---------:|
| [Graylog](https://www.graylog.org/) ||
| Syslog ||
| File ||

For details, check out the [logging](/docs/logging/logging.md) docs.
| OCPP version | Core functionalities | Reservations | LocalAuthList | SmartCharging | FirmwareUpdate |
|:-------------:|:--------------------:|:-------------------:|:-------------------:|:-------------:|:--------------:|
| 1.6 JSON/WS | ✔️ | ✔️(partial) | ✔️ |||
| 2.0.1 JSON/WS | Will be implemented | Will be implemented | Will be implemented || |

## ⚡ Quickstart

Expand All @@ -51,4 +30,9 @@ For details, check out the [logging](/docs/logging/logging.md) docs.

4. Run the client.

Details on how to run the client are described in the [client startup guide](docs/client/running-the-client.md).
Details on how to run the client are described in the [client startup guide](docs/client/running-the-client.md).

### 🛠️ Configuration and settings

To configure the ChargePi client, check out the [configuration guide](/docs/client/configuration.md). Client comes with
default settings which require minimal configuration.

0 comments on commit 160d3d2

Please sign in to comment.