Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davbauer/ocpp-manager
OCPP Manager is an open-source EV charging station management platform built with HonoJS and SvelteKit. It supports charging station monitoring, RFID card management, and transaction tracking with a simple web interface.
https://github.com/davbauer/ocpp-manager
authorization charging-stations docker ev-charging honojs management ocpp ocpp16j postgresql sveltekit
Last synced: 4 days ago
JSON representation
OCPP Manager is an open-source EV charging station management platform built with HonoJS and SvelteKit. It supports charging station monitoring, RFID card management, and transaction tracking with a simple web interface.
- Host: GitHub
- URL: https://github.com/davbauer/ocpp-manager
- Owner: davbauer
- License: other
- Created: 2024-12-14T19:57:51.000Z (20 days ago)
- Default Branch: main
- Last Pushed: 2024-12-30T22:21:36.000Z (4 days ago)
- Last Synced: 2024-12-30T23:18:04.372Z (4 days ago)
- Topics: authorization, charging-stations, docker, ev-charging, honojs, management, ocpp, ocpp16j, postgresql, sveltekit
- Language: TypeScript
- Homepage:
- Size: 3.54 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# davbauer/ocpp-manager
## Build Status
| Branch | Build Status |
| ------ | ---------------------------------------------------------------------------------------------------------------------------- |
| main |  |
## Preview
## Overview
> [!WARNING]
> This project is newly created and in its early stages of development. It may undergo significant changes, and there may still be unresolved issues or incomplete features.
> Use at your own risk and feel free to contribute or report any issues you encounter!
OCPP Manager is an application built with [HonoJS](https://hono.dev/) for the backend and [SvelteKit](https://svelte.dev/) for the frontend.
### Features:
- **Charging Station Management**: Add and monitor charging stations and their associated connectors.
- **RFID Card Setup**: Manage RFID cards, including setting up expiring authorizations to allow or restrict charging.
- **Transaction Records**: Track all transactions and estimate ongoing transaction details.
## Docker Compose Example
For a simpler setup, use the following `docker-compose.yml` configuration:
```yaml
services:
ocpp-manager:
container_name: ocpp-manager-server
image: ghcr.io/davbauer/ocpp-manager:latest
environment:
DATABASE_URL: postgres://root:password@postgres:5432/app
volumes:
- ./logs:/workspace/api/logs
ports:
- "3000:3000"
depends_on:
- postgres
restart: unless-stopped
postgres:
container_name: ocpp-manager-postgres
image: postgres:latest
environment:
POSTGRES_USER: root
POSTGRES_PASSWORD: password
POSTGRES_DB: app
volumes:
- ./postgres:/var/lib/postgresql/data
restart: unless-stopped
```
This will pull the latest image of the OCPP Manager from GitHub Container Registry and set up the required PostgreSQL database.
1. **Accessing the Server:** Once the services are running, the OCPP Manager server will be available shortly at `http://HOSTED_IP:3000`. You can replace `3000:3000` in the `docker-compose.yml` file with your desired port to change the exposed port.
2. **Startup Delay:** The PostgreSQL database may require a few seconds to initialize. Allow the webserver an additional ~10 seconds for the webserver to come online to accomodate for the database startup.
## Connecting Chargers and Using Authorization
### Steps to Connect Chargers from Vendors (e.g., go-e or ABL)
Navigate to the monitoring page and click on the tutorial button.
The OCPP endpoint will be displayed. The tutorial will mention a `shortcode`.
**What is a Shortcode?**
A `shortcode` is a unique identifier that can be a charging station's serial number or a newly created name. Make sure to append this `shortcode` to the OCPP endpoint.
Once set up, the charging station will start sending heartbeat requests to the OCPP Manager. Within a few minutes, the charger should appear in the interface.
Click `"Edit"` on the charger to accept it. After some minutes, the current state of the connectors and the charger itself should appear.
_Your charger is now connected!_
### How to Use Authorization
#### Anonymous Charging
Start charging. It will fail the first time, and a virtual RFID tag will appear in the RFID tag tab.
Assign this virtual tag to a charge authorization.
Once the authorization is added, you should be allowed to charge.
#### RFID Charging
Hold the RFID tag near the charging station. It should appear shortly in the interface, just like the anonymous tag.
Assign the tag to a charge authorization, and you're ready to go!
#### Transactions
While transactions are running, they will be estimated in real-time.
Once completed or aborted, the charger will update the transaction with the actual details.
## Development Setup
1. Rename `.env.example` files in both the `app` and `api` directories to `.env`.
2. Install dependencies and build the frontend:
```bash
cd app
yarn
yarn build
cd ../
```
3. Start the local development PostgreSQL database:
```bash
cd local
docker compose up
```
4. In a new terminal, apply database migrations and start the API:
```bash
cd api
yarn
yarn migrate:run
yarn dev
```
Now you're ready to start developing!