src/types/ocpp/1.6/Requests.ts

   1 import { ChargingProfilePurposeType, OCPP16ChargingProfile } from './ChargingProfile';
   2
   3 import { OCPP16ChargePointErrorCode } from './ChargePointErrorCode';
   4 import { OCPP16ChargePointStatus } from './ChargePointStatus';
   5 import { OCPP16DiagnosticsStatus } from './DiagnosticsStatus';
   6 import { OCPP16StandardParametersKey } from './Configuration';
   7
   8 export enum OCPP16RequestCommand {
   9   BOOT_NOTIFICATION = 'BootNotification',
  10   HEARTBEAT = 'Heartbeat',
  11   STATUS_NOTIFICATION = 'StatusNotification',
  12   CHANGE_CONFIGURATION = 'ChangeConfiguration',
  13   AUTHORIZE = 'Authorize',
  14   START_TRANSACTION = 'StartTransaction',
  15   STOP_TRANSACTION = 'StopTransaction',
  16   METER_VALUES = 'MeterValues',
  17   DIAGNOSTICS_STATUS_NOTIFICATION = 'DiagnosticsStatusNotification'
  18 }
  19
  20 export enum OCPP16IncomingRequestCommand {
  21   RESET = 'Reset',
  22   CLEAR_CACHE = 'ClearCache',
  23   CHANGE_AVAILABILITY = 'ChangeAvailability',
  24   UNLOCK_CONNECTOR = 'UnlockConnector',
  25   GET_CONFIGURATION = 'GetConfiguration',
  26   CHANGE_CONFIGURATION = 'ChangeConfiguration',
  27   SET_CHARGING_PROFILE = 'SetChargingProfile',
  28   CLEAR_CHARGING_PROFILE = 'ClearChargingProfile',
  29   REMOTE_START_TRANSACTION = 'RemoteStartTransaction',
  30   REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction',
  31   GET_DIAGNOSTICS = 'GetDiagnostics',
  32   TRIGGER_MESSAGE = 'TriggerMessage'
  33 }
  34
  35 // eslint-disable-next-line @typescript-eslint/no-empty-interface
  36 export interface HeartbeatRequest { }
  37
  38 export interface OCPP16BootNotificationRequest {
  39   chargeBoxSerialNumber?: string;
  40   chargePointModel: string;
  41   chargePointSerialNumber?: string;
  42   chargePointVendor: string;
  43   firmwareVersion?: string;
  44   iccid?: string;
  45   imsi?: string;
  46   meterSerialNumber?: string;
  47   meterType?: string;
  48 }
  49
  50 export interface StatusNotificationRequest {
  51   connectorId: number;
  52   errorCode: OCPP16ChargePointErrorCode;
  53   info?: string;
  54   status: OCPP16ChargePointStatus;
  55   timestamp?: string;
  56   vendorId?: string;
  57   vendorErrorCode?: string;
  58 }
  59
  60 export interface ChangeConfigurationRequest {
  61   key: string | OCPP16StandardParametersKey;
  62   value: string;
  63 }
  64
  65 export interface RemoteStartTransactionRequest {
  66   connectorId: number;
  67   idTag: string;
  68   chargingProfile?: OCPP16ChargingProfile;
  69 }
  70
  71 export interface RemoteStopTransactionRequest {
  72   transactionId: number;
  73 }
  74
  75 export interface UnlockConnectorRequest {
  76   connectorId: number;
  77 }
  78
  79 export interface GetConfigurationRequest {
  80   key?: string | OCPP16StandardParametersKey[];
  81 }
  82
  83 export enum ResetType {
  84   HARD = 'Hard',
  85   SOFT = 'Soft'
  86 }
  87
  88 export interface ResetRequest {
  89   type: ResetType;
  90 }
  91
  92 export interface SetChargingProfileRequest {
  93   connectorId: number;
  94   csChargingProfiles: OCPP16ChargingProfile;
  95 }
  96
  97 export enum OCPP16AvailabilityType {
  98   INOPERATIVE = 'Inoperative',
  99   OPERATIVE = 'Operative'
 100 }
 101
 102 export interface ChangeAvailabilityRequest {
 103   connectorId: number;
 104   type: OCPP16AvailabilityType;
 105 }
 106
 107 export interface ClearChargingProfileRequest {
 108   id?: number;
 109   connectorId?: number;
 110   chargingProfilePurpose?: ChargingProfilePurposeType;
 111   stackLevel?: number;
 112 }
 113
 114 export interface GetDiagnosticsRequest {
 115   location: string;
 116   retries?: number;
 117   retryInterval?: number;
 118   startTime?: Date;
 119   stopTime?: Date;
 120 }
 121
 122 export interface DiagnosticsStatusNotificationRequest {
 123   status: OCPP16DiagnosticsStatus
 124 }
 125
 126 export enum MessageTrigger {
 127   BootNotification = 'BootNotification',
 128   DiagnosticsStatusNotification = 'DiagnosticsStatusNotification',
 129   FirmwareStatusNotification = 'FirmwareStatusNotification',
 130   Heartbeat = 'Heartbeat',
 131   MeterValues = 'MeterValues',
 132   StatusNotification = 'StatusNotification'
 133 }
 134
 135 export interface OCPP16TriggerMessageRequest {
 136   requestedMessage: MessageTrigger;
 137   connectorId?: number
 138 }