X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Ftypes%2Focpp%2F1.6%2FRequests.ts;h=80128a271c9fd6edd3cb6ec9609ad6b2ed898da7;hb=d193a94981cfed2c3d502eeca581ce4e9f0eebe5;hp=d318dafb28ad43f824c4fa07001f2a6f3cd78089;hpb=5bd15d76859f5ac6b04a610f055145642e53e400;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 d318dafb..80128a27 100644 --- a/src/types/ocpp/1.6/Requests.ts +++ b/src/types/ocpp/1.6/Requests.ts @@ -1,96 +1,201 @@ -import { ChargePointErrorCode } from './ChargePointErrorCode'; -import { ChargePointStatus } from './ChargePointStatus'; -import { ChargingProfile } from './ChargingProfile'; -import { MessageType } from '../MessageType'; -import OCPPError from '../../../charging-station/OcppError'; - -export default interface Requests { - [id: string]: Request; -} - -export type Request = [(payload?, requestPayload?) => void, (error?: OCPPError) => void, Record]; - -export type IncomingRequest = [MessageType, string, IncomingRequestCommand, string, string]; - -export enum RequestCommand { +import type { OCPP16ChargePointErrorCode } from './ChargePointErrorCode'; +import type { OCPP16ChargePointStatus } from './ChargePointStatus'; +import type { + OCPP16ChargingProfile, + OCPP16ChargingProfilePurposeType, + OCPP16ChargingRateUnitType, +} from './ChargingProfile'; +import type { OCPP16StandardParametersKey, OCPP16VendorParametersKey } from './Configuration'; +import type { OCPP16DiagnosticsStatus } from './DiagnosticsStatus'; +import type { EmptyObject } from '../../EmptyObject'; +import type { JsonObject } from '../../JsonType'; + +export enum OCPP16RequestCommand { BOOT_NOTIFICATION = 'BootNotification', HEARTBEAT = 'Heartbeat', STATUS_NOTIFICATION = 'StatusNotification', - CHANGE_CONFIGURATION = 'ChangeConfiguration', + AUTHORIZE = 'Authorize', START_TRANSACTION = 'StartTransaction', STOP_TRANSACTION = 'StopTransaction', - METERVALUES = 'MeterValues' + METER_VALUES = 'MeterValues', + DIAGNOSTICS_STATUS_NOTIFICATION = 'DiagnosticsStatusNotification', + FIRMWARE_STATUS_NOTIFICATION = 'FirmwareStatusNotification', + DATA_TRANSFER = 'DataTransfer', + RESERVE_NOW = 'ReserveNow', + CANCEL_RESERVATION = 'CancelReservation', } -export enum IncomingRequestCommand { +export enum OCPP16IncomingRequestCommand { RESET = 'Reset', CLEAR_CACHE = 'ClearCache', + CHANGE_AVAILABILITY = 'ChangeAvailability', UNLOCK_CONNECTOR = 'UnlockConnector', GET_CONFIGURATION = 'GetConfiguration', CHANGE_CONFIGURATION = 'ChangeConfiguration', + GET_COMPOSITE_SCHEDULE = 'GetCompositeSchedule', SET_CHARGING_PROFILE = 'SetChargingProfile', + CLEAR_CHARGING_PROFILE = 'ClearChargingProfile', REMOTE_START_TRANSACTION = 'RemoteStartTransaction', - REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction' + REMOTE_STOP_TRANSACTION = 'RemoteStopTransaction', + GET_DIAGNOSTICS = 'GetDiagnostics', + TRIGGER_MESSAGE = 'TriggerMessage', + DATA_TRANSFER = 'DataTransfer', + UPDATE_FIRMWARE = 'UpdateFirmware', + RESERVE_NOW = 'ReserveNow', + CANCEL_RESERVATION = 'CancelReservation', } -// eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface HeartbeatRequest {} +export type OCPP16HeartbeatRequest = EmptyObject; -export interface BootNotificationRequest { - 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: ChargePointErrorCode; + errorCode: OCPP16ChargePointErrorCode; + status: OCPP16ChargePointStatus; info?: string; - status: ChargePointStatus; - timestamp?: string; + timestamp?: Date; vendorId?: string; vendorErrorCode?: string; } -export interface ChangeConfigurationRequest { - key: string; +export type OCPP16ClearCacheRequest = EmptyObject; + +type OCPP16ConfigurationKey = string | OCPP16StandardParametersKey | OCPP16VendorParametersKey; + +export interface ChangeConfigurationRequest extends JsonObject { + key: OCPP16ConfigurationKey; value: string; } -export interface RemoteStartTransactionRequest { +export interface RemoteStartTransactionRequest extends JsonObject { connectorId: number; idTag: string; - chargingProfile?: ChargingProfile; + 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 { - key?: string[]; +export interface GetConfigurationRequest extends JsonObject { + key?: OCPP16ConfigurationKey[]; } -export enum ResetType { +enum ResetType { HARD = 'Hard', - SOFT = 'Soft' + SOFT = 'Soft', } -export interface ResetRequest { +export interface ResetRequest extends JsonObject { type: ResetType; } -export interface SetChargingProfileRequest { +export interface OCPP16GetCompositeScheduleRequest extends JsonObject { + connectorId: number; + duration: number; + chargingRateUnit?: OCPP16ChargingRateUnitType; +} + +export interface SetChargingProfileRequest extends JsonObject { + connectorId: number; + csChargingProfiles: OCPP16ChargingProfile; +} + +export enum OCPP16AvailabilityType { + Inoperative = 'Inoperative', + Operative = 'Operative', +} + +export interface ChangeAvailabilityRequest extends JsonObject { + connectorId: number; + type: OCPP16AvailabilityType; +} + +export interface ClearChargingProfileRequest extends JsonObject { + id?: number; + connectorId?: number; + chargingProfilePurpose?: OCPP16ChargingProfilePurposeType; + stackLevel?: number; +} + +export interface OCPP16UpdateFirmwareRequest extends JsonObject { + location: string; + retrieveDate: Date; + retries?: number; + retryInterval?: number; +} + +export enum OCPP16FirmwareStatus { + Downloaded = 'Downloaded', + DownloadFailed = 'DownloadFailed', + Downloading = 'Downloading', + Idle = 'Idle', + InstallationFailed = 'InstallationFailed', + Installing = 'Installing', + Installed = 'Installed', +} + +export type OCPP16FirmwareStatusNotificationRequest = { + status: OCPP16FirmwareStatus; +} & JsonObject; + +export interface GetDiagnosticsRequest extends JsonObject { + location: string; + retries?: number; + retryInterval?: number; + startTime?: Date; + stopTime?: Date; +} + +export interface OCPP16DiagnosticsStatusNotificationRequest 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 enum OCPP16DataTransferVendorId {} + +export interface OCPP16DataTransferRequest extends JsonObject { + vendorId: string; + messageId?: string; + data?: string; +} + +export interface OCPP16ReserveNowRequest extends JsonObject { connectorId: number; - csChargingProfiles: ChargingProfile; + expiryDate: Date; + idTag: string; + parentIdTag?: string; + reservationId: number; +} + +export interface OCPP16CancelReservationRequest extends JsonObject { + reservationId: number; }