@zetra/citrineos-configuration 1.8.3-fork.1

package/dist/module/DeviceModelService.js

@@ -0,0 +1,122 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { OCPP2_0_1 } from '@citrineos/base';
+import { VariableAttribute } from '@citrineos/data';
+export class DeviceModelService {
+    _deviceModelRepository;
+    constructor(deviceModelRepository) {
+        this._deviceModelRepository = deviceModelRepository;
+    }
+    /**
+     * Fetches the ItemsPerMessageSetVariables attribute from the device model.
+     * Returns null if no such attribute exists.
+     * It is possible for there to be multiple ItemsPerMessageSetVariables attributes if component instances or evses
+     * are associated with alternate options. That structure is not supported by this logic, and that
+     * structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+     * In that case, the first attribute will be returned.
+     * @param tenantId
+     * @param stationId Charging station identifier.
+     * @returns ItemsPerMessageSetVariables as a number or null if no such attribute exists.
+     */
+    async getItemsPerMessageSetVariablesByStationId(tenantId, stationId) {
+        const itemsPerMessageSetVariablesAttributes = await this._deviceModelRepository.readAllByQuerystring(tenantId, {
+            tenantId: tenantId,
+            stationId: stationId,
+            component_name: 'DeviceDataCtrlr',
+            variable_name: 'ItemsPerMessage',
+            variable_instance: 'SetVariables',
+            type: OCPP2_0_1.AttributeEnumType.Actual,
+        });
+        if (itemsPerMessageSetVariablesAttributes.length === 0) {
+            return null;
+        }
+        else {
+            // It is possible for itemsPerMessageSetVariablesAttributes.length > 1 if component instances or evses
+            // are associated with alternate options. That structure is not supported by this logic, and that
+            // structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+            return Number(itemsPerMessageSetVariablesAttributes[0].value);
+        }
+    }
+    /**
+     * Fetches the ItemsPerMessageGetVariables attribute from the device model.
+     * Returns null if no such attribute exists.
+     * It is possible for there to be multiple ItemsPerMessageGetVariables attributes if component instances or evses
+     * are associated with alternate options. That structure is not supported by this logic, and that
+     * structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+     * In that case, the first attribute will be returned.
+     * @param tenantId
+     * @param stationId Charging station identifier.
+     * @returns ItemsPerMessageGetVariables as a number or null if no such attribute exists.
+     */
+    async getItemsPerMessageGetVariablesByStationId(tenantId, stationId) {
+        const itemsPerMessageGetVariablesAttributes = await this._deviceModelRepository.readAllByQuerystring(tenantId, {
+            tenantId: tenantId,
+            stationId: stationId,
+            component_name: 'DeviceDataCtrlr',
+            variable_name: 'ItemsPerMessage',
+            variable_instance: 'GetVariables',
+            type: OCPP2_0_1.AttributeEnumType.Actual,
+        });
+        if (itemsPerMessageGetVariablesAttributes.length === 0) {
+            return null;
+        }
+        else {
+            // It is possible for itemsPerMessageGetVariablesAttributes.length > 1 if component instances or evses
+            // are associated with alternate options. That structure is not supported by this logic, and that
+            // structure is a violation of Part 2 - Specification of OCPP 2.0.1.
+            return Number(itemsPerMessageGetVariablesAttributes[0].value);
+        }
+    }
+    async updateDeviceModel(chargingStation, tenantId, stationId, timestamp) {
+        const attributes = [
+            {
+                component: 'ChargingStation',
+                variable: 'Model',
+                value: chargingStation.model,
+            },
+            {
+                component: 'ChargingStation',
+                variable: 'VendorName',
+                value: chargingStation.vendorName,
+            },
+            {
+                component: 'Controller',
+                variable: 'FirmwareVersion',
+                value: chargingStation.firmwareVersion,
+            },
+            {
+                component: 'ChargingStation',
+                variable: 'SerialNumber',
+                value: chargingStation.serialNumber,
+            },
+            {
+                component: 'DataLink',
+                variable: 'IMSI',
+                value: chargingStation.modem?.imsi,
+            },
+            {
+                component: 'DataLink',
+                variable: 'ICCID',
+                value: chargingStation.modem?.iccid,
+            },
+        ];
+        const promises = attributes
+            .filter((attr) => attr.value !== undefined)
+            .map((attr) => this._deviceModelRepository.createOrUpdateDeviceModelByStationId(tenantId, {
+            component: { name: attr.component },
+            variable: { name: attr.variable },
+            variableAttribute: [
+                {
+                    type: OCPP2_0_1.AttributeEnumType.Actual,
+                    value: attr.value,
+                    mutability: OCPP2_0_1.MutabilityEnumType.ReadOnly,
+                    persistent: true,
+                    constant: true,
+                },
+            ],
+        }, stationId, timestamp));
+        await Promise.all(promises);
+    }
+}
+//# sourceMappingURL=DeviceModelService.js.map

package/dist/module/DeviceModelService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceModelService.js","sourceRoot":"","sources":["../../src/module/DeviceModelService.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,OAAO,kBAAkB;IACnB,sBAAsB,CAAyB;IAEzD,YAAY,qBAA6C;QACvD,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;IACtD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,yCAAyC,CAC7C,QAAgB,EAChB,SAAiB;QAEjB,MAAM,qCAAqC,GACzC,MAAM,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,EAAE;YAC/D,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,SAAS;YACpB,cAAc,EAAE,iBAAiB;YACjC,aAAa,EAAE,iBAAiB;YAChC,iBAAiB,EAAE,cAAc;YACjC,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,MAAM;SACzC,CAAC,CAAC;QACL,IAAI,qCAAqC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,sGAAsG;YACtG,iGAAiG;YACjG,oEAAoE;YACpE,OAAO,MAAM,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,yCAAyC,CAC7C,QAAgB,EAChB,SAAiB;QAEjB,MAAM,qCAAqC,GACzC,MAAM,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,QAAQ,EAAE;YAC/D,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,SAAS;YACpB,cAAc,EAAE,iBAAiB;YACjC,aAAa,EAAE,iBAAiB;YAChC,iBAAiB,EAAE,cAAc;YACjC,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,MAAM;SACzC,CAAC,CAAC;QACL,IAAI,qCAAqC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,sGAAsG;YACtG,iGAAiG;YACjG,oEAAoE;YACpE,OAAO,MAAM,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,eAAoB,EACpB,QAAgB,EAChB,SAAiB,EACjB,SAAiB;QAEjB,MAAM,UAAU,GAAG;YACjB;gBACE,SAAS,EAAE,iBAAiB;gBAC5B,QAAQ,EAAE,OAAO;gBACjB,KAAK,EAAE,eAAe,CAAC,KAAK;aAC7B;YACD;gBACE,SAAS,EAAE,iBAAiB;gBAC5B,QAAQ,EAAE,YAAY;gBACtB,KAAK,EAAE,eAAe,CAAC,UAAU;aAClC;YACD;gBACE,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,iBAAiB;gBAC3B,KAAK,EAAE,eAAe,CAAC,eAAe;aACvC;YACD;gBACE,SAAS,EAAE,iBAAiB;gBAC5B,QAAQ,EAAE,cAAc;gBACxB,KAAK,EAAE,eAAe,CAAC,YAAY;aACpC;YACD;gBACE,SAAS,EAAE,UAAU;gBACrB,QAAQ,EAAE,MAAM;gBAChB,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI;aACnC;YACD;gBACE,SAAS,EAAE,UAAU;gBACrB,QAAQ,EAAE,OAAO;gBACjB,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK;aACpC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,UAAU;aACxB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC;aAC1C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,sBAAsB,CAAC,oCAAoC,CAC9D,QAAQ,EACR;YACE,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE;YACnC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACjC,iBAAiB,EAAE;gBACjB;oBACE,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC,MAAM;oBACxC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,UAAU,EAAE,SAAS,CAAC,kBAAkB,CAAC,QAAQ;oBACjD,UAAU,EAAE,IAAI;oBAChB,QAAQ,EAAE,IAAI;iBACf;aACF;SACF,EACD,SAAS,EACT,SAAS,CACV,CACF,CAAC;QAEJ,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;CACF"}

package/dist/module/interface.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Interface for the Configuration module.
+ */
+export interface IConfigurationModuleApi {
+}

package/dist/module/interface.js

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export {};
+//# sourceMappingURL=interface.js.map

package/dist/module/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../src/module/interface.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC"}

package/dist/module/module.d.ts

@@ -0,0 +1,110 @@
+import type { BootstrapConfig, CallAction, HandlerProperties, ICache, IMessage, IMessageHandler, IMessageSender, SystemConfig } from '@citrineos/base';
+import { AbstractModule, OCPP1_6, OCPP2_0_1, OCPPValidator } from '@citrineos/base';
+import type { IBootRepository, IChangeConfigurationRepository, IDeviceModelRepository, ILocationRepository, IMessageInfoRepository, IOCPPMessageRepository, ITenantRepository } from '@citrineos/data';
+import { IdGenerator } from '@citrineos/util';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+import { BootNotificationService } from './BootNotificationService.js';
+import { DeviceModelService } from './DeviceModelService.js';
+/**
+ * Component that handles Configuration related messages.
+ */
+export declare class ConfigurationModule extends AbstractModule {
+    _deviceModelService: DeviceModelService;
+    _requests: CallAction[];
+    _responses: CallAction[];
+    protected _bootService: BootNotificationService;
+    private _idGenerator;
+    /**
+     * This is the constructor function that initializes the {@link ConfigurationModule}.
+     *
+     * @param {BootstrapConfig & SystemConfig} config - The `config` contains configuration settings for the module.
+     *
+     * @param {ICache} [cache] - The cache instance which is shared among the modules & Central System to pass information such as blacklisted actions or boot status.
+     *
+     * @param {IMessageSender} [sender] - The `sender` parameter is an optional parameter that represents an instance of the {@link IMessageSender} interface.
+     * It is used to send messages from the central system to external systems or devices. If no `sender` is provided, a default {@link RabbitMqSender} instance is created and used.
+     *
+     * @param {IMessageHandler} [handler] - The `handler` parameter is an optional parameter that represents an instance of the {@link IMessageHandler} interface.
+     * It is used to handle incoming messages and dispatch them to the appropriate methods or functions. If no `handler` is provided, a default {@link RabbitMqReceiver} instance is created and used.
+     *
+     * @param {Logger<ILogObj>} [logger] - The `logger` parameter is an optional parameter that represents an instance of {@link Logger<ILogObj>}.
+     * It is used to propagate system-wide logger settings and will serve as the parent logger for any subcomponent logging. If no `logger` is provided, a default {@link Logger<ILogObj>} instance is created and used.
+     *
+     * @param {IBootRepository} [bootRepository] - An optional parameter of type {@link IBootRepository} which represents a repository for accessing and manipulating authorization data.
+     * If no `bootRepository` is provided, a default {@link SequelizeBootRepository} instance is created and used.
+     *
+     * @param {IDeviceModelRepository} [deviceModelRepository] - An optional parameter of type {@link IDeviceModelRepository} which represents a repository for accessing and manipulating variable data.
+     * If no `deviceModelRepository` is provided, a default {@link sequelize:deviceModelRepository} instance is created and used.
+     *
+     * @param {IMessageInfoRepository} [messageInfoRepository] - An optional parameter of type {@link messageInfoRepository} which
+     * represents a repository for accessing and manipulating message info data. If no `messageInfoRepository` is provided, a default
+     * {@link SequelizeMessageInfoRepository} instance is created and used.
+     *
+     * @param {ILocationRepository} [locationRepository] - An optional parameter of type {@link locationRepository} which
+     * represents a repository for accessing and manipulating location data. If no `locationRepository` is provided, a default
+     * {@link SequelizeLocationRepository} instance is created and used.
+     *
+     * @param {IChangeConfigurationRepository} [changeConfigurationRepository] - An optional parameter of type {@link IChangeConfigurationRepository} which
+     * represents a repository for accessing and manipulating change configuration data. If no `changeConfigurationRepository` is provided, a default
+     * {@link SequelizeChangeConfigurationRepository} instance is created and used.
+     *
+     * @param {IOCPPMessageRepository} [ocppMessageRepository] - An optional parameter of type {@link IOCPPMessageRepository} which
+     * represents a repository for accessing and manipulating call message data. If no `ocppMessageRepository` is provided, a default
+     * {@link SequelizeOCPPMessageRepository} instance is created and used.
+     *
+     * @param {IdGenerator} [idGenerator] - An optional parameter of type {@link IdGenerator} which
+     * represents a generator for ids.
+     *
+     *If no `deviceModelRepository` is provided, a default {@link sequelize:messageInfoRepository} instance is created and used.
+     */
+    constructor(config: BootstrapConfig & SystemConfig, cache: ICache, sender?: IMessageSender, handler?: IMessageHandler, logger?: Logger<ILogObj>, ocppValidator?: OCPPValidator, bootRepository?: IBootRepository, deviceModelRepository?: IDeviceModelRepository, messageInfoRepository?: IMessageInfoRepository, locationRepository?: ILocationRepository, changeConfigurationRepository?: IChangeConfigurationRepository, ocppMessageRepository?: IOCPPMessageRepository, idGenerator?: IdGenerator, tenantRepository?: ITenantRepository);
+    protected _tenantRepository: ITenantRepository;
+    get tenantRepository(): ITenantRepository;
+    protected _bootRepository: IBootRepository;
+    get bootRepository(): IBootRepository;
+    protected _deviceModelRepository: IDeviceModelRepository;
+    get deviceModelRepository(): IDeviceModelRepository;
+    protected _messageInfoRepository: IMessageInfoRepository;
+    get messageInfoRepository(): IMessageInfoRepository;
+    protected _locationRepository: ILocationRepository;
+    get locationRepository(): ILocationRepository;
+    protected _changeConfigurationRepository: IChangeConfigurationRepository;
+    get changeConfigurationRepository(): IChangeConfigurationRepository;
+    protected _ocppMessageRepository: IOCPPMessageRepository;
+    get ocppMessageRepository(): IOCPPMessageRepository;
+    /**
+     * Handle OCPP 2.0.1 requests
+     */
+    protected _handleBootNotification(message: IMessage<OCPP2_0_1.BootNotificationRequest>, props?: HandlerProperties): Promise<void>;
+    protected _handleHeartbeat(message: IMessage<OCPP2_0_1.HeartbeatRequest>, props?: HandlerProperties): Promise<void>;
+    protected _handleNotifyDisplayMessages(message: IMessage<OCPP2_0_1.NotifyDisplayMessagesRequest>, props?: HandlerProperties): Promise<void>;
+    protected _handleFirmwareStatusNotification(message: IMessage<OCPP2_0_1.FirmwareStatusNotificationRequest>, props?: HandlerProperties): Promise<void>;
+    protected _handleDataTransfer(message: IMessage<OCPP2_0_1.DataTransferRequest>, props?: HandlerProperties): Promise<void>;
+    /**
+     * Handle OCPP 2.0.1 responses
+     */
+    protected _handleChangeAvailability(message: IMessage<OCPP2_0_1.ChangeAvailabilityResponse>, props?: HandlerProperties): void;
+    protected _handleSetNetworkProfile(message: IMessage<OCPP2_0_1.SetNetworkProfileResponse>, props?: HandlerProperties): Promise<void>;
+    protected _handleGetDisplayMessages(message: IMessage<OCPP2_0_1.GetDisplayMessagesResponse>, props?: HandlerProperties): void;
+    protected _handleSetDisplayMessage(message: IMessage<OCPP2_0_1.SetDisplayMessageResponse>, props?: HandlerProperties): Promise<void>;
+    protected _handlePublishFirmware(message: IMessage<OCPP2_0_1.PublishFirmwareResponse>, props?: HandlerProperties): void;
+    protected _handleUnpublishFirmware(message: IMessage<OCPP2_0_1.UnpublishFirmwareResponse>, props?: HandlerProperties): void;
+    protected _handleUpdateFirmware(message: IMessage<OCPP2_0_1.UpdateFirmwareResponse>, props?: HandlerProperties): void;
+    protected _handleReset(message: IMessage<OCPP2_0_1.ResetResponse>, props?: HandlerProperties): void;
+    protected _handleTriggerMessage(message: IMessage<OCPP2_0_1.TriggerMessageResponse>, props?: HandlerProperties): void;
+    protected _handleClearDisplayMessage(message: IMessage<OCPP2_0_1.ClearDisplayMessageResponse>, props?: HandlerProperties): Promise<void>;
+    /**
+     * Handle OCPP 1.6 requests
+     */
+    protected _handle16Heartbeat(message: IMessage<OCPP1_6.HeartbeatRequest>, props?: HandlerProperties): Promise<void>;
+    protected _handleOcpp16BootNotification(message: IMessage<OCPP1_6.BootNotificationRequest>, props?: HandlerProperties): Promise<void>;
+    /**
+     * Handle OCPP 1.6 response
+     */
+    protected _handleOcpp16GetConfiguration(message: IMessage<OCPP1_6.GetConfigurationResponse>, props?: HandlerProperties): Promise<void>;
+    protected _handleOcpp16ChangeConfiguration(message: IMessage<OCPP1_6.ChangeConfigurationResponse>, props?: HandlerProperties): Promise<void>;
+    protected _handleOcpp16TriggerMessage(message: IMessage<OCPP1_6.TriggerMessageResponse>, props?: HandlerProperties): void;
+    protected _handle16Reset(message: IMessage<OCPP1_6.ResetResponse>, props?: HandlerProperties): void;
+    protected _handleOcpp16ChangeAvailability(message: IMessage<OCPP1_6.ChangeAvailabilityResponse>, props?: HandlerProperties): void;
+}