node-ocpi
is an advanced Node.js library designed for implementing the Open Charge Point Interface (OCPI) protocol. Offering structured models and comprehensive validation for various OCPI entities, it serves as an essential toolkit for developers in the electric vehicle (EV) charging station domain.
- Extensive models for key OCPI entities including
Location
,EVSE
,Connector
,CDR
,Command
,Feedback
,Meter
,Reservation
,Tariff
,User
,Transaction
,Credentials
,ChargingProfilePeriod
,ChargingProfile
,ActiveChargingProfile
,ChargingProfileResponse
,ActiveChargingProfileResult
,ChargingProfileResult
,ClearProfileResult
,SetChargingProfile
,CommandResult
,CommandResponse
,DisplayText
,EnergyContract
,LocationReferences
,Token
,AuthorizationInfo
, andOCPIResponse
. - Robust validation for OCPI-compliant data structures to ensure data integrity and accuracy.
- Compatible with a wide range of OCPI operations and functionalities, enhancing EV charging station services development.
Install node-ocpi
using npm:
npm install https://github.com/hyndex/node-ocpi
Import the required models from node-ocpi
:
const {
Location, EVSE, Connector, CDR, Command, Feedback, Meter, Reservation, Tariff, User, Transaction, Credentials,
ChargingProfilePeriod, ChargingProfile, ActiveChargingProfile, ChargingProfileResponse, ActiveChargingProfileResult, ChargingProfileResult, ClearProfileResult, SetChargingProfile,
CommandResult, CommandResponse,
DisplayText, EnergyContract, LocationReferences, Token, AuthorizationInfo, OCPIResponse
} = require('node-ocpi');
const location = new Location({ /* Location data */ });
location.validate();
const commandResult = new CommandResult({
result: 'ACCEPTED',
message: 'Command successfully executed'
});
commandResult.validate();
const commandResponse = new CommandResponse({
result: 'REJECTED',
timeout: 30,
message: 'Command could not be executed'
});
commandResponse.validate();
const ocpiResponse = new OCPIResponse({
statusCode: 2000,
statusMessage: 'Success',
timestamp: new Date().toISOString(),
data: { /* Your data object or array */ }
});
OCPIResponse.schema(YOUR_MODEL_SCHEMA).validate(ocpiResponse);
... (Continue with other models similarly)
Integrate node-ocpi
in Express.js applications for efficient handling of OCPI data:
const express = require('express');
const { Location } = require('node-ocpi');
const app = express();
app.use(express.json());
app.post('/locations', (req, res) => {
try {
const location = new Location(req.body);
location.validate();
res.status(201).send(location);
} catch (error) {
res.status(400).send(error.message);
}
});
app.listen(3000, () => {
console.log('Server running on port 3000');
});
Contributions are welcome:
- Fork the repository.
- Create a new feature branch.
- Develop your feature or fix.
- Write or adapt tests.
- Update the documentation.
- Commit and push your changes.
- Submit a pull request.
node-ocpi
is released under the MIT License. See LICENSE for details.