src/types/ocpp/1.6/Responses.ts

   1 import type { OCPP16ChargingSchedule } from './ChargingProfile.js';
   2 import type { EmptyObject } from '../../EmptyObject.js';
   3 import type { JsonObject } from '../../JsonType.js';
   4 import type { GenericStatus, RegistrationStatusEnumType } from '../Common.js';
   5 import type { OCPPConfigurationKey } from '../Configuration.js';
   6
   7 export interface OCPP16HeartbeatResponse extends JsonObject {
   8   currentTime: Date;
   9 }
  10
  11 export enum OCPP16UnlockStatus {
  12   UNLOCKED = 'Unlocked',
  13   UNLOCK_FAILED = 'UnlockFailed',
  14   NOT_SUPPORTED = 'NotSupported',
  15 }
  16
  17 export interface UnlockConnectorResponse extends JsonObject {
  18   status: OCPP16UnlockStatus;
  19 }
  20
  21 export enum OCPP16ConfigurationStatus {
  22   ACCEPTED = 'Accepted',
  23   REJECTED = 'Rejected',
  24   REBOOT_REQUIRED = 'RebootRequired',
  25   NOT_SUPPORTED = 'NotSupported',
  26 }
  27
  28 export interface ChangeConfigurationResponse extends JsonObject {
  29   status: OCPP16ConfigurationStatus;
  30 }
  31
  32 export interface OCPP16BootNotificationResponse extends JsonObject {
  33   status: RegistrationStatusEnumType;
  34   currentTime: Date;
  35   interval: number;
  36 }
  37
  38 export type OCPP16StatusNotificationResponse = EmptyObject;
  39
  40 export interface GetConfigurationResponse extends JsonObject {
  41   configurationKey: OCPPConfigurationKey[];
  42   unknownKey: string[];
  43 }
  44
  45 export enum OCPP16ChargingProfileStatus {
  46   ACCEPTED = 'Accepted',
  47   REJECTED = 'Rejected',
  48   NOT_SUPPORTED = 'NotSupported',
  49 }
  50
  51 export interface OCPP16GetCompositeScheduleResponse extends JsonObject {
  52   status: GenericStatus;
  53   connectorId?: number;
  54   scheduleStart?: Date;
  55   chargingSchedule?: OCPP16ChargingSchedule;
  56 }
  57
  58 export interface SetChargingProfileResponse extends JsonObject {
  59   status: OCPP16ChargingProfileStatus;
  60 }
  61
  62 export enum OCPP16AvailabilityStatus {
  63   ACCEPTED = 'Accepted',
  64   REJECTED = 'Rejected',
  65   SCHEDULED = 'Scheduled',
  66 }
  67
  68 export interface OCPP16ChangeAvailabilityResponse extends JsonObject {
  69   status: OCPP16AvailabilityStatus;
  70 }
  71
  72 export enum OCPP16ClearChargingProfileStatus {
  73   ACCEPTED = 'Accepted',
  74   UNKNOWN = 'Unknown',
  75 }
  76
  77 export interface OCPP16ClearChargingProfileResponse extends JsonObject {
  78   status: OCPP16ClearChargingProfileStatus;
  79 }
  80
  81 export type OCPP16UpdateFirmwareResponse = EmptyObject;
  82
  83 export type OCPP16FirmwareStatusNotificationResponse = EmptyObject;
  84
  85 export interface GetDiagnosticsResponse extends JsonObject {
  86   fileName?: string;
  87 }
  88
  89 export type OCPP16DiagnosticsStatusNotificationResponse = EmptyObject;
  90
  91 export enum OCPP16TriggerMessageStatus {
  92   ACCEPTED = 'Accepted',
  93   REJECTED = 'Rejected',
  94   NOT_IMPLEMENTED = 'NotImplemented',
  95 }
  96
  97 export interface OCPP16TriggerMessageResponse extends JsonObject {
  98   status: OCPP16TriggerMessageStatus;
  99 }
 100
 101 export enum OCPP16DataTransferStatus {
 102   ACCEPTED = 'Accepted',
 103   REJECTED = 'Rejected',
 104   UNKNOWN_MESSAGE_ID = 'UnknownMessageId',
 105   UNKNOWN_VENDOR_ID = 'UnknownVendorId',
 106 }
 107
 108 export interface OCPP16DataTransferResponse extends JsonObject {
 109   status: OCPP16DataTransferStatus;
 110   data?: string;
 111 }
 112
 113 export enum OCPP16ReservationStatus {
 114   ACCEPTED = 'Accepted',
 115   FAULTED = 'Faulted',
 116   OCCUPIED = 'Occupied',
 117   REJECTED = 'Rejected',
 118   UNAVAILABLE = 'Unavailable',
 119   NOT_SUPPORTED = 'NotSupported',
 120 }
 121
 122 export interface OCPP16ReserveNowResponse extends JsonObject {
 123   status: OCPP16ReservationStatus;
 124 }