https://github.com/extrawest/ocpp-node-ts
Typescript package implementing the JSON version of the Open Charge Point Protocol (OCPP). Currently OCPP 2.0.1 is supported.
https://github.com/extrawest/ocpp-node-ts
Last synced: 9 months ago
JSON representation
Typescript package implementing the JSON version of the Open Charge Point Protocol (OCPP). Currently OCPP 2.0.1 is supported.
- Host: GitHub
- URL: https://github.com/extrawest/ocpp-node-ts
- Owner: extrawest
- License: mit
- Created: 2023-02-15T17:28:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-14T06:54:42.000Z (almost 3 years ago)
- Last Synced: 2025-08-08T16:29:00.089Z (10 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@extrawest/node-ts-ocpp
- Size: 1.34 MB
- Stars: 18
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ev-charging - extrawest/ocpp-node-ts
README
[](https://github.com/extrawest/ocpp-node-ts)
[](https://github.com/extrawest/ocpp-node-ts/tags/)
#### Test coverage
# Extrawest OCPP 2.0.1 package
Based on great package [sepych/ocpp-ts][sepych/ocpp-ts] for OCPP 1.6 version.
Typescript package implementing the JSON version of the Open Charge Point Protocol (OCPP). Currently OCPP 2.0.1 is
supported.
Open Charge Point Protocol (OCPP, ) is a communication protocol between multiple
charging stations ("charge points") and a single management software ("central system").
## Installation
```
npm i @extrawest/node-ts-ocpp
```
## Usage
### Central System
```ts
import {
OcppServer, OcppClientConnection, BootNotificationRequest, BootNotificationResponse,
} from 'ocpp-ts';
const centralSystemSimple = new OcppServer();
centralSystemSimple.listen(9220);
centralSystemSimple.on('connection', (client: OcppClientConnection) => {
console.log(`Client ${client.getCpId()} connected`);
client.on('close', (code: number, reason: Buffer) => {
console.log(`Client ${client.getCpId()} closed connection`, code, reason.toString());
});
client.on('BootNotification', (request: BootNotificationRequest, cb: (response: BootNotificationResponse) => void) => {
const response: BootNotificationResponse = {
status: 'Accepted',
currentTime: new Date().toISOString(),
interval: 60,
};
cb(response);
});
});
```
### Charging Point
```ts
import {
BootNotificationRequest,
BootNotificationResponse,
OcppClient, OcppError,
} from 'ocpp-ts';
const chargingPointSimple = new OcppClient('CP1111');
chargingPointSimple.on('error', (err: Error) => {
console.log(err.message);
});
chargingPointSimple.on('close', () => {
console.log('Connection closed');
});
chargingPointSimple.on('connect', async () => {
const boot: BootNotificationRequest = {
chargingStation: {
model: "someModel",
vendorName: "someVendor"
},
reason: "Unknown"
};
try {
const bootResp: BootNotificationResponse = await chargingPointSimple.callRequest('BootNotification', boot);
if (bootResp.status === 'Accepted') {
console.log('Bootnotification accepted');
}
} catch (e) {
if (e instanceof Error || e instanceof OcppError) {
console.error(e.message);
}
}
});
chargingPointSimple.connect('ws://localhost:9220/');
```
## Security
Add required certificates for Central System, note from OCPP protocol:
*As some Charge Point implementations are using embedded systems with limited computing
resources, we impose an additional restriction on the TLS configuration on the server side:*
* The TLS certificate SHALL be an RSA certificate with a size no greater than 2048 bytes
```ts
centralSystemSimple.on('authorization', (cbId: string, req: IncomingMessage, cb: (err?: Error) => void) => {
console.log('authorization', cbId, req.headers.authorization);
// validate authorization header
// cb(new Error('Unathorized')); // Deny
cb(); // Accept
});
centralSystemSimple.listen(9220, {
cert: fs.readFileSync('cert.pem'),
key: fs.readFileSync('key.pem'),
});
```
If the central system requires authorization, an authorization header can be placed as the second parameter.
```ts
chargingPointSimple.connect('wss://somecs.com/ocpp/', {
Authorization: getBasicAuth(),
});
```
---
Created by Extrawest Node.js Team
[Extrawest.com](https://www.extrawest.com), 2023
---
[sepych/ocpp-ts]: https://www.npmjs.com/package/ocpp-ts