Incoming requests payload validation with JSON schemas (#135)
[e-mobility-charging-stations-simulator.git] / src / types / ChargingStationTemplate.ts
index 309120b6dff966e77eb18c3065dc13406f878846..71d84bc80056a3b477ca3f7ce03c94508ef70a72 100644 (file)
@@ -1,9 +1,13 @@
-import ChargingStationConfiguration from './ChargingStationConfiguration';
-import { ClientOptions } from 'ws';
 import { ClientRequestArgs } from 'http';
+
+import { ClientOptions } from 'ws';
+
+import { AutomaticTransactionGeneratorConfiguration } from './AutomaticTransactionGenerator';
+import ChargingStationOcppConfiguration from './ChargingStationOcppConfiguration';
 import { ConnectorStatus } from './ConnectorStatus';
 import { OCPPProtocol } from './ocpp/OCPPProtocol';
 import { OCPPVersion } from './ocpp/OCPPVersion';
+import { IncomingRequestCommand, RequestCommand } from './ocpp/Requests';
 
 export enum CurrentType {
   AC = 'AC',
@@ -15,26 +19,29 @@ 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,
   VOLTAGE_400 = 400,
-  VOLTAGE_800 = 800
+  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;
+
+interface CommandsSupport {
+  incomingCommands: Record<IncomingRequestCommand, boolean>;
+  outgoingCommands?: Record<RequestCommand, boolean>;
 }
 
 export default interface ChargingStationTemplate {
+  templateHash?: string;
   supervisionUrls?: string | string[];
   supervisionUrlOcppConfiguration?: boolean;
   supervisionUrlOcppKey?: string;
@@ -43,15 +50,22 @@ export default interface ChargingStationTemplate {
   ocppVersion?: OCPPVersion;
   ocppProtocol?: OCPPProtocol;
   ocppStrictCompliance?: boolean;
-  wsOptions?: ClientOptions & ClientRequestArgs;
+  ocppPersistentConfiguration?: boolean;
+  stationInfoPersistentConfiguration?: boolean;
+  wsOptions?: WsOptions;
   authorizationFile?: string;
   baseName: string;
   nameSuffix?: string;
   fixedName?: boolean;
   chargePointModel: string;
   chargePointVendor: string;
+  chargePointSerialNumberPrefix?: string;
   chargeBoxSerialNumberPrefix?: string;
   firmwareVersion?: string;
+  iccid?: string;
+  imsi?: string;
+  meterSerialNumberPrefix?: string;
+  meterType?: string;
   power: number | number[];
   powerSharedByConnectors?: boolean;
   powerUnit: PowerUnits;
@@ -62,19 +76,24 @@ export default interface ChargingStationTemplate {
   useConnectorId0?: boolean;
   randomConnectors?: boolean;
   resetTime?: number;
-  autoRegister: boolean;
+  autoRegister?: boolean;
   autoReconnectMaxRetries?: number;
   reconnectExponentialDelay?: boolean;
   registrationMaxRetries?: number;
   enableStatistics?: boolean;
-  mayAuthorizeAtRemoteStart: boolean;
+  mayAuthorizeAtRemoteStart?: 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;
+  Configuration?: ChargingStationOcppConfiguration;
+  AutomaticTransactionGenerator?: AutomaticTransactionGeneratorConfiguration;
   Connectors: Record<string, ConnectorStatus>;
 }