src/types/ChargingStationTemplate.ts

   1 import type { ClientRequestArgs } from 'node:http';
   2
   3 import type { ClientOptions } from 'ws';
   4
   5 import type {
   6   AutomaticTransactionGeneratorConfiguration,
   7   ChargingStationOcppConfiguration,
   8   ConnectorStatus,
   9   FirmwareStatus,
  10   IncomingRequestCommand,
  11   MessageTrigger,
  12   OCPPProtocol,
  13   OCPPVersion,
  14   RequestCommand,
  15 } from './internal';
  16
  17 export enum CurrentType {
  18   AC = 'AC',
  19   DC = 'DC',
  20 }
  21
  22 export enum PowerUnits {
  23   WATT = 'W',
  24   KILO_WATT = 'kW',
  25 }
  26
  27 export enum AmpereUnits {
  28   MILLI_AMPERE = 'mA',
  29   CENTI_AMPERE = 'cA',
  30   DECI_AMPERE = 'dA',
  31   AMPERE = 'A',
  32 }
  33
  34 export enum Voltage {
  35   VOLTAGE_110 = 110,
  36   VOLTAGE_230 = 230,
  37   VOLTAGE_400 = 400,
  38   VOLTAGE_800 = 800,
  39 }
  40
  41 export type WsOptions = ClientOptions & ClientRequestArgs;
  42
  43 export type FirmwareUpgrade = {
  44   versionUpgrade?: {
  45     patternGroup?: number;
  46     step?: number;
  47   };
  48   reset?: boolean;
  49   failureStatus?: FirmwareStatus;
  50 };
  51
  52 type CommandsSupport = {
  53   incomingCommands: Record<IncomingRequestCommand, boolean>;
  54   outgoingCommands?: Record<RequestCommand, boolean>;
  55 };
  56
  57 export type ChargingStationTemplate = {
  58   templateHash?: string;
  59   supervisionUrls?: string | string[];
  60   supervisionUrlOcppConfiguration?: boolean;
  61   supervisionUrlOcppKey?: string;
  62   supervisionUser?: string;
  63   supervisionPassword?: string;
  64   ocppVersion?: OCPPVersion;
  65   ocppProtocol?: OCPPProtocol;
  66   ocppStrictCompliance?: boolean;
  67   ocppPersistentConfiguration?: boolean;
  68   stationInfoPersistentConfiguration?: boolean;
  69   wsOptions?: WsOptions;
  70   // FIXME: rename to idTagFile
  71   authorizationFile?: string;
  72   baseName: string;
  73   nameSuffix?: string;
  74   fixedName?: boolean;
  75   chargePointModel: string;
  76   chargePointVendor: string;
  77   chargePointSerialNumberPrefix?: string;
  78   chargeBoxSerialNumberPrefix?: string;
  79   firmwareVersionPattern?: string;
  80   firmwareVersion?: string;
  81   firmwareUpgrade?: FirmwareUpgrade;
  82   iccid?: string;
  83   imsi?: string;
  84   meterSerialNumberPrefix?: string;
  85   meterType?: string;
  86   power: number | number[];
  87   powerSharedByConnectors?: boolean;
  88   powerUnit: PowerUnits;
  89   currentOutType?: CurrentType;
  90   voltageOut?: Voltage;
  91   numberOfPhases?: number;
  92   numberOfConnectors?: number | number[];
  93   useConnectorId0?: boolean;
  94   randomConnectors?: boolean;
  95   resetTime?: number;
  96   autoRegister?: boolean;
  97   autoReconnectMaxRetries?: number;
  98   reconnectExponentialDelay?: boolean;
  99   registrationMaxRetries?: number;
 100   enableStatistics?: boolean;
 101   mustAuthorizeAtRemoteStart?: boolean;
 102   payloadSchemaValidation?: boolean;
 103   amperageLimitationOcppKey?: string;
 104   amperageLimitationUnit?: AmpereUnits;
 105   beginEndMeterValues?: boolean;
 106   outOfOrderEndMeterValues?: boolean;
 107   meteringPerTransaction?: boolean;
 108   transactionDataMeterValues?: boolean;
 109   mainVoltageMeterValues?: boolean;
 110   phaseLineToLineVoltageMeterValues?: boolean;
 111   customValueLimitationMeterValues?: boolean;
 112   commandsSupport?: CommandsSupport;
 113   messageTriggerSupport?: Record<MessageTrigger, boolean>;
 114   Configuration?: ChargingStationOcppConfiguration;
 115   AutomaticTransactionGenerator?: AutomaticTransactionGeneratorConfiguration;
 116   Connectors: Record<string, ConnectorStatus>;
 117 };