Incoming requests payload validation with JSON schemas (#135)

[e-mobility-charging-stations-simulator.git] / src / types / ChargingStationTemplate.ts

diff --git a/src/types/ChargingStationTemplate.ts b/src/types/ChargingStationTemplate.ts
index 255fb8d0563fe83be9f1366af79745b73d4e01d2..71d84bc80056a3b477ca3f7ce03c94508ef70a72 100644 (file)
--- a/src/types/ChargingStationTemplate.ts
+++ b/src/types/ChargingStationTemplate.ts
@@ -1,48 +1,99 @@
-import ChargingStationConfiguration from './ChargingStationConfiguration';
-import Connectors from './Connectors';
+import { ClientRequestArgs } from 'http';
 
-export enum PowerOutType {
+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',
   DC = 'DC',
 }
 
-export enum PowerUnit {
+export enum PowerUnits {
   WATT = 'W',
   KILO_WATT = 'kW',
 }
 
-export interface AutomaticTransactionGenerator {
-  enable: boolean;
-  minDuration: number;
-  maxDuration: number;
-  minDelayBetweenTwoTransactions: number;
-  maxDelayBetweenTwoTransactions: number;
-  probabilityOfStart: number;
-  stopAfterHours: number;
-  stopOnConnectionFailure: boolean
+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,
+}
+
+export type WsOptions = ClientOptions & ClientRequestArgs;
+
+interface CommandsSupport {
+  incomingCommands: Record<IncomingRequestCommand, boolean>;
+  outgoingCommands?: Record<RequestCommand, boolean>;
 }
 
 export default interface ChargingStationTemplate {
-  supervisionURL?: string;
+  templateHash?: string;
+  supervisionUrls?: string | string[];
+  supervisionUrlOcppConfiguration?: boolean;
+  supervisionUrlOcppKey?: string;
+  supervisionUser?: string;
+  supervisionPassword?: string;
+  ocppVersion?: OCPPVersion;
+  ocppProtocol?: OCPPProtocol;
+  ocppStrictCompliance?: boolean;
+  ocppPersistentConfiguration?: boolean;
+  stationInfoPersistentConfiguration?: boolean;
+  wsOptions?: WsOptions;
   authorizationFile?: string;
   baseName: string;
-  fixedName?: 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: PowerUnit;
-  powerOutType?: PowerOutType;
+  powerUnit: PowerUnits;
+  currentOutType?: CurrentType;
+  voltageOut?: Voltage;
   numberOfPhases?: number;
   numberOfConnectors?: number | number[];
   useConnectorId0?: boolean;
   randomConnectors?: boolean;
   resetTime?: number;
+  autoRegister?: boolean;
+  autoReconnectMaxRetries?: number;
+  reconnectExponentialDelay?: boolean;
+  registrationMaxRetries?: number;
   enableStatistics?: boolean;
-  voltageOut?: number;
-  Configuration?: ChargingStationConfiguration;
-  AutomaticTransactionGenerator: AutomaticTransactionGenerator;
-  Connectors: Connectors;
+  mayAuthorizeAtRemoteStart?: boolean;
+  payloadSchemaValidation?: boolean;
+  amperageLimitationOcppKey?: string;
+  amperageLimitationUnit?: AmpereUnits;
+  beginEndMeterValues?: boolean;
+  outOfOrderEndMeterValues?: boolean;
+  meteringPerTransaction?: boolean;
+  transactionDataMeterValues?: boolean;
+  mainVoltageMeterValues?: boolean;
+  phaseLineToLineVoltageMeterValues?: boolean;
+  customValueLimitationMeterValues?: boolean;
+  commandsSupport?: CommandsSupport;
+  Configuration?: ChargingStationOcppConfiguration;
+  AutomaticTransactionGenerator?: AutomaticTransactionGeneratorConfiguration;
+  Connectors: Record<string, ConnectorStatus>;
 }