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
?.[command
]
93 return chargingStation
.stationInfo
?.commandsSupport
?.outgoingCommands
[command
];
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
?.[command
]
114 return chargingStation
.stationInfo
?.commandsSupport
?.incomingCommands
[command
];
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
) {
128 isMessageTrigger
=== true &&
129 chargingStation
.stationInfo
?.messageTriggerSupport
?.[messageTrigger
]
131 return chargingStation
.stationInfo
?.messageTriggerSupport
[messageTrigger
];
134 `${chargingStation.logPrefix()} Unknown incoming OCPP message trigger '${messageTrigger}'`,
139 public static isConnectorIdValid(
140 chargingStation
: ChargingStation
,
141 ocppCommand
: IncomingRequestCommand
,
144 if (connectorId
< 0) {
146 `${chargingStation.logPrefix()} ${ocppCommand} incoming request received with invalid connector id ${connectorId}`,
153 public static convertDateToISOString
<T
extends JsonType
>(obj
: T
): void {
154 for (const key
in obj
) {
155 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
156 if (isDate(obj
![key
])) {
157 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
158 (obj
![key
] as string) = (obj
![key
] as Date).toISOString();
159 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
160 } else if (obj
![key
] !== null && typeof obj
![key
] === 'object') {
161 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
162 OCPPServiceUtils
.convertDateToISOString
<T
>(obj
![key
] as T
);
167 public static buildStatusNotificationRequest(
168 chargingStation
: ChargingStation
,
170 status: ConnectorStatusEnum
,
172 ): StatusNotificationRequest
{
173 switch (chargingStation
.stationInfo
.ocppVersion
?? OCPPVersion
.VERSION_16
) {
174 case OCPPVersion
.VERSION_16
:
178 errorCode
: ChargePointErrorCode
.NO_ERROR
,
179 } as OCPP16StatusNotificationRequest
;
180 case OCPPVersion
.VERSION_20
:
181 case OCPPVersion
.VERSION_201
:
183 timestamp
: new Date(),
184 connectorStatus
: status,
187 } as OCPP20StatusNotificationRequest
;
189 throw new BaseError('Cannot build status notification payload: OCPP version not supported');
193 public static startHeartbeatInterval(chargingStation
: ChargingStation
, interval
: number): void {
194 if (!chargingStation
.heartbeatSetInterval
) {
195 chargingStation
.startHeartbeat();
196 } else if (chargingStation
.getHeartbeatInterval() !== interval
) {
197 chargingStation
.restartHeartbeat();
201 public static async sendAndSetConnectorStatus(
202 chargingStation
: ChargingStation
,
204 status: ConnectorStatusEnum
,
206 options
?: { send
: boolean },
208 options
= { send
: true, ...options
};
210 OCPPServiceUtils
.checkConnectorStatusTransition(chargingStation
, connectorId
, status);
211 await chargingStation
.ocppRequestService
.requestHandler
<
212 StatusNotificationRequest
,
213 StatusNotificationResponse
216 RequestCommand
.STATUS_NOTIFICATION
,
217 OCPPServiceUtils
.buildStatusNotificationRequest(
225 chargingStation
.getConnectorStatus(connectorId
)!.status = status;
228 public static async isIdTagAuthorized(
229 chargingStation
: ChargingStation
,
232 ): Promise
<boolean> {
233 if (!chargingStation
.getLocalAuthListEnabled() && !chargingStation
.getRemoteAuthorization()) {
235 `${chargingStation.logPrefix()} The charging station expects to authorize RFID tags but nor local authorization nor remote authorization are enabled. Misbehavior may occur`,
239 chargingStation
.getLocalAuthListEnabled() === true &&
240 OCPPServiceUtils
.isIdTagLocalAuthorized(chargingStation
, idTag
)
242 const connectorStatus
: ConnectorStatus
= chargingStation
.getConnectorStatus(connectorId
)!;
243 connectorStatus
.localAuthorizeIdTag
= idTag
;
244 connectorStatus
.idTagLocalAuthorized
= true;
246 } else if (chargingStation
.getRemoteAuthorization()) {
247 return await OCPPServiceUtils
.isIdTagRemoteAuthorized(chargingStation
, connectorId
, idTag
);
252 protected static checkConnectorStatusTransition(
253 chargingStation
: ChargingStation
,
255 status: ConnectorStatusEnum
,
257 const fromStatus
= chargingStation
.getConnectorStatus(connectorId
)!.status;
258 let transitionAllowed
= false;
259 switch (chargingStation
.stationInfo
.ocppVersion
) {
260 case OCPPVersion
.VERSION_16
:
262 (connectorId
=== 0 &&
263 OCPP16Constants
.ChargePointStatusChargingStationTransitions
.findIndex(
264 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
267 OCPP16Constants
.ChargePointStatusConnectorTransitions
.findIndex(
268 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
271 transitionAllowed
= true;
274 case OCPPVersion
.VERSION_20
:
275 case OCPPVersion
.VERSION_201
:
277 (connectorId
=== 0 &&
278 OCPP20Constants
.ChargingStationStatusTransitions
.findIndex(
279 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
282 OCPP20Constants
.ConnectorStatusTransitions
.findIndex(
283 (transition
) => transition
.from
=== fromStatus
&& transition
.to
=== status,
286 transitionAllowed
= true;
291 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
292 `Cannot check connector status transition: OCPP version ${chargingStation.stationInfo.ocppVersion} not supported`,
295 if (transitionAllowed
=== false) {
297 `${chargingStation.logPrefix()} OCPP ${
298 chargingStation.stationInfo.ocppVersion
299 } connector id ${connectorId} status transition from '${
300 chargingStation.getConnectorStatus(connectorId)!.status
301 }' to '${status}' is not allowed`,
304 return transitionAllowed
;
307 protected static parseJsonSchemaFile
<T
extends JsonType
>(
308 relativePath
: string,
309 ocppVersion
: OCPPVersion
,
312 ): JSONSchemaType
<T
> {
313 const filePath
= join(dirname(fileURLToPath(import.meta
.url
)), relativePath
);
315 return JSON
.parse(readFileSync(filePath
, 'utf8')) as JSONSchemaType
<T
>;
320 error
as NodeJS
.ErrnoException
,
321 OCPPServiceUtils
.logPrefix(ocppVersion
, moduleName
, methodName
),
322 { throwError
: false },
324 return {} as JSONSchemaType
<T
>;
328 protected static getSampledValueTemplate(
329 chargingStation
: ChargingStation
,
331 measurand
: MeterValueMeasurand
= MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
,
332 phase
?: MeterValuePhase
,
333 ): SampledValueTemplate
| undefined {
334 const onPhaseStr
= phase
? `on phase ${phase} ` : '';
335 if (OCPPConstants
.OCPP_MEASURANDS_SUPPORTED
.includes(measurand
) === false) {
337 `${chargingStation.logPrefix()} Trying to get unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
342 measurand
!== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
&&
345 StandardParametersKey
.MeterValuesSampledData
,
346 )?.value
?.includes(measurand
) === false
349 `${chargingStation.logPrefix()} Trying to get MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId} not found in '${
350 StandardParametersKey.MeterValuesSampledData
355 const sampledValueTemplates
: SampledValueTemplate
[] =
356 chargingStation
.getConnectorStatus(connectorId
)!.MeterValues
;
359 isNotEmptyArray(sampledValueTemplates
) === true && index
< sampledValueTemplates
.length
;
363 OCPPConstants
.OCPP_MEASURANDS_SUPPORTED
.includes(
364 sampledValueTemplates
[index
]?.measurand
??
365 MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
,
369 `${chargingStation.logPrefix()} Unsupported MeterValues measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
373 sampledValueTemplates
[index
]?.phase
=== phase
&&
374 sampledValueTemplates
[index
]?.measurand
=== measurand
&&
377 StandardParametersKey
.MeterValuesSampledData
,
378 )?.value
?.includes(measurand
) === true
380 return sampledValueTemplates
[index
];
383 !sampledValueTemplates
[index
]?.phase
&&
384 sampledValueTemplates
[index
]?.measurand
=== measurand
&&
387 StandardParametersKey
.MeterValuesSampledData
,
388 )?.value
?.includes(measurand
) === true
390 return sampledValueTemplates
[index
];
392 measurand
=== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
&&
393 (!sampledValueTemplates
[index
]?.measurand
||
394 sampledValueTemplates
[index
]?.measurand
=== measurand
)
396 return sampledValueTemplates
[index
];
399 if (measurand
=== MeterValueMeasurand
.ENERGY_ACTIVE_IMPORT_REGISTER
) {
400 const errorMsg
= `Missing MeterValues for default measurand '${measurand}' in template on connector id ${connectorId}`;
401 logger
.error(`${chargingStation.logPrefix()} ${errorMsg}`);
402 throw new BaseError(errorMsg
);
405 `${chargingStation.logPrefix()} No MeterValues for measurand '${measurand}' ${onPhaseStr}in template on connector id ${connectorId}`,
409 protected static getLimitFromSampledValueTemplateCustomValue(
412 options
?: { limitationEnabled
?: boolean; unitMultiplier
?: number },
416 limitationEnabled
: true,
421 const parsedInt
= parseInt(value
);
422 const numberValue
= isNaN(parsedInt
) ? Infinity : parsedInt
;
423 return options
?.limitationEnabled
424 ? Math.min(numberValue
* options
.unitMultiplier
!, limit
)
425 : numberValue
* options
.unitMultiplier
!;
428 private static isIdTagLocalAuthorized(chargingStation
: ChargingStation
, idTag
: string): boolean {
430 chargingStation
.hasIdTags() === true &&
432 chargingStation
.idTagsCache
433 .getIdTags(getIdTagsFile(chargingStation
.stationInfo
)!)
434 ?.find((tag
) => tag
=== idTag
),
439 private static async isIdTagRemoteAuthorized(
440 chargingStation
: ChargingStation
,
443 ): Promise
<boolean> {
444 chargingStation
.getConnectorStatus(connectorId
)!.authorizeIdTag
= idTag
;
447 await chargingStation
.ocppRequestService
.requestHandler
<
450 >(chargingStation
, RequestCommand
.AUTHORIZE
, {
453 )?.idTagInfo
?.status === AuthorizationStatus
.ACCEPTED
457 private static logPrefix
= (
458 ocppVersion
: OCPPVersion
,
463 isNotEmptyString(moduleName
) && isNotEmptyString(methodName
)
464 ? ` OCPP ${ocppVersion} | ${moduleName}.${methodName}:`
465 : ` OCPP ${ocppVersion} |`;
466 return logPrefix(logMsg
);