Documentation on OCPP parameters

[e-mobility-charging-stations-simulator.git] / src / types / ocpp / 1.6 / Requests.ts

diff --git a/src/types/ocpp/1.6/Requests.ts b/src/types/ocpp/1.6/Requests.ts
index e7e662233aecb7ff6d4176111fd213aeaad30d37..9ed48049a52cb70915cf8c1955f914d42a236453 100644 (file)
--- a/src/types/ocpp/1.6/Requests.ts
+++ b/src/types/ocpp/1.6/Requests.ts
@@ -1,9 +1,10 @@
-import { ChargePointErrorCode } from './ChargePointErrorCode';
-import { ChargePointStatus } from './ChargePointStatus';
-import { ChargingProfile } from './ChargingProfile';
-import { StandardParametersKey } from './Configuration';
+import { ChargingProfilePurposeType, OCPP16ChargingProfile } from './ChargingProfile';
 
-export enum RequestCommand {
+import { OCPP16ChargePointErrorCode } from './ChargePointErrorCode';
+import { OCPP16ChargePointStatus } from './ChargePointStatus';
+import { OCPP16StandardParametersKey } from './Configuration';
+
+export enum OCPP16RequestCommand {
   BOOT_NOTIFICATION = 'BootNotification',
   HEARTBEAT = 'Heartbeat',
   STATUS_NOTIFICATION = 'StatusNotification',
@@ -11,10 +12,10 @@ export enum RequestCommand {
   AUTHORIZE = 'Authorize',
   START_TRANSACTION = 'StartTransaction',
   STOP_TRANSACTION = 'StopTransaction',
-  METERVALUES = 'MeterValues'
+  METER_VALUES = 'MeterValues'
 }
 
-export enum IncomingRequestCommand {
+export enum OCPP16IncomingRequestCommand {
   RESET = 'Reset',
   CLEAR_CACHE = 'ClearCache',
   CHANGE_AVAILABILITY = 'ChangeAvailability',
@@ -22,6 +23,7 @@ export enum IncomingRequestCommand {
   GET_CONFIGURATION = 'GetConfiguration',
   CHANGE_CONFIGURATION = 'ChangeConfiguration',
   SET_CHARGING_PROFILE = 'SetChargingProfile',
+  CLEAR_CHARGING_PROFILE = 'ClearChargingProfile',
   REMOTE_START_TRANSACTION = 'RemoteStartTransaction',
   REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction'
 }
@@ -29,7 +31,7 @@ export enum IncomingRequestCommand {
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface HeartbeatRequest { }
 
-export interface BootNotificationRequest {
+export interface OCPP16BootNotificationRequest {
   chargeBoxSerialNumber?: string;
   chargePointModel: string;
   chargePointSerialNumber?: string;
@@ -43,23 +45,23 @@ export interface BootNotificationRequest {
 
 export interface StatusNotificationRequest {
   connectorId: number;
-  errorCode: ChargePointErrorCode;
+  errorCode: OCPP16ChargePointErrorCode;
   info?: string;
-  status: ChargePointStatus;
+  status: OCPP16ChargePointStatus;
   timestamp?: string;
   vendorId?: string;
   vendorErrorCode?: string;
 }
 
 export interface ChangeConfigurationRequest {
-  key: string | StandardParametersKey;
+  key: string | OCPP16StandardParametersKey;
   value: string;
 }
 
 export interface RemoteStartTransactionRequest {
   connectorId: number;
   idTag: string;
-  chargingProfile?: ChargingProfile;
+  chargingProfile?: OCPP16ChargingProfile;
 }
 
 export interface RemoteStopTransactionRequest {
@@ -71,7 +73,7 @@ export interface UnlockConnectorRequest {
 }
 
 export interface GetConfigurationRequest {
-  key?: string | StandardParametersKey[];
+  key?: string | OCPP16StandardParametersKey[];
 }
 
 export enum ResetType {
@@ -85,15 +87,22 @@ export interface ResetRequest {
 
 export interface SetChargingProfileRequest {
   connectorId: number;
-  csChargingProfiles: ChargingProfile;
+  csChargingProfiles: OCPP16ChargingProfile;
 }
 
-export enum AvailabilityType {
+export enum OCPP16AvailabilityType {
   INOPERATIVE = 'Inoperative',
   OPERATIVE = 'Operative'
 }
 
 export interface ChangeAvailabilityRequest {
   connectorId: number;
-  type: AvailabilityType;
+  type: OCPP16AvailabilityType;
+}
+
+export interface ClearChargingProfileRequest {
+  id?: number;
+  connectorId?: number;
+  chargingProfilePurpose?: ChargingProfilePurposeType;
+  stackLevel?: number;
 }