@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.
179 lines • 11.1 kB
JavaScript
;
// Copyright 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);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConfigurationOcpp201Api = void 0;
const base_1 = require("@citrineos/base");
const data_1 = require("@citrineos/data");
const util_1 = require("@citrineos/util");
const uuid_1 = require("uuid");
var SetNetworkProfileExtraQuerystrings;
(function (SetNetworkProfileExtraQuerystrings) {
SetNetworkProfileExtraQuerystrings["websocketServerConfigId"] = "websocketServerConfigId";
})(SetNetworkProfileExtraQuerystrings || (SetNetworkProfileExtraQuerystrings = {}));
/**
* Server API for the Configuration component.
*/
class ConfigurationOcpp201Api extends base_1.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, base_1.OCPPVersion.OCPP2_0_1, logger);
}
setNetworkProfile(identifier, tenantId, request, callbackUrl, extraQueries) {
return __awaiter(this, void 0, void 0, function* () {
const correlationId = (0, uuid_1.v4)();
if (extraQueries) {
const websocketServerConfigId = extraQueries[SetNetworkProfileExtraQuerystrings.websocketServerConfigId];
yield data_1.SetNetworkProfile.build(Object.assign({ stationId: identifier, 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, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.SetNetworkProfile, request, callbackUrl, correlationId));
return Promise.all(results);
});
}
clearDisplayMessage(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.ClearDisplayMessage, request, callbackUrl));
return Promise.all(results);
}
getDisplayMessages(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.GetDisplayMessages, request, callbackUrl));
return Promise.all(results);
}
publishFirmware(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.PublishFirmware, request, callbackUrl));
return Promise.all(results);
}
setDisplayMessage(identifier, tenantId, request, callbackUrl) {
return __awaiter(this, void 0, void 0, function* () {
const messageInfo = request.message;
const languageTag = messageInfo.message.language;
if (languageTag && !(0, util_1.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, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.SetDisplayMessage, request, callbackUrl));
return Promise.all(results);
});
}
unpublishFirmware(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.UnpublishFirmware, request, callbackUrl));
return Promise.all(results);
}
updateFirmware(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.UpdateFirmware, request, callbackUrl));
return Promise.all(results);
}
reset(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.Reset, request, callbackUrl));
return Promise.all(results);
}
changeAvailability(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.ChangeAvailability, request, callbackUrl));
return Promise.all(results);
}
triggerMessage(identifier, tenantId, request, callbackUrl) {
const results = identifier.map((id) => this._module.sendCall(id, tenantId, base_1.OCPPVersion.OCPP2_0_1, base_1.OCPP2_0_1_CallAction.TriggerMessage, 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);
}
}
exports.ConfigurationOcpp201Api = ConfigurationOcpp201Api;
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.SetNetworkProfile, base_1.OCPP2_0_1.SetNetworkProfileRequestSchema, { websocketServerConfigId: { type: 'string' } }),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String, Object]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "setNetworkProfile", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.ClearDisplayMessage, base_1.OCPP2_0_1.ClearDisplayMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "clearDisplayMessage", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.GetDisplayMessages, base_1.OCPP2_0_1.GetDisplayMessagesRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "getDisplayMessages", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.PublishFirmware, base_1.OCPP2_0_1.PublishFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "publishFirmware", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.SetDisplayMessage, base_1.OCPP2_0_1.SetDisplayMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "setDisplayMessage", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.UnpublishFirmware, base_1.OCPP2_0_1.UnpublishFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "unpublishFirmware", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.UpdateFirmware, base_1.OCPP2_0_1.UpdateFirmwareRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "updateFirmware", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.Reset, base_1.OCPP2_0_1.ResetRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "reset", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.ChangeAvailability, base_1.OCPP2_0_1.ChangeAvailabilityRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "changeAvailability", null);
__decorate([
(0, base_1.AsMessageEndpoint)(base_1.OCPP2_0_1_CallAction.TriggerMessage, base_1.OCPP2_0_1.TriggerMessageRequestSchema),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Array, String, Object, String]),
__metadata("design:returntype", Promise)
], ConfigurationOcpp201Api.prototype, "triggerMessage", null);
//# sourceMappingURL=MessageApi.js.map