Implement firmwareUpgrade CS template section support
[e-mobility-charging-stations-simulator.git] / src / types / ChargingStationTemplate.ts
index ee7df49a0ab2e7220c540c6b04edee3cee965199..99b43765232fde1a66428745d7b411b5d0af89f7 100644 (file)
@@ -1,9 +1,18 @@
-import ChargingStationConfiguration from './ChargingStationConfiguration';
-import { ClientOptions } from 'ws';
-import { ClientRequestArgs } from 'http';
-import { ConnectorStatus } from './ConnectorStatus';
-import { OCPPProtocol } from './ocpp/OCPPProtocol';
-import { OCPPVersion } from './ocpp/OCPPVersion';
+import type { ClientRequestArgs } from 'http';
+
+import type { ClientOptions } from 'ws';
+
+import type { AutomaticTransactionGeneratorConfiguration } from './AutomaticTransactionGenerator';
+import type { ChargingStationOcppConfiguration } from './ChargingStationOcppConfiguration';
+import type { ConnectorStatus } from './ConnectorStatus';
+import type { OCPPProtocol } from './ocpp/OCPPProtocol';
+import type { OCPPVersion } from './ocpp/OCPPVersion';
+import type {
+  FirmwareStatus,
+  IncomingRequestCommand,
+  MessageTrigger,
+  RequestCommand,
+} from './ocpp/Requests';
 
 export enum CurrentType {
   AC = 'AC',
@@ -15,6 +24,13 @@ export enum PowerUnits {
   KILO_WATT = 'kW',
 }
 
+export enum AmpereUnits {
+  MILLI_AMPERE = 'mA',
+  CENTI_AMPERE = 'cA',
+  DECI_AMPERE = 'dA',
+  AMPERE = 'A',
+}
+
 export enum Voltage {
   VOLTAGE_110 = 110,
   VOLTAGE_230 = 230,
@@ -22,19 +38,24 @@ export enum Voltage {
   VOLTAGE_800 = 800,
 }
 
-export interface AutomaticTransactionGenerator {
-  enable: boolean;
-  minDuration: number;
-  maxDuration: number;
-  minDelayBetweenTwoTransactions: number;
-  maxDelayBetweenTwoTransactions: number;
-  probabilityOfStart: number;
-  stopAfterHours: number;
-  stopOnConnectionFailure: boolean;
-  requireAuthorize?: boolean;
-}
+export type WsOptions = ClientOptions & ClientRequestArgs;
+
+export type FirmwareUpgrade = {
+  versionUpgrade: {
+    patternGroup?: number;
+    step?: number;
+  };
+  reset?: boolean;
+  failureStatus?: FirmwareStatus;
+};
 
-export default interface ChargingStationTemplate {
+type CommandsSupport = {
+  incomingCommands: Record<IncomingRequestCommand, boolean>;
+  outgoingCommands?: Record<RequestCommand, boolean>;
+};
+
+export type ChargingStationTemplate = {
+  templateHash?: string;
   supervisionUrls?: string | string[];
   supervisionUrlOcppConfiguration?: boolean;
   supervisionUrlOcppKey?: string;
@@ -44,18 +65,22 @@ export default interface ChargingStationTemplate {
   ocppProtocol?: OCPPProtocol;
   ocppStrictCompliance?: boolean;
   ocppPersistentConfiguration?: boolean;
-  wsOptions?: ClientOptions & ClientRequestArgs;
+  stationInfoPersistentConfiguration?: boolean;
+  wsOptions?: WsOptions;
   authorizationFile?: string;
   baseName: string;
   nameSuffix?: string;
   fixedName?: boolean;
   chargePointModel: string;
   chargePointVendor: string;
+  chargePointSerialNumberPrefix?: string;
   chargeBoxSerialNumberPrefix?: string;
+  firmwareVersionPattern?: string;
   firmwareVersion?: string;
+  firmwareUpgrade?: FirmwareUpgrade;
   iccid?: string;
   imsi?: string;
-  meterSerialNumber?: string;
+  meterSerialNumberPrefix?: string;
   meterType?: string;
   power: number | number[];
   powerSharedByConnectors?: boolean;
@@ -67,19 +92,25 @@ export default interface ChargingStationTemplate {
   useConnectorId0?: boolean;
   randomConnectors?: boolean;
   resetTime?: number;
-  autoRegister: boolean;
+  autoRegister?: boolean;
   autoReconnectMaxRetries?: number;
   reconnectExponentialDelay?: boolean;
   registrationMaxRetries?: number;
   enableStatistics?: boolean;
-  mayAuthorizeAtRemoteStart: boolean;
+  mustAuthorizeAtRemoteStart?: boolean;
+  payloadSchemaValidation?: boolean;
+  amperageLimitationOcppKey?: string;
+  amperageLimitationUnit?: AmpereUnits;
   beginEndMeterValues?: boolean;
   outOfOrderEndMeterValues?: boolean;
   meteringPerTransaction?: boolean;
   transactionDataMeterValues?: boolean;
   mainVoltageMeterValues?: boolean;
   phaseLineToLineVoltageMeterValues?: boolean;
-  Configuration?: ChargingStationConfiguration;
-  AutomaticTransactionGenerator: AutomaticTransactionGenerator;
+  customValueLimitationMeterValues?: boolean;
+  commandsSupport?: CommandsSupport;
+  messageTriggerSupport?: Record<MessageTrigger, boolean>;
+  Configuration?: ChargingStationOcppConfiguration;
+  AutomaticTransactionGenerator?: AutomaticTransactionGeneratorConfiguration;
   Connectors: Record<string, ConnectorStatus>;
-}
+};