ocpp-messages 0.1.0

package/v2.0/LogStatusNotificationRequest.d.ts

@@ -0,0 +1,38 @@
+/* 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 status of the log upload.
+ *
+ */
+export type UploadLogStatusEnumType =
+  | "BadMessage"
+  | "Idle"
+  | "NotSupportedOperation"
+  | "PermissionDenied"
+  | "Uploaded"
+  | "UploadFailure"
+  | "Uploading"
+  | "AcceptedCanceled";
+
+export interface UrnOCPPCp220203LogStatusNotificationRequest {
+  customData?: CustomDataType;
+  status: UploadLogStatusEnumType;
+  /**
+   * The request id that was provided in GetLogRequest that started this log upload. This field is mandatory,
+   * unless the message was triggered by a TriggerMessageRequest AND there is no log upload ongoing.
+   *
+   */
+  requestId?: 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/LogStatusNotificationResponse.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 UrnOCPPCp220203LogStatusNotificationResponse {
+  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/MeterValuesRequest.d.ts

@@ -0,0 +1,187 @@
+/* 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.
+ */
+
+/**
+ * Sampled_ Value. Context. Reading_ Context_ Code
+ * urn:x-oca:ocpp:uid:1:569261
+ * Type of detail value: start, end or sample. Default = "Sample.Periodic"
+ *
+ */
+export type ReadingContextEnumType =
+  | "Interruption.Begin"
+  | "Interruption.End"
+  | "Other"
+  | "Sample.Clock"
+  | "Sample.Periodic"
+  | "Transaction.Begin"
+  | "Transaction.End"
+  | "Trigger";
+/**
+ * Sampled_ Value. Measurand. Measurand_ Code
+ * urn:x-oca:ocpp:uid:1:569263
+ * Type of measurement. Default = "Energy.Active.Import.Register"
+ *
+ */
+export type MeasurandEnumType =
+  | "Current.Export"
+  | "Current.Import"
+  | "Current.Offered"
+  | "Energy.Active.Export.Register"
+  | "Energy.Active.Import.Register"
+  | "Energy.Reactive.Export.Register"
+  | "Energy.Reactive.Import.Register"
+  | "Energy.Active.Export.Interval"
+  | "Energy.Active.Import.Interval"
+  | "Energy.Active.Net"
+  | "Energy.Reactive.Export.Interval"
+  | "Energy.Reactive.Import.Interval"
+  | "Energy.Reactive.Net"
+  | "Energy.Apparent.Net"
+  | "Energy.Apparent.Import"
+  | "Energy.Apparent.Export"
+  | "Frequency"
+  | "Power.Active.Export"
+  | "Power.Active.Import"
+  | "Power.Factor"
+  | "Power.Offered"
+  | "Power.Reactive.Export"
+  | "Power.Reactive.Import"
+  | "SoC"
+  | "Voltage";
+/**
+ * Sampled_ Value. Phase. Phase_ Code
+ * urn:x-oca:ocpp:uid:1:569264
+ * Indicates how the measured value is to be interpreted. For instance between L1 and neutral (L1-N) Please note that not all values of phase are applicable to all Measurands. When phase is absent, the measured value is interpreted as an overall value.
+ *
+ */
+export type PhaseEnumType = "L1" | "L2" | "L3" | "N" | "L1-N" | "L2-N" | "L3-N" | "L1-L2" | "L2-L3" | "L3-L1";
+/**
+ * Sampled_ Value. Location. Location_ Code
+ * urn:x-oca:ocpp:uid:1:569265
+ * Indicates where the measured value has been sampled. Default =  "Outlet"
+ *
+ *
+ */
+export type LocationEnumType = "Body" | "Cable" | "EV" | "Inlet" | "Outlet";
+
+/**
+ * Request_ Body
+ * urn:x-enexis:ecdm:uid:2:234744
+ *
+ */
+export interface UrnOCPPCp220203MeterValuesRequest {
+  customData?: CustomDataType;
+  /**
+   * Request_ Body. EVSEID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:571101
+   * This contains a number (>0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter.
+   *
+   */
+  evseId: number;
+  /**
+   * @minItems 1
+   */
+  meterValue: [MeterValueType, ...MeterValueType[]];
+}
+/**
+ * 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;
+}
+/**
+ * Meter_ Value
+ * urn:x-oca:ocpp:uid:2:233265
+ * Collection of one or more sampled values in MeterValuesRequest and TransactionEvent. All sampled values in a MeterValue are sampled at the same point in time.
+ *
+ */
+export interface MeterValueType {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  sampledValue: [SampledValueType, ...SampledValueType[]];
+  /**
+   * Meter_ Value. Timestamp. Date_ Time
+   * urn:x-oca:ocpp:uid:1:569259
+   * Timestamp for measured value(s).
+   *
+   */
+  timestamp: string;
+}
+/**
+ * Sampled_ Value
+ * urn:x-oca:ocpp:uid:2:233266
+ * Single sampled value in MeterValues. Each value can be accompanied by optional fields.
+ *
+ * To save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.
+ *
+ */
+export interface SampledValueType {
+  customData?: CustomDataType;
+  /**
+   * Sampled_ Value. Value. Measure
+   * urn:x-oca:ocpp:uid:1:569260
+   * Indicates the measured value.
+   *
+   *
+   */
+  value: number;
+  context?: ReadingContextEnumType;
+  measurand?: MeasurandEnumType;
+  phase?: PhaseEnumType;
+  location?: LocationEnumType;
+  signedMeterValue?: SignedMeterValueType;
+  unitOfMeasure?: UnitOfMeasureType;
+}
+/**
+ * Represent a signed version of the meter value.
+ *
+ */
+export interface SignedMeterValueType {
+  customData?: CustomDataType;
+  /**
+   * Base64 encoded, contains the signed data which might contain more then just the meter value. It can contain information like timestamps, reference to a customer etc.
+   *
+   */
+  signedMeterData: string;
+  /**
+   * Method used to create the digital signature.
+   *
+   */
+  signingMethod: string;
+  /**
+   * Method used to encode the meter values before applying the digital signature algorithm.
+   *
+   */
+  encodingMethod: string;
+  /**
+   * Base64 encoded, sending depends on configuration variable _PublicKeyWithSignedMeterValue_.
+   *
+   */
+  publicKey: string;
+}
+/**
+ * Represents a UnitOfMeasure with a multiplier
+ *
+ */
+export interface UnitOfMeasureType {
+  customData?: CustomDataType;
+  /**
+   * Unit of the value. Default = "Wh" if the (default) measurand is an "Energy" type.
+   * This field SHALL use a value from the list Standardized Units of Measurements in Part 2 Appendices.
+   * If an applicable unit is available in that list, otherwise a "custom" unit might be used.
+   *
+   */
+  unit?: string;
+  /**
+   * Multiplier, this value represents the exponent to base 10. I.e. multiplier 3 means 10 raised to the 3rd power. Default is 0.
+   *
+   */
+  multiplier?: number;
+}

package/v2.0/MeterValuesResponse.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 UrnOCPPCp220203MeterValuesResponse {
+  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/NotifyChargingLimitRequest.d.ts

@@ -0,0 +1,267 @@
+/* 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";
+/**
+ * Charging_ Limit. Charging_ Limit_ Source. Charging_ Limit_ Source_ Code
+ * urn:x-enexis:ecdm:uid:1:570845
+ * Represents the source of the charging limit.
+ *
+ */
+export type ChargingLimitSourceEnumType = "EMS" | "Other" | "SO" | "CSO";
+
+export interface UrnOCPPCp220203NotifyChargingLimitRequest {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  chargingSchedule?: [ChargingScheduleType, ...ChargingScheduleType[]];
+  /**
+   * The charging schedule contained in this notification applies to an EVSE. evseId must be > 0.
+   *
+   */
+  evseId?: number;
+  chargingLimit: ChargingLimitType;
+}
+/**
+ * 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;
+}
+/**
+ * Charging_ Limit
+ * urn:x-enexis:ecdm:uid:2:234489
+ *
+ */
+export interface ChargingLimitType {
+  customData?: CustomDataType;
+  chargingLimitSource: ChargingLimitSourceEnumType;
+  /**
+   * Charging_ Limit. Is_ Grid_ Critical. Indicator
+   * urn:x-enexis:ecdm:uid:1:570847
+   * Indicates whether the charging limit is critical for the grid.
+   *
+   */
+  isGridCritical?: boolean;
+}

package/v2.0/NotifyChargingLimitResponse.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 UrnOCPPCp220203NotifyChargingLimitResponse {
+  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/NotifyCustomerInformationRequest.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.
+ */
+
+export interface UrnOCPPCp220203NotifyCustomerInformationRequest {
+  customData?: CustomDataType;
+  /**
+   * (Part of) the requested data. No format specified in which the data is returned. Should be human readable.
+   *
+   */
+  data: string;
+  /**
+   * “to be continued” indicator. Indicates whether another part of the monitoringData follows in an upcoming notifyMonitoringReportRequest message. Default value when omitted is false.
+   *
+   */
+  tbc?: boolean;
+  /**
+   * Sequence number of this message. First message starts at 0.
+   *
+   */
+  seqNo: number;
+  /**
+   *  Timestamp of the moment this message was generated at the Charging Station.
+   *
+   */
+  generatedAt: string;
+  /**
+   * The Id of the request.
+   *
+   *
+   */
+  requestId: 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/NotifyCustomerInformationResponse.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 UrnOCPPCp220203NotifyCustomerInformationResponse {
+  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;
+}