X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Ftypes%2Focpp%2F1.6%2FRequests.ts;h=cf810704edcc0436c90610b66b38316668d19793;hb=91a7d3eac062df6c73d8443a542568c1fe69ec1b;hp=873d41a044df6c0484116cba82612010b1934690;hpb=6ce0bca57a96ef920df4e0786d8f28b0b89a36ef;p=e-mobility-charging-stations-simulator.git diff --git a/src/types/ocpp/1.6/Requests.ts b/src/types/ocpp/1.6/Requests.ts index 873d41a0..cf810704 100644 --- a/src/types/ocpp/1.6/Requests.ts +++ b/src/types/ocpp/1.6/Requests.ts @@ -1,116 +1,119 @@ -import { ChargingProfilePurposeType, OCPP16ChargingProfile } from './ChargingProfile'; - -import { OCPP16ChargePointErrorCode } from './ChargePointErrorCode'; -import { OCPP16ChargePointStatus } from './ChargePointStatus'; -import { OCPP16DiagnosticsStatus } from './DiagnosticsStatus'; -import { OCPP16StandardParametersKey } from './Configuration'; +import type { EmptyObject } from '../../EmptyObject'; +import type { JsonObject } from '../../JsonType'; +import type { OCPP16ChargePointErrorCode } from './ChargePointErrorCode'; +import type { OCPP16ChargePointStatus } from './ChargePointStatus'; +import type { ChargingProfilePurposeType, OCPP16ChargingProfile } from './ChargingProfile'; +import type { OCPP16StandardParametersKey } from './Configuration'; +import type { OCPP16DiagnosticsStatus } from './DiagnosticsStatus'; export enum OCPP16RequestCommand { BOOT_NOTIFICATION = 'BootNotification', HEARTBEAT = 'Heartbeat', STATUS_NOTIFICATION = 'StatusNotification', - CHANGE_CONFIGURATION = 'ChangeConfiguration', AUTHORIZE = 'Authorize', START_TRANSACTION = 'StartTransaction', STOP_TRANSACTION = 'StopTransaction', METER_VALUES = 'MeterValues', - DIAGNOSTICS_STATUS_NOTIFICATION= 'DiagnosticsStatusNotification' -} - -export enum OCPP16IncomingRequestCommand { - RESET = 'Reset', - CLEAR_CACHE = 'ClearCache', - CHANGE_AVAILABILITY = 'ChangeAvailability', - UNLOCK_CONNECTOR = 'UnlockConnector', - GET_CONFIGURATION = 'GetConfiguration', - CHANGE_CONFIGURATION = 'ChangeConfiguration', - SET_CHARGING_PROFILE = 'SetChargingProfile', - CLEAR_CHARGING_PROFILE = 'ClearChargingProfile', - REMOTE_START_TRANSACTION = 'RemoteStartTransaction', - REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction', - GET_DIAGNOSTICS = 'GetDiagnostics' + DIAGNOSTICS_STATUS_NOTIFICATION = 'DiagnosticsStatusNotification', + DATA_TRANSFER = 'DataTransfer', } -// eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface HeartbeatRequest { } +export type OCPP16HeartbeatRequest = EmptyObject; -export interface OCPP16BootNotificationRequest { - chargeBoxSerialNumber?: string; +export interface OCPP16BootNotificationRequest extends JsonObject { + chargePointVendor: string; chargePointModel: string; chargePointSerialNumber?: string; - chargePointVendor: string; + chargeBoxSerialNumber?: string; firmwareVersion?: string; iccid?: string; imsi?: string; - meterSerialNumber?: string; meterType?: string; + meterSerialNumber?: string; } -export interface StatusNotificationRequest { +export interface OCPP16StatusNotificationRequest extends JsonObject { connectorId: number; errorCode: OCPP16ChargePointErrorCode; - info?: string; status: OCPP16ChargePointStatus; + info?: string; timestamp?: string; vendorId?: string; vendorErrorCode?: string; } -export interface ChangeConfigurationRequest { +export enum OCPP16IncomingRequestCommand { + RESET = 'Reset', + CLEAR_CACHE = 'ClearCache', + CHANGE_AVAILABILITY = 'ChangeAvailability', + UNLOCK_CONNECTOR = 'UnlockConnector', + GET_CONFIGURATION = 'GetConfiguration', + CHANGE_CONFIGURATION = 'ChangeConfiguration', + SET_CHARGING_PROFILE = 'SetChargingProfile', + CLEAR_CHARGING_PROFILE = 'ClearChargingProfile', + REMOTE_START_TRANSACTION = 'RemoteStartTransaction', + REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction', + GET_DIAGNOSTICS = 'GetDiagnostics', + TRIGGER_MESSAGE = 'TriggerMessage', +} + +export type OCPP16ClearCacheRequest = EmptyObject; + +export interface ChangeConfigurationRequest extends JsonObject { key: string | OCPP16StandardParametersKey; value: string; } -export interface RemoteStartTransactionRequest { +export interface RemoteStartTransactionRequest extends JsonObject { connectorId: number; idTag: string; chargingProfile?: OCPP16ChargingProfile; } -export interface RemoteStopTransactionRequest { +export interface RemoteStopTransactionRequest extends JsonObject { transactionId: number; } -export interface UnlockConnectorRequest { +export interface UnlockConnectorRequest extends JsonObject { connectorId: number; } -export interface GetConfigurationRequest { +export interface GetConfigurationRequest extends JsonObject { key?: string | OCPP16StandardParametersKey[]; } export enum ResetType { HARD = 'Hard', - SOFT = 'Soft' + SOFT = 'Soft', } -export interface ResetRequest { +export interface ResetRequest extends JsonObject { type: ResetType; } -export interface SetChargingProfileRequest { +export interface SetChargingProfileRequest extends JsonObject { connectorId: number; csChargingProfiles: OCPP16ChargingProfile; } export enum OCPP16AvailabilityType { INOPERATIVE = 'Inoperative', - OPERATIVE = 'Operative' + OPERATIVE = 'Operative', } -export interface ChangeAvailabilityRequest { +export interface ChangeAvailabilityRequest extends JsonObject { connectorId: number; type: OCPP16AvailabilityType; } -export interface ClearChargingProfileRequest { +export interface ClearChargingProfileRequest extends JsonObject { id?: number; connectorId?: number; chargingProfilePurpose?: ChargingProfilePurposeType; stackLevel?: number; } -export interface GetDiagnosticsRequest { +export interface GetDiagnosticsRequest extends JsonObject { location: string; retries?: number; retryInterval?: number; @@ -118,6 +121,26 @@ export interface GetDiagnosticsRequest { stopTime?: Date; } -export interface DiagnosticsStatusNotificationRequest { - status: OCPP16DiagnosticsStatus +export interface DiagnosticsStatusNotificationRequest extends JsonObject { + status: OCPP16DiagnosticsStatus; +} + +export enum OCPP16MessageTrigger { + BootNotification = 'BootNotification', + DiagnosticsStatusNotification = 'DiagnosticsStatusNotification', + FirmwareStatusNotification = 'FirmwareStatusNotification', + Heartbeat = 'Heartbeat', + MeterValues = 'MeterValues', + StatusNotification = 'StatusNotification', +} + +export interface OCPP16TriggerMessageRequest extends JsonObject { + requestedMessage: OCPP16MessageTrigger; + connectorId?: number; +} + +export interface OCPP16DataTransferRequest extends JsonObject { + vendorId: string; + messageId?: string; + data?: string; }