ocpp-messages 0.1.0

package/v2.0/NotifyDisplayMessagesRequest.d.ts

@@ -0,0 +1,159 @@
+/* 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.
+ */
+
+/**
+ * Message_ Info. Priority. Message_ Priority_ Code
+ * urn:x-enexis:ecdm:uid:1:569253
+ * With what priority should this message be shown
+ *
+ */
+export type MessagePriorityEnumType = "AlwaysFront" | "InFront" | "NormalCycle";
+/**
+ * Message_ Info. State. Message_ State_ Code
+ * urn:x-enexis:ecdm:uid:1:569254
+ * During what state should this message be shown. When omitted this message should be shown in any state of the Charging Station.
+ *
+ */
+export type MessageStateEnumType = "Charging" | "Faulted" | "Idle" | "Unavailable";
+/**
+ * Message_ Content. Format. Message_ Format_ Code
+ * urn:x-enexis:ecdm:uid:1:570848
+ * Format of the message.
+ *
+ */
+export type MessageFormatEnumType = "ASCII" | "HTML" | "URI" | "UTF8";
+
+export interface UrnOCPPCp220203NotifyDisplayMessagesRequest {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  messageInfo?: [MessageInfoType, ...MessageInfoType[]];
+  /**
+   * The id of the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>> that requested this message.
+   *
+   */
+  requestId: number;
+  /**
+   * "to be continued" indicator. Indicates whether another part of the report follows in an upcoming NotifyDisplayMessagesRequest message. Default value when omitted is false.
+   *
+   */
+  tbc?: boolean;
+}
+/**
+ * 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;
+}
+/**
+ * Message_ Info
+ * urn:x-enexis:ecdm:uid:2:233264
+ * Contains message details, for a message to be displayed on a Charging Station.
+ *
+ */
+export interface MessageInfoType {
+  customData?: CustomDataType;
+  display?: ComponentType;
+  /**
+   * Identified_ Object. MRID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:569198
+   * Master resource identifier, unique within an exchange context. It is defined within the OCPP context as a positive Integer value (greater or equal to zero).
+   *
+   */
+  id: number;
+  priority: MessagePriorityEnumType;
+  state?: MessageStateEnumType;
+  /**
+   * Message_ Info. Start. Date_ Time
+   * urn:x-enexis:ecdm:uid:1:569256
+   * From what date-time should this message be shown. If omitted: directly.
+   *
+   */
+  startDateTime?: string;
+  /**
+   * Message_ Info. End. Date_ Time
+   * urn:x-enexis:ecdm:uid:1:569257
+   * Until what date-time should this message be shown, after this date/time this message SHALL be removed.
+   *
+   */
+  endDateTime?: string;
+  /**
+   * During which transaction shall this message be shown.
+   * Message SHALL be removed by the Charging Station after transaction has
+   * ended.
+   *
+   */
+  transactionId?: string;
+  message: MessageContentType;
+}
+/**
+ * A physical or logical component
+ *
+ */
+export interface ComponentType {
+  customData?: CustomDataType;
+  evse?: EVSEType;
+  /**
+   * Name of the component. Name should be taken from the list of standardized component names whenever possible. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  name: string;
+  /**
+   * Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  instance?: string;
+}
+/**
+ * EVSE
+ * urn:x-oca:ocpp:uid:2:233123
+ * Electric Vehicle Supply Equipment
+ *
+ */
+export interface EVSEType {
+  customData?: CustomDataType;
+  /**
+   * Identified_ Object. MRID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:569198
+   * EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
+   *
+   */
+  id: number;
+  /**
+   * An id to designate a specific connector (on an EVSE) by connector index number.
+   *
+   */
+  connectorId?: number;
+}
+/**
+ * Message_ Content
+ * urn:x-enexis:ecdm:uid:2:234490
+ * Contains message details, for a message to be displayed on a Charging Station.
+ *
+ *
+ */
+export interface MessageContentType {
+  customData?: CustomDataType;
+  format: MessageFormatEnumType;
+  /**
+   * Message_ Content. Language. Language_ Code
+   * urn:x-enexis:ecdm:uid:1:570849
+   * Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
+   *
+   */
+  language?: string;
+  /**
+   * Message_ Content. Content. Message
+   * urn:x-enexis:ecdm:uid:1:570852
+   * Message contents.
+   *
+   *
+   */
+  content: string;
+}

package/v2.0/NotifyDisplayMessagesResponse.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 UrnOCPPCp220203NotifyDisplayMessagesResponse {
+  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/NotifyEVChargingNeedsRequest.d.ts

@@ -0,0 +1,159 @@
+/* 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_ Needs. Requested. Energy_ Transfer_ Mode_ Code
+ * urn:x-oca:ocpp:uid:1:569209
+ * Mode of energy transfer requested by the EV.
+ *
+ */
+export type EnergyTransferModeEnumType = "DC" | "AC_single_phase" | "AC_two_phase" | "AC_three_phase";
+
+export interface UrnOCPPCp220203NotifyEVChargingNeedsRequest {
+  customData?: CustomDataType;
+  /**
+   * Contains the maximum schedule tuples the car supports per schedule.
+   *
+   */
+  maxScheduleTuples?: number;
+  chargingNeeds: ChargingNeedsType;
+  /**
+   * Defines the EVSE and connector to which the EV is connected. EvseId may not be 0.
+   *
+   */
+  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;
+}
+/**
+ * Charging_ Needs
+ * urn:x-oca:ocpp:uid:2:233249
+ *
+ */
+export interface ChargingNeedsType {
+  customData?: CustomDataType;
+  acChargingParameters?: ACChargingParametersType;
+  dcChargingParameters?: DCChargingParametersType;
+  requestedEnergyTransfer: EnergyTransferModeEnumType;
+  /**
+   * Charging_ Needs. Departure_ Time. Date_ Time
+   * urn:x-oca:ocpp:uid:1:569223
+   * Estimated departure time of the EV.
+   *
+   */
+  departureTime?: string;
+}
+/**
+ * AC_ Charging_ Parameters
+ * urn:x-oca:ocpp:uid:2:233250
+ * EV AC charging parameters.
+ *
+ *
+ */
+export interface ACChargingParametersType {
+  customData?: CustomDataType;
+  /**
+   * AC_ Charging_ Parameters. Energy_ Amount. Energy_ Amount
+   * urn:x-oca:ocpp:uid:1:569211
+   * Amount of energy requested (in Wh). This includes energy required for preconditioning.
+   *
+   */
+  energyAmount: number;
+  /**
+   * AC_ Charging_ Parameters. EV_ Min. Current
+   * urn:x-oca:ocpp:uid:1:569212
+   * Minimum current (amps) supported by the electric vehicle (per phase).
+   *
+   */
+  evMinCurrent: number;
+  /**
+   * AC_ Charging_ Parameters. EV_ Max. Current
+   * urn:x-oca:ocpp:uid:1:569213
+   * Maximum current (amps) supported by the electric vehicle (per phase). Includes cable capacity.
+   *
+   */
+  evMaxCurrent: number;
+  /**
+   * AC_ Charging_ Parameters. EV_ Max. Voltage
+   * urn:x-oca:ocpp:uid:1:569214
+   * Maximum voltage supported by the electric vehicle
+   *
+   */
+  evMaxVoltage: number;
+}
+/**
+ * DC_ Charging_ Parameters
+ * urn:x-oca:ocpp:uid:2:233251
+ * EV DC charging parameters
+ *
+ *
+ *
+ */
+export interface DCChargingParametersType {
+  customData?: CustomDataType;
+  /**
+   * DC_ Charging_ Parameters. EV_ Max. Current
+   * urn:x-oca:ocpp:uid:1:569215
+   * Maximum current (amps) supported by the electric vehicle. Includes cable capacity.
+   *
+   */
+  evMaxCurrent: number;
+  /**
+   * DC_ Charging_ Parameters. EV_ Max. Voltage
+   * urn:x-oca:ocpp:uid:1:569216
+   * Maximum voltage supported by the electric vehicle
+   *
+   */
+  evMaxVoltage: number;
+  /**
+   * DC_ Charging_ Parameters. Energy_ Amount. Energy_ Amount
+   * urn:x-oca:ocpp:uid:1:569217
+   * Amount of energy requested (in Wh). This inludes energy required for preconditioning.
+   *
+   */
+  energyAmount?: number;
+  /**
+   * DC_ Charging_ Parameters. EV_ Max. Power
+   * urn:x-oca:ocpp:uid:1:569218
+   * Maximum power (in W) supported by the electric vehicle. Required for DC charging.
+   *
+   */
+  evMaxPower?: number;
+  /**
+   * DC_ Charging_ Parameters. State_ Of_ Charge. Numeric
+   * urn:x-oca:ocpp:uid:1:569219
+   * Energy available in the battery (in percent of the battery capacity)
+   *
+   */
+  stateOfCharge?: number;
+  /**
+   * DC_ Charging_ Parameters. EV_ Energy_ Capacity. Numeric
+   * urn:x-oca:ocpp:uid:1:569220
+   * Capacity of the electric vehicle battery (in Wh)
+   *
+   */
+  evEnergyCapacity?: number;
+  /**
+   * DC_ Charging_ Parameters. Full_ SOC. Percentage
+   * urn:x-oca:ocpp:uid:1:569221
+   * Percentage of SoC at which the EV considers the battery fully charged. (possible values: 0 - 100)
+   *
+   */
+  fullSoC?: number;
+  /**
+   * DC_ Charging_ Parameters. Bulk_ SOC. Percentage
+   * urn:x-oca:ocpp:uid:1:569222
+   * Percentage of SoC at which the EV considers a fast charging process to end. (possible values: 0 - 100)
+   *
+   */
+  bulkSoC?: number;
+}

package/v2.0/NotifyEVChargingNeedsResponse.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.
+ */
+
+/**
+ * Returns whether the CSMS has been able to process the message successfully. It does not imply that the evChargingNeeds can be met with the current charging profile.
+ *
+ */
+export type NotifyEVChargingNeedsStatusEnumType = "Accepted" | "Rejected" | "Processing";
+
+export interface UrnOCPPCp220203NotifyEVChargingNeedsResponse {
+  customData?: CustomDataType;
+  status: NotifyEVChargingNeedsStatusEnumType;
+  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/NotifyEVChargingScheduleRequest.d.ts

@@ -0,0 +1,245 @@
+/* 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_ Schedule. Charging_ Rate_ Unit. Charging_ Rate_ Unit_ Code
+ * urn:x-oca:ocpp:uid:1:569238
+ * The unit of measure Limit is expressed in.
+ *
+ */
+export type ChargingRateUnitEnumType = "W" | "A";
+/**
+ * Cost. Cost_ Kind. Cost_ Kind_ Code
+ * urn:x-oca:ocpp:uid:1:569243
+ * The kind of cost referred to in the message element amount
+ *
+ */
+export type CostKindEnumType = "CarbonDioxideEmission" | "RelativePricePercentage" | "RenewableGenerationPercentage";
+
+export interface UrnOCPPCp220203NotifyEVChargingScheduleRequest {
+  customData?: CustomDataType;
+  /**
+   * Periods contained in the charging profile are relative to this point in time.
+   *
+   */
+  timeBase: string;
+  chargingSchedule: ChargingScheduleType;
+  /**
+   * The charging schedule contained in this notification applies to an EVSE. EvseId must be > 0.
+   *
+   */
+  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;
+}
+/**
+ * Charging_ Schedule
+ * urn:x-oca:ocpp:uid:2:233256
+ * Charging schedule structure defines a list of charging periods, as used in: GetCompositeSchedule.conf and ChargingProfile.
+ *
+ */
+export interface ChargingScheduleType {
+  customData?: CustomDataType;
+  /**
+   * Identifies the ChargingSchedule.
+   *
+   */
+  id: number;
+  /**
+   * Charging_ Schedule. Start_ Schedule. Date_ Time
+   * urn:x-oca:ocpp:uid:1:569237
+   * Starting point of an absolute schedule. If absent the schedule will be relative to start of charging.
+   *
+   */
+  startSchedule?: string;
+  /**
+   * Charging_ Schedule. Duration. Elapsed_ Time
+   * urn:x-oca:ocpp:uid:1:569236
+   * Duration of the charging schedule in seconds. If the duration is left empty, the last period will continue indefinitely or until end of the transaction if chargingProfilePurpose = TxProfile.
+   *
+   */
+  duration?: number;
+  chargingRateUnit: ChargingRateUnitEnumType;
+  /**
+   * @minItems 1
+   * @maxItems 1024
+   */
+  chargingSchedulePeriod: [ChargingSchedulePeriodType, ...ChargingSchedulePeriodType[]];
+  /**
+   * Charging_ Schedule. Min_ Charging_ Rate. Numeric
+   * urn:x-oca:ocpp:uid:1:569239
+   * Minimum charging rate supported by the EV. The unit of measure is defined by the chargingRateUnit. This parameter is intended to be used by a local smart charging algorithm to optimize the power allocation for in the case a charging process is inefficient at lower charging rates. Accepts at most one digit fraction (e.g. 8.1)
+   *
+   */
+  minChargingRate?: number;
+  salesTariff?: SalesTariffType;
+}
+/**
+ * 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;
+}
+/**
+ * Sales_ Tariff
+ * urn:x-oca:ocpp:uid:2:233272
+ * NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
+ *
+ */
+export interface SalesTariffType {
+  customData?: CustomDataType;
+  /**
+   * Identified_ Object. MRID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:569198
+   * SalesTariff identifier used to identify one sales tariff. An SAID remains a unique identifier for one schedule throughout a charging session.
+   *
+   */
+  id: number;
+  /**
+   * Sales_ Tariff. Sales. Tariff_ Description
+   * urn:x-oca:ocpp:uid:1:569283
+   * A human readable title/short description of the sales tariff e.g. for HMI display purposes.
+   *
+   */
+  salesTariffDescription?: string;
+  /**
+   * Sales_ Tariff. Num_ E_ Price_ Levels. Counter
+   * urn:x-oca:ocpp:uid:1:569284
+   * Defines the overall number of distinct price levels used across all provided SalesTariff elements.
+   *
+   */
+  numEPriceLevels?: number;
+  /**
+   * @minItems 1
+   * @maxItems 1024
+   */
+  salesTariffEntry: [SalesTariffEntryType, ...SalesTariffEntryType[]];
+}
+/**
+ * Sales_ Tariff_ Entry
+ * urn:x-oca:ocpp:uid:2:233271
+ *
+ */
+export interface SalesTariffEntryType {
+  customData?: CustomDataType;
+  relativeTimeInterval: RelativeTimeIntervalType;
+  /**
+   * Sales_ Tariff_ Entry. E_ Price_ Level. Unsigned_ Integer
+   * urn:x-oca:ocpp:uid:1:569281
+   * Defines the price level of this SalesTariffEntry (referring to NumEPriceLevels). Small values for the EPriceLevel represent a cheaper TariffEntry. Large values for the EPriceLevel represent a more expensive TariffEntry.
+   *
+   */
+  ePriceLevel?: number;
+  /**
+   * @minItems 1
+   * @maxItems 3
+   */
+  consumptionCost?:
+    | [ConsumptionCostType]
+    | [ConsumptionCostType, ConsumptionCostType]
+    | [ConsumptionCostType, ConsumptionCostType, ConsumptionCostType];
+}
+/**
+ * Relative_ Timer_ Interval
+ * urn:x-oca:ocpp:uid:2:233270
+ *
+ */
+export interface RelativeTimeIntervalType {
+  customData?: CustomDataType;
+  /**
+   * Relative_ Timer_ Interval. Start. Elapsed_ Time
+   * urn:x-oca:ocpp:uid:1:569279
+   * Start of the interval, in seconds from NOW.
+   *
+   */
+  start: number;
+  /**
+   * Relative_ Timer_ Interval. Duration. Elapsed_ Time
+   * urn:x-oca:ocpp:uid:1:569280
+   * Duration of the interval, in seconds.
+   *
+   */
+  duration?: number;
+}
+/**
+ * Consumption_ Cost
+ * urn:x-oca:ocpp:uid:2:233259
+ *
+ */
+export interface ConsumptionCostType {
+  customData?: CustomDataType;
+  /**
+   * Consumption_ Cost. Start_ Value. Numeric
+   * urn:x-oca:ocpp:uid:1:569246
+   * The lowest level of consumption that defines the starting point of this consumption block. The block interval extends to the start of the next interval.
+   *
+   */
+  startValue: number;
+  /**
+   * @minItems 1
+   * @maxItems 3
+   */
+  cost: [CostType] | [CostType, CostType] | [CostType, CostType, CostType];
+}
+/**
+ * Cost
+ * urn:x-oca:ocpp:uid:2:233258
+ *
+ */
+export interface CostType {
+  customData?: CustomDataType;
+  costKind: CostKindEnumType;
+  /**
+   * Cost. Amount. Amount
+   * urn:x-oca:ocpp:uid:1:569244
+   * The estimated or actual cost per kWh
+   *
+   */
+  amount: number;
+  /**
+   * Cost. Amount_ Multiplier. Integer
+   * urn:x-oca:ocpp:uid:1:569245
+   * Values: -3..3, The amountMultiplier defines the exponent to base 10 (dec). The final value is determined by: amount * 10 ^ amountMultiplier
+   *
+   */
+  amountMultiplier?: number;
+}

package/v2.0/NotifyEVChargingScheduleResponse.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.
+ */
+
+/**
+ * Returns whether the CSMS has been able to process the message successfully. It does not imply any approval of the charging schedule.
+ *
+ */
+export type GenericStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203NotifyEVChargingScheduleResponse {
+  customData?: CustomDataType;
+  status: GenericStatusEnumType;
+  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;
+}