@citrineos/configuration
Version:
The configuration module for OCPP v2.0.1. This module is not intended to be used directly, but rather as a dependency for other modules.
183 lines • 10.8 kB
JavaScript
// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
//
// SPDX-License-Identifier: Apache-2.0
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
import { Logger } from 'tslog';
import { ConfigurationModule } from '../module.js';
import { AbstractModuleApi, AsMessageEndpoint, DEFAULT_TENANT_ID, OCPP2_0_1, OCPP2_0_1_CallAction, OCPPVersion, } from '@citrineos/base';
import { SetNetworkProfile } from '@citrineos/data';
import { validateLanguageTag } from '@citrineos/util';
import { v4 as uuidv4 } from 'uuid';
var SetNetworkProfileExtraQuerystrings;
(function (SetNetworkProfileExtraQuerystrings) {
SetNetworkProfileExtraQuerystrings["websocketServerConfigId"] = "websocketServerConfigId";
})(SetNetworkProfileExtraQuerystrings || (SetNetworkProfileExtraQuerystrings = {}));
/**
* Server API for the Configuration component.
*/
export class ConfigurationOcpp201Api extends AbstractModuleApi {
/**
* Constructor for the class.
*
* @param {ConfigurationModule} ConfigurationComponent - The Configuration component.
* @param {FastifyInstance} server - The server instance.
* @param {Logger<ILogObj>} [logger] - Optional logger instance.
*/
constructor(ConfigurationComponent, server, logger) {
super(ConfigurationComponent, server, OCPPVersion.OCPP2_0_1, logger);
}
async setNetworkProfile(identifier, request, callbackUrl, extraQueries, tenantId = DEFAULT_TENANT_ID) {
const correlationId = uuidv4();
if (extraQueries) {
const websocketServerConfigId = extraQueries[SetNetworkProfileExtraQuerystrings.websocketServerConfigId];
await SetNetworkProfile.build({
stationId: identifier,
tenantId,
correlationId,
configurationSlot: request.configurationSlot,
websocketServerConfigId,
apn: JSON.stringify(request.connectionData.apn),
vpn: JSON.stringify(request.connectionData.vpn),
...request.connectionData,
}).save();
}
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.SetNetworkProfile, request, callbackUrl, correlationId));
return Promise.all(results);
}
clearDisplayMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.ClearDisplayMessage, request, callbackUrl));
return Promise.all(results);
}
getDisplayMessages(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.GetDisplayMessages, request, callbackUrl));
return Promise.all(results);
}
publishFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.PublishFirmware, request, callbackUrl));
return Promise.all(results);
}
async setDisplayMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const messageInfo = request.message;
const languageTag = messageInfo.message.language;
if (languageTag && !validateLanguageTag(languageTag)) {
const errorMsg = 'Language shall be specified as RFC-5646 tags, example: en-US for US English.';
this._logger.error(errorMsg);
return [{ success: false, payload: errorMsg }];
}
// If omitted, startDateTime defaults to "now".
if (!messageInfo.startDateTime) {
messageInfo.startDateTime = new Date().toISOString();
}
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.SetDisplayMessage, request, callbackUrl));
return Promise.all(results);
}
unpublishFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.UnpublishFirmware, request, callbackUrl));
return Promise.all(results);
}
updateFirmware(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.UpdateFirmware, request, callbackUrl));
return Promise.all(results);
}
reset(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.Reset, request, callbackUrl));
return Promise.all(results);
}
changeAvailability(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.ChangeAvailability, request, callbackUrl));
return Promise.all(results);
}
triggerMessage(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.TriggerMessage, request, callbackUrl));
return Promise.all(results);
}
dataTransfer(identifier, request, callbackUrl, tenantId = DEFAULT_TENANT_ID) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, OCPPVersion.OCPP2_0_1, OCPP2_0_1_CallAction.DataTransfer, request, callbackUrl));
return Promise.all(results);
}
/**
* Overrides superclass method to generate the URL path based on the input {@link CallAction} and the module's endpoint prefix configuration.
*
* @param {CallAction} input - The input {@link CallAction}.
* @return {string} - The generated URL path.
*/
_toMessagePath(input) {
const endpointPrefix = this._module.config.modules.configuration.endpointPrefix;
return super._toMessagePath(input, endpointPrefix);
}
}
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.SetNetworkProfile, OCPP2_0_1.SetNetworkProfileRequestSchema, { websocketServerConfigId: { type: 'string' } }),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Object, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "setNetworkProfile", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.ClearDisplayMessage, OCPP2_0_1.ClearDisplayMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "clearDisplayMessage", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.GetDisplayMessages, OCPP2_0_1.GetDisplayMessagesRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "getDisplayMessages", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.PublishFirmware, OCPP2_0_1.PublishFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "publishFirmware", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.SetDisplayMessage, OCPP2_0_1.SetDisplayMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "setDisplayMessage", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.UnpublishFirmware, OCPP2_0_1.UnpublishFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "unpublishFirmware", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.UpdateFirmware, OCPP2_0_1.UpdateFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "updateFirmware", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.Reset, OCPP2_0_1.ResetRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "reset", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.ChangeAvailability, OCPP2_0_1.ChangeAvailabilityRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "changeAvailability", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.TriggerMessage, OCPP2_0_1.TriggerMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "triggerMessage", null);
__decorate([
AsMessageEndpoint(OCPP2_0_1_CallAction.DataTransfer, OCPP2_0_1.DataTransferRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, Object, String, Number]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "dataTransfer", null);
//# sourceMappingURL=MessageApi.js.map