1 import { readFileSync
} from
'node:fs';
2 import { dirname
, join
} from
'node:path';
3 import { fileURLToPath
} from
'node:url';
5 import type { DefinedError
, ErrorObject
, JSONSchemaType
} from
'ajv';
6 import { isDate
} from
'date-fns';
8 import { OCPP16Constants
} from
'./1.6/OCPP16Constants';
9 import { OCPP20Constants
} from
'./2.0/OCPP20Constants';
10 import { OCPPConstants
} from
'./OCPPConstants';
11 import { type ChargingStation
, getConfigurationKey
, getIdTagsFile
} from
'../../charging-station';
12 import { BaseError
} from
'../../exception';
15 type AuthorizeRequest
,
16 type AuthorizeResponse
,
19 type ConnectorStatusEnum
,
22 IncomingRequestCommand
,
28 type OCPP16StatusNotificationRequest
,
29 type OCPP20StatusNotificationRequest
,
32 type SampledValueTemplate
,
33 StandardParametersKey
,
34 type StatusNotificationRequest
,
35 type StatusNotificationResponse
,
45 export class OCPPServiceUtils
{
46 protected constructor() {
47 // This is intentional
50 public static ajvErrorsToErrorType(errors
: ErrorObject
[]): ErrorType
{
51 for (const error
of errors
as DefinedError
[]) {
52 switch (error
.keyword
) {
54 return ErrorType
.TYPE_CONSTRAINT_VIOLATION
;
57 return ErrorType
.OCCURRENCE_CONSTRAINT_VIOLATION
;
60 return ErrorType
.PROPERTY_CONSTRAINT_VIOLATION
;
63 return ErrorType
.FORMAT_VIOLATION
;
66 public static getMessageTypeString(messageType
: MessageType
): string {
67 switch (messageType
) {
68 case MessageType
.CALL_MESSAGE
:
70 case MessageType
.CALL_RESULT_MESSAGE
:
72 case MessageType
.CALL_ERROR_MESSAGE
:
79 public static isRequestCommandSupported(
80 chargingStation
: ChargingStation
,
81 command
: RequestCommand
,
83 const isRequestCommand
= Object.values
<RequestCommand
>(RequestCommand
).includes(command
);
85 isRequestCommand
=== true &&
86 !chargingStation
.stationInfo
?.commandsSupport
?.outgoingCommands
90 isRequestCommand
=== true &&
91 chargingStation
.stationInfo
?.commandsSupport
?.outgoingCommands
93 return chargingStation
.stationInfo
?.commandsSupport
?.outgoingCommands
[command
] ?? false;
95 logger
.error(`${chargingStation.logPrefix()} Unknown outgoing OCPP command '${command}'`);
99 public static isIncomingRequestCommandSupported(
100 chargingStation
: ChargingStation
,
101 command
: IncomingRequestCommand
,
103 const isIncomingRequestCommand
=
104 Object.values
<IncomingRequestCommand
>(IncomingRequestCommand
).includes(command
);
106 isIncomingRequestCommand
=== true &&
107 !chargingStation
.stationInfo
?.commandsSupport
?.incomingCommands
111 isIncomingRequestCommand
=== true &&
112 chargingStation
.stationInfo
?.commandsSupport
?.incomingCommands
114 return chargingStation
.stationInfo
?.commandsSupport
?.incomingCommands
[command
] ?? false;
116 logger
.error(`${chargingStation.logPrefix()} Unknown incoming OCPP command '${command}'`);
120 public static isMessageTriggerSupported(
121 chargingStation
: ChargingStation
,
122 messageTrigger
: MessageTrigger
,
124 const isMessageTrigger
= Object.values(MessageTrigger
).includes(messageTrigger
);
125 if (isMessageTrigger
=== true && !chargingStation
.stationInfo
?.messageTriggerSupport
) {
127 } else if (isMessageTrigger
=== true && chargingStation
.stationInfo
?.messageTriggerSupport
) {
128 return chargingStation
.stationInfo
?.messageTriggerSupport
[messageTrigger
] ?? false;
131 `${chargingStation.logPrefix()} Unknown incoming OCPP message trigger '${messageTrigger}'`,
136 public static isConnectorIdValid(
137 chargingStation
: ChargingStation
,
138 ocppCommand
: IncomingRequestCommand
,
141 if (connectorId
< 0) {
143 `${chargingStation.logPrefix()} ${ocppCommand} incoming request received with invalid connector id ${connectorId}`,
150 public static convertDateToISOString
<T
extends JsonType
>(obj
: T
): void {
151 for (const key
in obj
) {
152 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
153 if (isDate(obj
![key
])) {
154 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
155 (obj
![key
] as string) = (obj
![key
] as Date).toISOString();
156 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
157 } else if (obj
![key
] !== null && typeof obj
![key
] === 'object') {
158 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
159 OCPPServiceUtils
.convertDateToISOString
<T
>(obj
![key
] as T
);
164 public static buildStatusNotificationRequest(
165 chargingStation
: ChargingStation
,
167 status: ConnectorStatusEnum
,
169 ): StatusNotificationRequest
{
170 switch (chargingStation
.stationInfo
.ocppVersion
?? OCPPVersion
.VERSION_16
) {
171 case OCPPVersion
.VERSION_16
:
175 errorCode
: ChargePointErrorCode
.NO_ERROR
,
176 } as OCPP16StatusNotificationRequest
;
177 case OCPPVersion
.VERSION_20
:
178 case OCPPVersion
.VERSION_201
:
180 timestamp
: new Date(),
181 connectorStatus
: status,
184 } as OCPP20StatusNotificationRequest
;
186 throw new BaseError('Cannot build status notification payload: OCPP version not supported');
190 public static startHeartbeatInterval(chargingStation
: ChargingStation
, interval
: number): void {
191 if (!chargingStation
.heartbeatSetInterval
) {
192 chargingStation
.startHeartbeat();
193 } else if (chargingStation
.getHeartbeatInterval() !== interval
) {
194 chargingStation
.restartHeartbeat();
198 public static async sendAndSetConnectorStatus(
199 chargingStation
: ChargingStation
,
201 status: ConnectorStatusEnum
,
203 options
?: { send
: boolean },
205 options
= { send
: true, ...options
};
207 OCPPServiceUtils
.checkConnectorStatusTransition(chargingStation
, connectorId
, status);
208 await chargingStation
.ocppRequestService
.requestHandler
<
209 StatusNotificationRequest
,
210 StatusNotificationResponse
213 RequestCommand
.STATUS_NOTIFICATION
,
214 OCPPServiceUtils
.buildStatusNotificationRequest(
222 chargingStation
.getConnectorStatus(connectorId
)!.status = status;
225 public static async isIdTagAuthorized(
226 chargingStation
: ChargingStation
,
229 ): Promise
<boolean> {
230 if (!chargingStation
.getLocalAuthListEnabled() && !chargingStation
.getRemoteAuthorization()) {
232 `${chargingStation.logPrefix()} The charging station expects to authorize RFID tags but nor local authorization nor remote authorization are enabled. Misbehavior may occur`,
236 chargingStation
.getLocalAuthListEnabled() === true &&
237 OCPPServiceUtils
.isIdTagLocalAuthorized(chargingStation
, idTag
)
239 const connectorStatus
: ConnectorStatus
= chargingStation
.getConnectorStatus(connectorId
)!;
240 connectorStatus
.localAuthorizeIdTag
= idTag
;
241 connectorStatus
.idTagLocalAuthorized
= true;
243 } else if (chargingStation
.getRemoteAuthorization()) {
244 return await OCPPServiceUtils
.isIdTagRemoteAuthorized(chargingStation
, connectorId
, idTag
);
249 protected static checkConnectorStatusTransition(
250 chargingStation
: ChargingStation
,
252 status: ConnectorStatusEnum
,
254 const fromStatus
= chargingStation
.getConnectorStatus(connectorId
)!.status;
255 let transitionAllowed
= false;
256 switch (chargingStation
.stationInfo
.ocppVersion
) {
257 case OCPPVersion
.VERSION_16
:
259 (connectorId
=== 0 &&
260 OCPP16Constants
.ChargePointStatusChargingStationTransitions
.findIndex(
261 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
264 OCPP16Constants
.ChargePointStatusConnectorTransitions
.findIndex(
265 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
268 transitionAllowed
= true;
271 case OCPPVersion
.VERSION_20
:
272 case OCPPVersion
.VERSION_201
:
274 (connectorId
=== 0 &&
275 OCPP20Constants
.ChargingStationStatusTransitions
.findIndex(
276 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
279 OCPP20Constants
.ConnectorStatusTransitions
.findIndex(
280 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
283 transitionAllowed
= true;
288 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
289 `Cannot check connector status transition: OCPP version ${chargingStation.stationInfo.ocppVersion} not supported`,
292 if (transitionAllowed
=== false) {
294 `${chargingStation.logPrefix()} OCPP ${
295 chargingStation.stationInfo.ocppVersion
296 } connector id ${connectorId} status transition from '${
297 chargingStation.getConnectorStatus(connectorId)!.status
298 }' to '${status}' is not allowed`,
301 return transitionAllowed
;
304 protected static parseJsonSchemaFile
<T
extends JsonType
>(
305 relativePath
: string,
306 ocppVersion
: OCPPVersion
,
309 ): JSONSchemaType
<T
> {
310 const filePath
= join(dirname(fileURLToPath(import.meta
.url
)), relativePath
);
312 return JSON
.parse(readFileSync(filePath
, 'utf8')) as JSONSchemaType
<T
>;
317 error
as NodeJS
.ErrnoException
,
318 OCPPServiceUtils
.logPrefix(ocppVersion
, moduleName
, methodName
),
319 { throwError
: false },
321 return {} as JSONSchemaType
<T
>;
325 protected static getSampledValueTemplate(
326 chargingStation
: ChargingStation
,
328 measurand
: MeterValueMeasurand
= MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
,
329 phase
?: MeterValuePhase
,
330 ): SampledValueTemplate
| undefined {
331 const onPhaseStr
= phase
? `on phase ${phase} ` : '';
332 if (OCPPConstants
.OCPP_MEASURANDS_SUPPORTED
.includes(measurand
) === false) {
334 `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
339 measurand
!== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
&&
342 StandardParametersKey
.MeterValuesSampledData
,
343 )?.value
?.includes(measurand
) === false
346 `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId} not found in '${
347 StandardParametersKey.MeterValuesSampledData
352 const sampledValueTemplates
: SampledValueTemplate
[] =
353 chargingStation
.getConnectorStatus(connectorId
)!.MeterValues
;
356 isNotEmptyArray(sampledValueTemplates
) === true && index
< sampledValueTemplates
.length
;
360 OCPPConstants
.OCPP_MEASURANDS_SUPPORTED
.includes(
361 sampledValueTemplates
[index
]?.measurand
??
362 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
,
366 `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
370 sampledValueTemplates
[index
]?.phase
=== phase
&&
371 sampledValueTemplates
[index
]?.measurand
=== measurand
&&
374 StandardParametersKey
.MeterValuesSampledData
,
375 )?.value
?.includes(measurand
) === true
377 return sampledValueTemplates
[index
];
380 !sampledValueTemplates
[index
].phase
&&
381 sampledValueTemplates
[index
]?.measurand
=== measurand
&&
384 StandardParametersKey
.MeterValuesSampledData
,
385 )?.value
?.includes(measurand
) === true
387 return sampledValueTemplates
[index
];
389 measurand
=== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
&&
390 (!sampledValueTemplates
[index
].measurand
||
391 sampledValueTemplates
[index
].measurand
=== measurand
)
393 return sampledValueTemplates
[index
];
396 if (measurand
=== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
) {
397 const errorMsg
= `Missing MeterValues for default measurand '${measurand}' in template on connector id ${connectorId}`;
398 logger
.error(`${chargingStation.logPrefix()} ${errorMsg}`);
399 throw new BaseError(errorMsg
);
402 `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
406 protected static getLimitFromSampledValueTemplateCustomValue(
409 options
?: { limitationEnabled
?: boolean; unitMultiplier
?: number },
413 limitationEnabled
: true,
418 const parsedInt
= parseInt(value
);
419 const numberValue
= isNaN(parsedInt
) ? Infinity : parsedInt
;
420 return options
?.limitationEnabled
421 ? Math.min(numberValue
* options
.unitMultiplier
!, limit
)
422 : numberValue
* options
.unitMultiplier
!;
425 private static isIdTagLocalAuthorized(chargingStation
: ChargingStation
, idTag
: string): boolean {
427 chargingStation
.hasIdTags() === true &&
429 chargingStation
.idTagsCache
430 .getIdTags(getIdTagsFile(chargingStation
.stationInfo
)!)
431 ?.find((tag
) => tag
=== idTag
),
436 private static async isIdTagRemoteAuthorized(
437 chargingStation
: ChargingStation
,
440 ): Promise
<boolean> {
441 chargingStation
.getConnectorStatus(connectorId
)!.authorizeIdTag
= idTag
;
444 await chargingStation
.ocppRequestService
.requestHandler
<
447 >(chargingStation
, RequestCommand
.AUTHORIZE
, {
450 )?.idTagInfo
?.status === AuthorizationStatus
.ACCEPTED
454 private static logPrefix
= (
455 ocppVersion
: OCPPVersion
,
460 isNotEmptyString(moduleName
) && isNotEmptyString(methodName
)
461 ? ` OCPP ${ocppVersion} | ${moduleName}.${methodName}:`
462 : ` OCPP ${ocppVersion} |`;
463 return logPrefix(logMsg
);