@totemsdk/edge-ocpp 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/LICENSE +202 -0
  2. package/NOTICE +60 -0
  3. package/README.md +119 -2
  4. package/dist/cjs/gateway.d.ts +49 -0
  5. package/dist/cjs/gateway.js +184 -0
  6. package/dist/cjs/governed/adapter.d.ts +32 -0
  7. package/dist/cjs/governed/adapter.js +537 -0
  8. package/dist/cjs/governed/capabilities.d.ts +32 -0
  9. package/dist/cjs/governed/capabilities.js +53 -0
  10. package/dist/cjs/governed/effects.d.ts +22 -0
  11. package/dist/cjs/governed/effects.js +27 -0
  12. package/dist/cjs/governed/index.d.ts +20 -0
  13. package/dist/cjs/governed/index.js +35 -0
  14. package/dist/cjs/governed/meter.d.ts +39 -0
  15. package/dist/cjs/governed/meter.js +81 -0
  16. package/dist/cjs/governed/profile.d.ts +40 -0
  17. package/dist/cjs/governed/profile.js +175 -0
  18. package/dist/cjs/governed/transport.d.ts +104 -0
  19. package/dist/cjs/governed/transport.js +33 -0
  20. package/dist/cjs/index.d.ts +7 -0
  21. package/dist/cjs/index.js +15 -0
  22. package/dist/cjs/ocpp.d.ts +40 -0
  23. package/dist/cjs/ocpp.js +101 -0
  24. package/dist/cjs/package.json +1 -0
  25. package/dist/cjs/sensor-bridge.d.ts +32 -0
  26. package/dist/cjs/sensor-bridge.js +72 -0
  27. package/dist/cjs/transport.d.ts +16 -0
  28. package/dist/cjs/transport.js +9 -0
  29. package/dist/gateway.d.ts +49 -0
  30. package/dist/gateway.js +181 -0
  31. package/dist/governed/adapter.d.ts +32 -0
  32. package/dist/governed/adapter.js +533 -0
  33. package/dist/governed/capabilities.d.ts +32 -0
  34. package/dist/governed/capabilities.js +48 -0
  35. package/dist/governed/effects.d.ts +22 -0
  36. package/dist/governed/effects.js +24 -0
  37. package/dist/governed/index.d.ts +20 -0
  38. package/dist/governed/index.js +14 -0
  39. package/dist/governed/meter.d.ts +39 -0
  40. package/dist/governed/meter.js +77 -0
  41. package/dist/governed/profile.d.ts +40 -0
  42. package/dist/governed/profile.js +167 -0
  43. package/dist/governed/transport.d.ts +104 -0
  44. package/dist/governed/transport.js +28 -0
  45. package/dist/index.d.ts +7 -0
  46. package/dist/index.js +3 -0
  47. package/dist/ocpp.d.ts +40 -0
  48. package/dist/ocpp.js +92 -0
  49. package/dist/sensor-bridge.d.ts +32 -0
  50. package/dist/sensor-bridge.js +69 -0
  51. package/dist/transport.d.ts +16 -0
  52. package/dist/transport.js +8 -0
  53. package/package.json +77 -3
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,60 @@
1
+ Totem SDK
2
+ Copyright 2024-2026 Totem SDK Contributors
3
+
4
+ This product includes software and material derived from the projects listed
5
+ below. The notices are provided for attribution and do not modify the Apache
6
+ License, Version 2.0.
7
+
8
+ Minima
9
+ ------
10
+ Minima protocol and application
11
+ https://github.com/minima-global/Minima
12
+ Licensed under the Apache License, Version 2.0.
13
+
14
+ Portions of the Totem SDK core, KISSVM, serialization, transaction and wallet
15
+ surfaces are translated or adapted from Minima's Java implementation. Those
16
+ portions remain subject to the Apache License, Version 2.0 and retain the
17
+ applicable copyright and attribution notices.
18
+
19
+ Bouncy Castle
20
+ -------------
21
+ Legion of the Bouncy Castle Inc.
22
+ https://www.bouncycastle.org/
23
+ Licensed under the Bouncy Castle License (MIT-style).
24
+
25
+ The Winternitz/GMSS-compatible WOTS implementation follows the algorithms and
26
+ behaviour of Bouncy Castle's WinternitzOTSignature, WinternitzOTSVerify and
27
+ GMSSRandom classes.
28
+
29
+ QVAC
30
+ ----
31
+ QVAC SDK
32
+ https://www.npmjs.com/package/@qvac/sdk
33
+ Licensed under the Apache License, Version 2.0.
34
+
35
+ The vendored type surface in packages/qvac/src/vendor/qvac-sdk.d.ts is
36
+ reconstructed from the @qvac/sdk type declarations for build-time use.
37
+
38
+ Protocol Buffers
39
+ ----------------
40
+ Protocol Buffers - Google's data interchange format
41
+ Copyright 2008 Google Inc. All rights reserved.
42
+ https://developers.google.com/protocol-buffers/
43
+ Licensed under the BSD 3-Clause License.
44
+
45
+ The generated file packages/agent-policy/src/generated/google/protobuf/struct.ts
46
+ retains its original BSD 3-Clause header.
47
+
48
+ BIP39
49
+ -----
50
+ BIP39 English word list
51
+ https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt
52
+ Licensed under the MIT License.
53
+
54
+ Contributor Covenant
55
+ --------------------
56
+ Contributor Covenant, version 2.1
57
+ https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
58
+ Licensed under the Creative Commons Attribution 4.0 International License.
59
+
60
+ The Totem SDK Code of Conduct is adapted from Contributor Covenant 2.1.
package/README.md CHANGED
@@ -1,3 +1,120 @@
1
- # Temporary Holding Version
1
+ # @totemsdk/edge-ocpp
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Edge runtime adapter for OCPP — EV charging wire protocol and meter proofs.
4
+
5
+ > **Wire layer only at the package root.** The root frames and correlates OCPP-J
6
+ > messages and has no decision, authority or physical-effect policy.
7
+ > Starting/stopping a charging session, setting limits or unlocking a connector
8
+ > go through the governed `@totemsdk/edge-ocpp/governed` entry point (RFC-024),
9
+ > built on `@totemsdk/act-core`.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install @totemsdk/edge-ocpp
15
+ ```
16
+
17
+ The governed profile ships in the same package — no second install:
18
+
19
+ ```ts
20
+ import { createOcppGateway } from '@totemsdk/edge-ocpp';
21
+ import { createOcppDefinitions, createOcppProfile } from '@totemsdk/edge-ocpp/governed';
22
+ ```
23
+
24
+ ## Design
25
+
26
+ A text-frame transport is injected via `OcppTransportPort`. The connector owns
27
+ OCPP-J framing, CALL/CALLRESULT/CALLERROR correlation, inbound CALL dispatch,
28
+ BootNotification, heartbeat and a meter-value bridge. The caller supplies the
29
+ WebSocket (or test) transport and OCPP version profile.
30
+
31
+ ## Quick start
32
+
33
+ ```ts
34
+ import { createOcppGateway, createOcppSensorBridge } from '@totemsdk/edge-ocpp';
35
+ import type { OcppTransportPort } from '@totemsdk/edge-ocpp';
36
+
37
+ const transport: OcppTransportPort = {
38
+ async connect(url, protocols) { /* open WebSocket */ },
39
+ async close() { /* close */ },
40
+ async send(message) { /* send text frame */ },
41
+ onMessage(handler) { /* return unsubscribe */ return () => {}; },
42
+ onClose(handler) { return () => {}; },
43
+ onError(handler) { return () => {}; },
44
+ };
45
+
46
+ const gateway = createOcppGateway({
47
+ runtime,
48
+ transport,
49
+ url: 'wss://csms.example/ocpp/CP-1',
50
+ chargePointId: 'CP-1',
51
+ });
52
+
53
+ await gateway.start(); // connects, sends BootNotification, starts heartbeat
54
+
55
+ const auth = await gateway.authorize('RFID-TAG');
56
+
57
+ gateway.onCall('RemoteStartTransaction', async (payload) => {
58
+ // This handler is the *wire* response. It does not grant authority.
59
+ return { status: 'Accepted' };
60
+ });
61
+
62
+ const meterBridge = createOcppSensorBridge({
63
+ runtime,
64
+ gateway,
65
+ bindings: [{
66
+ sensorId: 'energy-meter',
67
+ connectorId: 1,
68
+ intervalMs: 60_000,
69
+ read: async () => [{ value: 12.5, unit: 'kWh', transactionId: 42 }],
70
+ }],
71
+ });
72
+ await meterBridge.start();
73
+ ```
74
+
75
+ ## OCPP-J framing
76
+
77
+ ```
78
+ CALL [2, messageId, action, payload]
79
+ CALLRESULT [3, messageId, payload]
80
+ CALLERROR [4, messageId, errorCode, errorDescription, errorDetails]
81
+ ```
82
+
83
+ `parseOcppFrame` validates the message type, id, action, payload shape and
84
+ error code. `OcppError` carries a valid OCPP error code and details.
85
+
86
+ ## Gateway behaviour
87
+
88
+ - Boot is not successful unless the CSMS returns `status: "Accepted"`.
89
+ - Heartbeats are sent on the configured interval; failures mark the gateway
90
+ `error`.
91
+ - Inbound CSMS calls are dispatched to registered handlers. An unmatched action
92
+ receives `CallError NotSupported`; a handler throwing `OcppError` returns its
93
+ code; other throws return `InternalError`.
94
+ - Calls time out with an explicit failure and connection loss rejects pending
95
+ calls.
96
+ - Meter values are sent as standard `MeterValues` calls; the bridge also creates
97
+ `sensor:<id>` proofs for each sample.
98
+
99
+ ## Qualification status
100
+
101
+ `@totemsdk/edge-ocpp` is **RC**. The qualified profile covers OCPP-J framing,
102
+ boot/heartbeat, call correlation, inbound CALL dispatch, meter values, sensor
103
+ proofs and teardown against an injected transport simulator.
104
+
105
+ Not qualified: a real WebSocket/TLS transport, an OCPP stack/vendor matrix,
106
+ OCPP 2.0.1 transaction-event semantics, and any governed charging action. The
107
+ governed profile ships in this package at `@totemsdk/edge-ocpp/governed` and is
108
+ required before this connector may start, stop, limit or reserve charging.
109
+
110
+ ## Testing
111
+
112
+ Tests live outside the published package. Package `test:*` scripts are
113
+ repository delegates; tests are not shipped.
114
+
115
+ - Unit (framing, gateway, bridge): `npm test`
116
+ - Simulator integration: `npm run test:integration`
117
+
118
+ ## License
119
+
120
+ Apache-2.0 — see [LICENSE](./LICENSE) and [NOTICE](./NOTICE).
@@ -0,0 +1,49 @@
1
+ /**
2
+ * OCPP Edge Gateway — charge-point side of OCPP-J.
3
+ *
4
+ * The gateway owns framing, CALL/CALLRESULT/CALLERROR correlation, inbound CALL
5
+ * dispatch, boot notification and heartbeat. It has no decision, authority or
6
+ * physical-effect policy: starting/stopping a charging session must go through
7
+ * the governed `@totemsdk/edge-ocpp/governed` profile (RFC-024).
8
+ */
9
+ import type { EdgeRuntime, EdgeOperationResult } from '@totemsdk/edge';
10
+ import type { OcppTransportPort } from './transport.js';
11
+ export type OcppVersion = '1.6J' | '2.0.1';
12
+ export interface OcppGatewayConfig {
13
+ runtime: EdgeRuntime;
14
+ transport: OcppTransportPort;
15
+ url: string;
16
+ chargePointId: string;
17
+ version?: OcppVersion;
18
+ protocols?: string[];
19
+ /** Heartbeat interval; 0 disables automatic heartbeats. Default 30s. */
20
+ heartbeatIntervalMs?: number;
21
+ callTimeoutMs?: number;
22
+ /** Send BootNotification during start. Default true. */
23
+ bootOnStart?: boolean;
24
+ bootNotification?: Record<string, unknown>;
25
+ }
26
+ export type OcppCallHandler = (payload: Record<string, unknown>) => Promise<Record<string, unknown>> | Record<string, unknown>;
27
+ export interface OcppGateway {
28
+ start(): Promise<void>;
29
+ stop(): Promise<void>;
30
+ readonly status: 'stopped' | 'running' | 'error';
31
+ call(action: string, payload?: Record<string, unknown>, timeoutMs?: number): Promise<EdgeOperationResult<{
32
+ payload: Record<string, unknown>;
33
+ }>>;
34
+ /** Register a handler for an inbound CSMS CALL. */
35
+ onCall(action: string, handler: OcppCallHandler): () => void;
36
+ sendBootNotification(payload?: Record<string, unknown>): Promise<EdgeOperationResult<{
37
+ payload: Record<string, unknown>;
38
+ }>>;
39
+ sendHeartbeat(): Promise<EdgeOperationResult<{
40
+ payload: Record<string, unknown>;
41
+ }>>;
42
+ sendStatusNotification(connectorId: number, status: string, errorCode?: string): Promise<EdgeOperationResult<{
43
+ payload: Record<string, unknown>;
44
+ }>>;
45
+ authorize(idTag: string): Promise<EdgeOperationResult<{
46
+ payload: Record<string, unknown>;
47
+ }>>;
48
+ }
49
+ export declare function createOcppGateway(config: OcppGatewayConfig): OcppGateway;
@@ -0,0 +1,184 @@
1
+ "use strict";
2
+ /**
3
+ * OCPP Edge Gateway — charge-point side of OCPP-J.
4
+ *
5
+ * The gateway owns framing, CALL/CALLRESULT/CALLERROR correlation, inbound CALL
6
+ * dispatch, boot notification and heartbeat. It has no decision, authority or
7
+ * physical-effect policy: starting/stopping a charging session must go through
8
+ * the governed `@totemsdk/edge-ocpp/governed` profile (RFC-024).
9
+ */
10
+ Object.defineProperty(exports, "__esModule", { value: true });
11
+ exports.createOcppGateway = createOcppGateway;
12
+ const ocpp_js_1 = require("./ocpp.js");
13
+ function createOcppGateway(config) {
14
+ let status = 'stopped';
15
+ let sequence = 0;
16
+ let heartbeatTimer;
17
+ let unsubMessage;
18
+ let unsubClose;
19
+ let unsubError;
20
+ const pending = new Map();
21
+ const callHandlers = new Map();
22
+ const callTimeoutMs = config.callTimeoutMs ?? 10000;
23
+ const bootPayload = config.bootNotification ?? { chargePointVendor: 'Totem', chargePointModel: 'Edge' };
24
+ function rejectAll(error) {
25
+ for (const [, entry] of pending) {
26
+ clearTimeout(entry.timer);
27
+ entry.reject(error);
28
+ }
29
+ pending.clear();
30
+ }
31
+ function result(payload) {
32
+ return { ok: true, data: payload };
33
+ }
34
+ function failure(error) {
35
+ if (error instanceof ocpp_js_1.OcppError)
36
+ return { ok: false, error: error.message, errorCode: error.code };
37
+ return { ok: false, error: error instanceof Error ? error.message : String(error) };
38
+ }
39
+ function sendCall(action, payload = {}, timeoutMs = callTimeoutMs) {
40
+ return call(action, payload, timeoutMs);
41
+ }
42
+ async function call(action, payload = {}, timeoutMs = callTimeoutMs) {
43
+ const messageId = `${config.chargePointId}-${++sequence}`;
44
+ return new Promise((resolve) => {
45
+ const timer = setTimeout(() => {
46
+ pending.delete(messageId);
47
+ resolve({ ok: false, error: `OCPP ${action} timed out` });
48
+ }, timeoutMs);
49
+ pending.set(messageId, {
50
+ resolve: (response) => resolve(result({ payload: response })),
51
+ reject: (error) => resolve({ ok: false, error: error.message, errorCode: error.code }),
52
+ timer,
53
+ });
54
+ void config.transport.send((0, ocpp_js_1.encodeCall)(messageId, action, payload)).catch((error) => {
55
+ const entry = pending.get(messageId);
56
+ if (!entry)
57
+ return;
58
+ pending.delete(messageId);
59
+ clearTimeout(entry.timer);
60
+ resolve(failure(error));
61
+ });
62
+ });
63
+ }
64
+ async function handleRaw(raw) {
65
+ let frame;
66
+ try {
67
+ frame = (0, ocpp_js_1.parseOcppFrame)(raw);
68
+ }
69
+ catch {
70
+ status = 'error';
71
+ return;
72
+ }
73
+ if (frame.type === 3) {
74
+ const entry = pending.get(frame.messageId);
75
+ if (!entry)
76
+ return;
77
+ pending.delete(frame.messageId);
78
+ clearTimeout(entry.timer);
79
+ status = 'running';
80
+ entry.resolve(frame.payload);
81
+ return;
82
+ }
83
+ if (frame.type === 4) {
84
+ const entry = pending.get(frame.messageId);
85
+ if (!entry)
86
+ return;
87
+ pending.delete(frame.messageId);
88
+ clearTimeout(entry.timer);
89
+ entry.reject(new ocpp_js_1.OcppError(frame.errorCode, frame.errorDescription, frame.errorDetails));
90
+ return;
91
+ }
92
+ const handlers = callHandlers.get(frame.action);
93
+ let response = {};
94
+ try {
95
+ if (!handlers || handlers.size === 0) {
96
+ await config.transport.send((0, ocpp_js_1.encodeCallError)(frame.messageId, 'NotSupported', `No handler for ${frame.action}`));
97
+ return;
98
+ }
99
+ for (const handler of handlers)
100
+ response = await handler(frame.payload);
101
+ await config.transport.send((0, ocpp_js_1.encodeCallResult)(frame.messageId, response));
102
+ }
103
+ catch (error) {
104
+ const code = error instanceof ocpp_js_1.OcppError ? error.code : 'InternalError';
105
+ const description = error instanceof Error ? error.message : String(error);
106
+ const details = error instanceof ocpp_js_1.OcppError ? error.details : {};
107
+ await config.transport.send((0, ocpp_js_1.encodeCallError)(frame.messageId, code, description, details)).catch(() => { });
108
+ }
109
+ }
110
+ return {
111
+ get status() { return status; },
112
+ async start() {
113
+ if (status === 'running')
114
+ return;
115
+ try {
116
+ await config.transport.connect(config.url, config.protocols);
117
+ unsubMessage = config.transport.onMessage((raw) => { void handleRaw(raw); });
118
+ unsubClose = config.transport.onClose(() => {
119
+ status = 'error';
120
+ rejectAll(new ocpp_js_1.OcppError('GenericError', 'OCPP connection closed'));
121
+ });
122
+ unsubError = config.transport.onError(() => { status = 'error'; });
123
+ if (config.bootOnStart ?? true) {
124
+ const boot = await call('BootNotification', bootPayload);
125
+ const bootStatus = boot.ok ? boot.data?.payload.status : undefined;
126
+ if (!boot.ok || bootStatus !== 'Accepted') {
127
+ await this.stop();
128
+ status = 'error';
129
+ throw new Error(`OCPP boot rejected: ${boot.ok ? String(bootStatus) : boot.error}`);
130
+ }
131
+ }
132
+ status = 'running';
133
+ const heartbeatInterval = config.heartbeatIntervalMs ?? 30000;
134
+ if (heartbeatInterval > 0) {
135
+ heartbeatTimer = setInterval(() => {
136
+ void call('Heartbeat', {}).then((response) => {
137
+ if (!response.ok)
138
+ status = 'error';
139
+ });
140
+ }, heartbeatInterval);
141
+ }
142
+ }
143
+ catch (error) {
144
+ status = 'error';
145
+ throw error;
146
+ }
147
+ },
148
+ async stop() {
149
+ if (heartbeatTimer) {
150
+ clearInterval(heartbeatTimer);
151
+ heartbeatTimer = undefined;
152
+ }
153
+ unsubMessage?.();
154
+ unsubClose?.();
155
+ unsubError?.();
156
+ unsubMessage = undefined;
157
+ unsubClose = undefined;
158
+ unsubError = undefined;
159
+ rejectAll(new ocpp_js_1.OcppError('GenericError', 'OCPP gateway stopped'));
160
+ try {
161
+ await config.transport.close();
162
+ }
163
+ catch { /* already closed */ }
164
+ status = 'stopped';
165
+ },
166
+ call,
167
+ onCall(action, handler) {
168
+ const handlers = callHandlers.get(action) ?? new Set();
169
+ handlers.add(handler);
170
+ callHandlers.set(action, handlers);
171
+ return () => {
172
+ handlers.delete(handler);
173
+ if (handlers.size === 0)
174
+ callHandlers.delete(action);
175
+ };
176
+ },
177
+ sendBootNotification(payload = bootPayload) { return sendCall('BootNotification', payload); },
178
+ sendHeartbeat() { return sendCall('Heartbeat', {}); },
179
+ sendStatusNotification(connectorId, connectorStatus, errorCode = 'NoError') {
180
+ return sendCall('StatusNotification', { connectorId, status: connectorStatus, errorCode });
181
+ },
182
+ authorize(idTag) { return sendCall('Authorize', { idTag }); },
183
+ };
184
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * RFC-024 §5.3 — governed OCPP operations.
3
+ *
4
+ * Each definition prepares a deterministic, commitment-bound OCPP command and
5
+ * derives its physical effects from that prepared command (never from hints).
6
+ * `startSession`/`stopSession` are asynchronous: acceptance is not completion,
7
+ * and completion is established by charger meter/transaction readback.
8
+ *
9
+ * Configuration writes (`setLimit`, `clearProfile`, `reserveConnector`) use
10
+ * `confirmation: 'completed'` because the CSMS acknowledgement *is* the terminal
11
+ * state for a profile/ reservation change; only a session has a later physical
12
+ * outcome to observe.
13
+ */
14
+ import { type IndustrialActionDefinition, type UnitRegistry } from '@totemsdk/act-core';
15
+ import type { OcppCapabilitySet } from './capabilities.js';
16
+ import { type ChargingConnector } from './profile.js';
17
+ import { type OcppTransportPort } from './transport.js';
18
+ export interface OcppAdapterOptions {
19
+ transport: OcppTransportPort;
20
+ site: string;
21
+ connectors: readonly ChargingConnector[];
22
+ capabilities?: OcppCapabilitySet;
23
+ units?: UnitRegistry;
24
+ }
25
+ interface ChargingCommand {
26
+ action: string;
27
+ connectorId: number;
28
+ [key: string]: unknown;
29
+ }
30
+ export declare function createOcppDefinitions(options: OcppAdapterOptions): IndustrialActionDefinition[];
31
+ export declare function errorCodeOf(error: unknown): string | undefined;
32
+ export type { ChargingCommand };