ocpp-messages 0.1.0

package/v2.0/GetChargingProfilesRequest.d.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code
+ * urn:x-oca:ocpp:uid:1:569231
+ * Defines the purpose of the schedule transferred by this profile
+ *
+ */
+export type ChargingProfilePurposeEnumType =
+  | "ChargingStationExternalConstraints"
+  | "ChargingStationMaxProfile"
+  | "TxDefaultProfile"
+  | "TxProfile";
+export type ChargingLimitSourceEnumType = "EMS" | "Other" | "SO" | "CSO";
+
+export interface UrnOCPPCp220203GetChargingProfilesRequest {
+  customData?: CustomDataType;
+  /**
+   * Reference identification that is to be used by the Charging Station in the <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> when provided.
+   *
+   */
+  requestId: number;
+  /**
+   * For which EVSE installed charging profiles SHALL be reported. If 0, only charging profiles installed on the Charging Station itself (the grid connection) SHALL be reported. If omitted, all installed charging profiles SHALL be reported.
+   *
+   */
+  evseId?: number;
+  chargingProfile: ChargingProfileCriterionType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Charging_ Profile
+ * urn:x-oca:ocpp:uid:2:233255
+ * A ChargingProfile consists of ChargingSchedule, describing the amount of power or current that can be delivered per time interval.
+ *
+ */
+export interface ChargingProfileCriterionType {
+  customData?: CustomDataType;
+  chargingProfilePurpose?: ChargingProfilePurposeEnumType;
+  /**
+   * Charging_ Profile. Stack_ Level. Counter
+   * urn:x-oca:ocpp:uid:1:569230
+   * Value determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.
+   *
+   */
+  stackLevel?: number;
+  /**
+   * List of all the chargingProfileIds requested. Any ChargingProfile that matches one of these profiles will be reported. If omitted, the Charging Station SHALL not filter on chargingProfileId. This field SHALL NOT contain more ids than set in <<configkey-charging-profile-entries,ChargingProfileEntries.maxLimit>>
+   *
+   *
+   *
+   * @minItems 1
+   */
+  chargingProfileId?: [number, ...number[]];
+  /**
+   * For which charging limit sources, charging profiles SHALL be reported. If omitted, the Charging Station SHALL not filter on chargingLimitSource.
+   *
+   *
+   * @minItems 1
+   * @maxItems 4
+   */
+  chargingLimitSource?:
+    | [ChargingLimitSourceEnumType]
+    | [ChargingLimitSourceEnumType, ChargingLimitSourceEnumType]
+    | [ChargingLimitSourceEnumType, ChargingLimitSourceEnumType, ChargingLimitSourceEnumType]
+    | [
+        ChargingLimitSourceEnumType,
+        ChargingLimitSourceEnumType,
+        ChargingLimitSourceEnumType,
+        ChargingLimitSourceEnumType
+      ];
+}

package/v2.0/GetChargingProfilesResponse.d.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * This indicates whether the Charging Station is able to process this request and will send <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> messages.
+ *
+ */
+export type GetChargingProfileStatusEnumType = "Accepted" | "NoProfiles";
+
+export interface UrnOCPPCp220203GetChargingProfilesResponse {
+  customData?: CustomDataType;
+  status: GetChargingProfileStatusEnumType;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/GetCompositeScheduleRequest.d.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Can be used to force a power or current profile.
+ *
+ *
+ */
+export type ChargingRateUnitEnumType = "W" | "A";
+
+export interface UrnOCPPCp220203GetCompositeScheduleRequest {
+  customData?: CustomDataType;
+  /**
+   * Length of the requested schedule in seconds.
+   *
+   *
+   */
+  duration: number;
+  chargingRateUnit?: ChargingRateUnitEnumType;
+  /**
+   * The ID of the EVSE for which the schedule is requested. When evseid=0, the Charging Station will calculate the expected consumption for the grid connection.
+   *
+   */
+  evseId: number;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetCompositeScheduleResponse.d.ts

@@ -0,0 +1,119 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * The Charging Station will indicate if it was
+ * able to process the request
+ *
+ */
+export type GenericStatusEnumType = "Accepted" | "Rejected";
+/**
+ * The unit of measure Limit is
+ * expressed in.
+ *
+ */
+export type ChargingRateUnitEnumType = "W" | "A";
+
+export interface UrnOCPPCp220203GetCompositeScheduleResponse {
+  customData?: CustomDataType;
+  status: GenericStatusEnumType;
+  statusInfo?: StatusInfoType;
+  schedule?: CompositeScheduleType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}
+/**
+ * Composite_ Schedule
+ * urn:x-oca:ocpp:uid:2:233362
+ *
+ */
+export interface CompositeScheduleType {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  chargingSchedulePeriod: [ChargingSchedulePeriodType, ...ChargingSchedulePeriodType[]];
+  /**
+   * The ID of the EVSE for which the
+   * schedule is requested. When evseid=0, the
+   * Charging Station calculated the expected
+   * consumption for the grid connection.
+   *
+   */
+  evseId: number;
+  /**
+   * Duration of the schedule in seconds.
+   *
+   */
+  duration: number;
+  /**
+   * Composite_ Schedule. Start. Date_ Time
+   * urn:x-oca:ocpp:uid:1:569456
+   * Date and time at which the schedule becomes active. All time measurements within the schedule are relative to this timestamp.
+   *
+   */
+  scheduleStart: string;
+  chargingRateUnit: ChargingRateUnitEnumType;
+}
+/**
+ * Charging_ Schedule_ Period
+ * urn:x-oca:ocpp:uid:2:233257
+ * Charging schedule period structure defines a time period in a charging schedule.
+ *
+ */
+export interface ChargingSchedulePeriodType {
+  customData?: CustomDataType;
+  /**
+   * Charging_ Schedule_ Period. Start_ Period. Elapsed_ Time
+   * urn:x-oca:ocpp:uid:1:569240
+   * Start of the period, in seconds from the start of schedule. The value of StartPeriod also defines the stop time of the previous period.
+   *
+   */
+  startPeriod: number;
+  /**
+   * Charging_ Schedule_ Period. Limit. Measure
+   * urn:x-oca:ocpp:uid:1:569241
+   * Charging rate limit during the schedule period, in the applicable chargingRateUnit, for example in Amperes (A) or Watts (W). Accepts at most one digit fraction (e.g. 8.1).
+   *
+   */
+  limit: number;
+  /**
+   * Charging_ Schedule_ Period. Number_ Phases. Counter
+   * urn:x-oca:ocpp:uid:1:569242
+   * The number of phases that can be used for charging. If a number of phases is needed, numberPhases=3 will be assumed unless another number is given.
+   *
+   */
+  numberPhases?: number;
+  /**
+   * Values: 1..3, Used if numberPhases=1 and if the EVSE is capable of switching the phase connected to the EV, i.e. ACPhaseSwitchingSupported is defined and true. It’s not allowed unless both conditions above are true. If both conditions are true, and phaseToUse is omitted, the Charging Station / EVSE will make the selection on its own.
+   *
+   *
+   */
+  phaseToUse?: number;
+}

package/v2.0/GetDisplayMessagesRequest.d.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * If provided the Charging Station shall return Display Messages with the given priority only.
+ *
+ */
+export type MessagePriorityEnumType = "AlwaysFront" | "InFront" | "NormalCycle";
+/**
+ * If provided the Charging Station shall return Display Messages with the given state only.
+ *
+ */
+export type MessageStateEnumType = "Charging" | "Faulted" | "Idle" | "Unavailable";
+
+export interface UrnOCPPCp220203GetDisplayMessagesRequest {
+  customData?: CustomDataType;
+  /**
+   * If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in <<configkey-number-of-display-messages,NumberOfDisplayMessages.maxLimit>>
+   *
+   *
+   *
+   * @minItems 1
+   */
+  id?: [number, ...number[]];
+  /**
+   * The Id of this request.
+   *
+   */
+  requestId: number;
+  priority?: MessagePriorityEnumType;
+  state?: MessageStateEnumType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetDisplayMessagesResponse.d.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Indicates if the Charging Station has Display Messages that match the request criteria in the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>>
+ *
+ */
+export type GetDisplayMessagesStatusEnumType = "Accepted" | "Unknown";
+
+export interface UrnOCPPCp220203GetDisplayMessagesResponse {
+  customData?: CustomDataType;
+  status: GetDisplayMessagesStatusEnumType;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/GetInstalledCertificateIdsRequest.d.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type GetCertificateIdUseEnumType =
+  | "V2GRootCertificate"
+  | "MORootCertificate"
+  | "CSMSRootCertificate"
+  | "V2GCertificateChain"
+  | "ManufacturerRootCertificate";
+
+export interface UrnOCPPCp220203GetInstalledCertificateIdsRequest {
+  customData?: CustomDataType;
+  /**
+   * Indicates the type of certificates requested. When omitted, all certificate types are requested.
+   *
+   *
+   * @minItems 1
+   */
+  certificateType?: [GetCertificateIdUseEnumType, ...GetCertificateIdUseEnumType[]];
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetInstalledCertificateIdsResponse.d.ts

@@ -0,0 +1,95 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Charging Station indicates if it can process the request.
+ *
+ */
+export type GetInstalledCertificateStatusEnumType = "Accepted" | "NotFound";
+/**
+ * Used algorithms for the hashes provided.
+ *
+ */
+export type HashAlgorithmEnumType = "SHA256" | "SHA384" | "SHA512";
+/**
+ * Indicates the type of the requested certificate(s).
+ *
+ */
+export type GetCertificateIdUseEnumType =
+  | "V2GRootCertificate"
+  | "MORootCertificate"
+  | "CSMSRootCertificate"
+  | "V2GCertificateChain"
+  | "ManufacturerRootCertificate";
+
+export interface UrnOCPPCp220203GetInstalledCertificateIdsResponse {
+  customData?: CustomDataType;
+  status: GetInstalledCertificateStatusEnumType;
+  statusInfo?: StatusInfoType;
+  /**
+   * @minItems 1
+   */
+  certificateHashDataChain?: [CertificateHashDataChainType, ...CertificateHashDataChainType[]];
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}
+export interface CertificateHashDataChainType {
+  customData?: CustomDataType;
+  certificateHashData: CertificateHashDataType;
+  certificateType: GetCertificateIdUseEnumType;
+  /**
+   * @minItems 1
+   * @maxItems 4
+   */
+  childCertificateHashData?:
+    | [CertificateHashDataType]
+    | [CertificateHashDataType, CertificateHashDataType]
+    | [CertificateHashDataType, CertificateHashDataType, CertificateHashDataType]
+    | [CertificateHashDataType, CertificateHashDataType, CertificateHashDataType, CertificateHashDataType];
+}
+export interface CertificateHashDataType {
+  customData?: CustomDataType;
+  hashAlgorithm: HashAlgorithmEnumType;
+  /**
+   * Hashed value of the Issuer DN (Distinguished Name).
+   *
+   *
+   */
+  issuerNameHash: string;
+  /**
+   * Hashed value of the issuers public key
+   *
+   */
+  issuerKeyHash: string;
+  /**
+   * The serial number of the certificate.
+   *
+   */
+  serialNumber: string;
+}

package/v2.0/GetLocalListVersionRequest.d.ts

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface UrnOCPPCp220203GetLocalListVersionRequest {
+  customData?: CustomDataType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetLocalListVersionResponse.d.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface UrnOCPPCp220203GetLocalListVersionResponse {
+  customData?: CustomDataType;
+  /**
+   * This contains the current version number of the local authorization list in the Charging Station.
+   *
+   */
+  versionNumber: number;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetLogRequest.d.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * This contains the type of log file that the Charging Station
+ * should send.
+ *
+ */
+export type LogEnumType = "DiagnosticsLog" | "SecurityLog";
+
+export interface UrnOCPPCp220203GetLogRequest {
+  customData?: CustomDataType;
+  log: LogParametersType;
+  logType: LogEnumType;
+  /**
+   * The Id of this request
+   *
+   */
+  requestId: number;
+  /**
+   * This specifies how many times the Charging Station must try to upload the log before giving up. If this field is not present, it is left to Charging Station to decide how many times it wants to retry.
+   *
+   */
+  retries?: number;
+  /**
+   * The interval in seconds after which a retry may be attempted. If this field is not present, it is left to Charging Station to decide how long to wait between attempts.
+   *
+   */
+  retryInterval?: number;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Log
+ * urn:x-enexis:ecdm:uid:2:233373
+ * Generic class for the configuration of logging entries.
+ *
+ */
+export interface LogParametersType {
+  customData?: CustomDataType;
+  /**
+   * Log. Remote_ Location. URI
+   * urn:x-enexis:ecdm:uid:1:569484
+   * The URL of the location at the remote system where the log should be stored.
+   *
+   */
+  remoteLocation: string;
+  /**
+   * Log. Oldest_ Timestamp. Date_ Time
+   * urn:x-enexis:ecdm:uid:1:569477
+   * This contains the date and time of the oldest logging information to include in the diagnostics.
+   *
+   */
+  oldestTimestamp?: string;
+  /**
+   * Log. Latest_ Timestamp. Date_ Time
+   * urn:x-enexis:ecdm:uid:1:569482
+   * This contains the date and time of the latest logging information to include in the diagnostics.
+   *
+   */
+  latestTimestamp?: string;
+}

package/v2.0/GetLogResponse.d.ts

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * This field indicates whether the Charging Station was able to accept the request.
+ *
+ */
+export type LogStatusEnumType = "Accepted" | "Rejected" | "AcceptedCanceled";
+
+export interface UrnOCPPCp220203GetLogResponse {
+  customData?: CustomDataType;
+  status: LogStatusEnumType;
+  statusInfo?: StatusInfoType;
+  /**
+   * This contains the name of the log file that will be uploaded. This field is not present when no logging information is available.
+   *
+   */
+  filename?: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}