# @voltbras/ts-ocpp

> OCPP (Open Charge Point Protocol) implemented in Typescript

Latest version **2.7.3** (published 2022-03-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @voltbras/ts-ocpp
pnpm add @voltbras/ts-ocpp
yarn add @voltbras/ts-ocpp
bun add @voltbras/ts-ocpp
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.7.3 |
| Published | 2022-03-08 |
| First published | 2022-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 333.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 48 |
| Author | eduhenke |
| Maintainers | eduhenke, henkevb |

## Links

- npm: https://www.npmjs.com/package/@voltbras/ts-ocpp
- Repository: https://github.com/voltbras/ts-ocpp
- Issues: https://github.com/voltbras/ts-ocpp/issues
- npm.io page: https://npm.io/package/@voltbras/ts-ocpp

## Dependencies (5)

- [ws](https://npm.io/package/ws.md) ^7.4.4
- [soap](https://npm.io/package/soap.md) ^0.37.0
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [purify-ts](https://npm.io/package/purify-ts.md) ^0.16.1
- [jsonschema](https://npm.io/package/jsonschema.md) ^1.4.0

## Recent versions

- 2.7.3 (latest) — 2022-03-08
- 2.7.1 — 2022-02-10
- 2.7.0 — 2022-02-10
- 2.6.0 — 2022-02-09

## 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: {} );
```

---
_Source: https://npm.io/package/@voltbras/ts-ocpp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._