https://github.com/voltbras/ts-ocpp
:zap: OCPP (Open Charge Point Protocol) implemented in Typescript.
https://github.com/voltbras/ts-ocpp
chargepoint electric-vehicles functional-programming ocpp typescript
Last synced: 7 months ago
JSON representation
:zap: OCPP (Open Charge Point Protocol) implemented in Typescript.
- Host: GitHub
- URL: https://github.com/voltbras/ts-ocpp
- Owner: voltbras
- License: mit
- Created: 2020-10-13T00:50:34.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T19:29:46.000Z (about 1 year ago)
- Last Synced: 2024-11-02T03:03:41.654Z (12 months ago)
- Topics: chargepoint, electric-vehicles, functional-programming, ocpp, typescript
- Language: TypeScript
- Homepage: https://voltbras.github.io/ts-ocpp
- Size: 278 KB
- Stars: 43
- Watchers: 6
- Forks: 25
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ev-charging - voltbras/ts-ocpp
README
# ts-ocpp
:zap: OCPP (Open Charge Point Protocol) implemented in Typescript. Supports OCPP-JSON v1.6 and OCPP-SOAP v1.5.
## install
```bash
yarn add @voltbras/ts-ocpp
# OR
npm install @voltbras/ts-ocpp --save
```
## instruction
### central system
defining a central system that accepts OCPP requests:
```typescript
// port and request handler as arguments
const centralSystem = new CentralSystem(3000, (req, { chargePointId }) => {
switch (req.action) {
case 'Heartbeat':
// returns a successful response
// (we pass the action and ocpp version so typescript knows which fields are needed)
return {
action: req.action,
ocppVersion: req.ocppVersion,
currentTime: new Date().toISOString()
};
}
throw new Error('message not supported');
});
```
sending a request to the chargepoint "123":
```typescript
// Returns a Either(Error or Success) object(functional, will not throw on error)
const response = await centralSystem.sendRequest({ chargePointId: '123', ocppVersion: 'v1.6-json', action: 'GetConfiguration', payload: {} });
// it can be used in a functional way
response.map(({ configurationKey }) => configurationKey[0].key);
// or can be used in the standard JS way(will throw if there was an error)
const unsafeResponse = response.unsafeCoerce();
```
### chargepoint
defining a chargepoint that accepts OCPP requests:
```typescript
// port, request handler and central system URL as arguments
const chargepoint = new ChargePoint(3001, req => {
switch (action) {
case 'GetConfiguration':
// returns a successful response
// (we pass the action and ocpp version so typescript knows which fields are needed)
return {
action: req.action,
ocppVersion: req.ocppVersion,
configurationKey: [],
};
}
throw new Error('message not supported');
});
```
sending a request to the central system(see central system's section to understand the return type):
```typescript
const response = await chargepoint.sendRequest({ action: 'Heartbeat', ocppVersion: '1.6-json', payload: {} );
```
### troubleshooting
Set the environment variable `DEBUG` to `ts-ocpp:*` to enable troubleshooting.