ocpp-messages 0.1.0

package/v2.0/NotifyEventRequest.d.ts

@@ -0,0 +1,171 @@
+/* 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.
+ */
+
+/**
+ * Type of monitor that triggered this event, e.g. exceeding a threshold value.
+ *
+ *
+ */
+export type EventTriggerEnumType = "Alerting" | "Delta" | "Periodic";
+/**
+ * Specifies the event notification type of the message.
+ *
+ *
+ */
+export type EventNotificationEnumType =
+  | "HardWiredNotification"
+  | "HardWiredMonitor"
+  | "PreconfiguredMonitor"
+  | "CustomMonitor";
+
+export interface UrnOCPPCp220203NotifyEventRequest {
+  customData?: CustomDataType;
+  /**
+   * Timestamp of the moment this message was generated at the Charging Station.
+   *
+   */
+  generatedAt: string;
+  /**
+   * “to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyEventRequest message. Default value when omitted is false.
+   *
+   */
+  tbc?: boolean;
+  /**
+   * Sequence number of this message. First message starts at 0.
+   *
+   */
+  seqNo: number;
+  /**
+   * @minItems 1
+   */
+  eventData: [EventDataType, ...EventDataType[]];
+}
+/**
+ * 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;
+}
+/**
+ * Class to report an event notification for a component-variable.
+ *
+ */
+export interface EventDataType {
+  customData?: CustomDataType;
+  /**
+   * Identifies the event. This field can be referred to as a cause by other events.
+   *
+   *
+   */
+  eventId: number;
+  /**
+   * Timestamp of the moment the report was generated.
+   *
+   */
+  timestamp: string;
+  trigger: EventTriggerEnumType;
+  /**
+   * Refers to the Id of an event that is considered to be the cause for this event.
+   *
+   *
+   */
+  cause?: number;
+  /**
+   * Actual value (_attributeType_ Actual) of the variable.
+   *
+   * The Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal.
+   *
+   *
+   */
+  actualValue: string;
+  /**
+   * Technical (error) code as reported by component.
+   *
+   */
+  techCode?: string;
+  /**
+   * Technical detail information as reported by component.
+   *
+   */
+  techInfo?: string;
+  /**
+   * _Cleared_ is set to true to report the clearing of a monitored situation, i.e. a 'return to normal'.
+   *
+   *
+   */
+  cleared?: boolean;
+  /**
+   * If an event notification is linked to a specific transaction, this field can be used to specify its transactionId.
+   *
+   */
+  transactionId?: string;
+  component: ComponentType;
+  /**
+   * Identifies the VariableMonitoring which triggered the event.
+   *
+   */
+  variableMonitoringId?: number;
+  eventNotificationType: EventNotificationEnumType;
+  variable: VariableType;
+}
+/**
+ * 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;
+}
+/**
+ * Reference key to a component-variable.
+ *
+ */
+export interface VariableType {
+  customData?: CustomDataType;
+  /**
+   * Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  name: string;
+  /**
+   * Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  instance?: string;
+}

package/v2.0/NotifyEventResponse.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 UrnOCPPCp220203NotifyEventResponse {
+  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/NotifyMonitoringReportRequest.d.ts

@@ -0,0 +1,168 @@
+/* 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 type of this monitor, e.g. a threshold, delta or periodic monitor.
+ *
+ */
+export type MonitorEnumType = "UpperThreshold" | "LowerThreshold" | "Delta" | "Periodic" | "PeriodicClockAligned";
+
+export interface UrnOCPPCp220203NotifyMonitoringReportRequest {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  monitor?: [MonitoringDataType, ...MonitoringDataType[]];
+  /**
+   * The id of the GetMonitoringRequest that requested this report.
+   *
+   *
+   */
+  requestId: number;
+  /**
+   * “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;
+}
+/**
+ * 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;
+}
+/**
+ * Class to hold parameters of SetVariableMonitoring request.
+ *
+ */
+export interface MonitoringDataType {
+  customData?: CustomDataType;
+  component: ComponentType;
+  variable: VariableType;
+  /**
+   * @minItems 1
+   */
+  variableMonitoring: [VariableMonitoringType, ...VariableMonitoringType[]];
+}
+/**
+ * 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;
+}
+/**
+ * Reference key to a component-variable.
+ *
+ */
+export interface VariableType {
+  customData?: CustomDataType;
+  /**
+   * Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  name: string;
+  /**
+   * Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  instance?: string;
+}
+/**
+ * A monitoring setting for a variable.
+ *
+ */
+export interface VariableMonitoringType {
+  customData?: CustomDataType;
+  /**
+   * Identifies the monitor.
+   *
+   */
+  id: number;
+  /**
+   * Monitor only active when a transaction is ongoing on a component relevant to this transaction.
+   *
+   */
+  transaction: boolean;
+  /**
+   * Value for threshold or delta monitoring.
+   * For Periodic or PeriodicClockAligned this is the interval in seconds.
+   *
+   */
+  value: number;
+  type: MonitorEnumType;
+  /**
+   * The severity that will be assigned to an event that is triggered by this monitor. The severity range is 0-9, with 0 as the highest and 9 as the lowest severity level.
+   *
+   * The severity levels have the following meaning: +
+   * *0-Danger* +
+   * Indicates lives are potentially in danger. Urgent attention is needed and action should be taken immediately. +
+   * *1-Hardware Failure* +
+   * Indicates that the Charging Station is unable to continue regular operations due to Hardware issues. Action is required. +
+   * *2-System Failure* +
+   * Indicates that the Charging Station is unable to continue regular operations due to software or minor hardware issues. Action is required. +
+   * *3-Critical* +
+   * Indicates a critical error. Action is required. +
+   * *4-Error* +
+   * Indicates a non-urgent error. Action is required. +
+   * *5-Alert* +
+   * Indicates an alert event. Default severity for any type of monitoring event.  +
+   * *6-Warning* +
+   * Indicates a warning event. Action may be required. +
+   * *7-Notice* +
+   * Indicates an unusual event. No immediate action is required. +
+   * *8-Informational* +
+   * Indicates a regular operational event. May be used for reporting, measuring throughput, etc. No action is required. +
+   * *9-Debug* +
+   * Indicates information useful to developers for debugging, not useful during operations.
+   *
+   */
+  severity: number;
+}

package/v2.0/NotifyMonitoringReportResponse.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 UrnOCPPCp220203NotifyMonitoringReportResponse {
+  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/NotifyReportRequest.d.ts

@@ -0,0 +1,212 @@
+/* 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.
+ */
+
+/**
+ * Attribute: Actual, MinSet, MaxSet, etc.
+ * Defaults to Actual if absent.
+ *
+ */
+export type AttributeEnumType = "Actual" | "Target" | "MinSet" | "MaxSet";
+/**
+ * Defines the mutability of this attribute. Default is ReadWrite when omitted.
+ *
+ */
+export type MutabilityEnumType = "ReadOnly" | "WriteOnly" | "ReadWrite";
+/**
+ * Data type of this variable.
+ *
+ */
+export type DataEnumType =
+  | "string"
+  | "decimal"
+  | "integer"
+  | "dateTime"
+  | "boolean"
+  | "OptionList"
+  | "SequenceList"
+  | "MemberList";
+
+export interface UrnOCPPCp220203NotifyReportRequest {
+  customData?: CustomDataType;
+  /**
+   * The id of the GetReportRequest  or GetBaseReportRequest that requested this report
+   *
+   */
+  requestId: number;
+  /**
+   * Timestamp of the moment this message was generated at the Charging Station.
+   *
+   */
+  generatedAt: string;
+  /**
+   * @minItems 1
+   */
+  reportData?: [ReportDataType, ...ReportDataType[]];
+  /**
+   * “to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyReportRequest message. Default value when omitted is false.
+   *
+   *
+   */
+  tbc?: boolean;
+  /**
+   * Sequence number of this message. First message starts at 0.
+   *
+   */
+  seqNo: 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;
+}
+/**
+ * Class to report components, variables and variable attributes and characteristics.
+ *
+ */
+export interface ReportDataType {
+  customData?: CustomDataType;
+  component: ComponentType;
+  variable: VariableType;
+  /**
+   * @minItems 1
+   * @maxItems 4
+   */
+  variableAttribute:
+    | [VariableAttributeType]
+    | [VariableAttributeType, VariableAttributeType]
+    | [VariableAttributeType, VariableAttributeType, VariableAttributeType]
+    | [VariableAttributeType, VariableAttributeType, VariableAttributeType, VariableAttributeType];
+  variableCharacteristics?: VariableCharacteristicsType;
+}
+/**
+ * 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;
+}
+/**
+ * Reference key to a component-variable.
+ *
+ */
+export interface VariableType {
+  customData?: CustomDataType;
+  /**
+   * Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  name: string;
+  /**
+   * Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.
+   *
+   */
+  instance?: string;
+}
+/**
+ * Attribute data of a variable.
+ *
+ */
+export interface VariableAttributeType {
+  customData?: CustomDataType;
+  type?: AttributeEnumType;
+  /**
+   * Value of the attribute. May only be omitted when mutability is set to 'WriteOnly'.
+   *
+   * The Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal.
+   *
+   */
+  value?: string;
+  mutability?: MutabilityEnumType;
+  /**
+   * If true, value will be persistent across system reboots or power down. Default when omitted is false.
+   *
+   */
+  persistent?: boolean;
+  /**
+   * If true, value that will never be changed by the Charging Station at runtime. Default when omitted is false.
+   *
+   */
+  constant?: boolean;
+}
+/**
+ * Fixed read-only parameters of a variable.
+ *
+ */
+export interface VariableCharacteristicsType {
+  customData?: CustomDataType;
+  /**
+   * Unit of the variable. When the transmitted value has a unit, this field SHALL be included.
+   *
+   */
+  unit?: string;
+  dataType: DataEnumType;
+  /**
+   * Minimum possible value of this variable.
+   *
+   */
+  minLimit?: number;
+  /**
+   * Maximum possible value of this variable. When the datatype of this Variable is String, OptionList, SequenceList or MemberList, this field defines the maximum length of the (CSV) string.
+   *
+   */
+  maxLimit?: number;
+  /**
+   * Allowed values when variable is Option/Member/SequenceList.
+   *
+   * * OptionList: The (Actual) Variable value must be a single value from the reported (CSV) enumeration list.
+   *
+   * * MemberList: The (Actual) Variable value  may be an (unordered) (sub-)set of the reported (CSV) valid values list.
+   *
+   * * SequenceList: The (Actual) Variable value  may be an ordered (priority, etc)  (sub-)set of the reported (CSV) valid values.
+   *
+   * This is a comma separated list.
+   *
+   * The Configuration Variable <<configkey-configuration-value-size,ConfigurationValueSize>> can be used to limit SetVariableData.attributeValue and VariableCharacteristics.valueList. The max size of these values will always remain equal.
+   *
+   *
+   */
+  valuesList?: string;
+  /**
+   * Flag indicating if this variable supports monitoring.
+   *
+   */
+  supportsMonitoring: boolean;
+}

package/v2.0/NotifyReportResponse.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 UrnOCPPCp220203NotifyReportResponse {
+  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/PublishFirmwareRequest.d.ts

@@ -0,0 +1,50 @@
+/* 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 UrnOCPPCp220203PublishFirmwareRequest {
+  customData?: CustomDataType;
+  /**
+   * This contains a string containing a URI pointing to a
+   * location from which to retrieve the firmware.
+   *
+   */
+  location: string;
+  /**
+   * This specifies how many times Charging Station must try
+   * to download the firmware 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 MD5 checksum over the entire firmware file as a hexadecimal string of length 32.
+   *
+   */
+  checksum: string;
+  /**
+   * The Id of the request.
+   *
+   */
+  requestId: 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;
+}

package/v2.0/PublishFirmwareResponse.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 whether the request was accepted.
+ *
+ */
+export type GenericStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203PublishFirmwareResponse {
+  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;
+}