ocpp-messages 0.1.0

package/v2.0/SetChargingProfileResponse.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 Charging Station has been able to process the message successfully. This does not guarantee the schedule will be followed to the letter. There might be other constraints the Charging Station may need to take into account.
+ *
+ */
+export type ChargingProfileStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203SetChargingProfileResponse {
+  customData?: CustomDataType;
+  status: ChargingProfileStatusEnumType;
+  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/SetDisplayMessageRequest.d.ts

@@ -0,0 +1,146 @@
+/* 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 UrnOCPPCp220203SetDisplayMessageRequest {
+  customData?: CustomDataType;
+  message: MessageInfoType;
+}
+/**
+ * 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/SetDisplayMessageResponse.d.ts

@@ -0,0 +1,48 @@
+/* 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 display the message.
+ *
+ */
+export type DisplayMessageStatusEnumType =
+  | "Accepted"
+  | "NotSupportedMessageFormat"
+  | "Rejected"
+  | "NotSupportedPriority"
+  | "NotSupportedState"
+  | "UnknownTransaction";
+
+export interface UrnOCPPCp220203SetDisplayMessageResponse {
+  customData?: CustomDataType;
+  status: DisplayMessageStatusEnumType;
+  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/SetMonitoringBaseRequest.d.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+/**
+ * Specify which monitoring base will be set
+ *
+ */
+export type MonitoringBaseEnumType = "All" | "FactoryDefault" | "HardWiredOnly";
+
+export interface UrnOCPPCp220203SetMonitoringBaseRequest {
+  customData?: CustomDataType;
+  monitoringBase: MonitoringBaseEnumType;
+}
+/**
+ * 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/SetMonitoringBaseResponse.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 Charging Station was able to accept the request.
+ *
+ */
+export type GenericDeviceModelStatusEnumType = "Accepted" | "Rejected" | "NotSupported" | "EmptyResultSet";
+
+export interface UrnOCPPCp220203SetMonitoringBaseResponse {
+  customData?: CustomDataType;
+  status: GenericDeviceModelStatusEnumType;
+  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/SetMonitoringLevelRequest.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.
+ */
+
+export interface UrnOCPPCp220203SetMonitoringLevelRequest {
+  customData?: CustomDataType;
+  /**
+   * The Charging Station SHALL only report events with a severity number lower than or equal to this severity.
+   * 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;
+}
+/**
+ * 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/SetMonitoringLevelResponse.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 Charging Station was able to accept the request.
+ *
+ */
+export type GenericStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203SetMonitoringLevelResponse {
+  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;
+}

package/v2.0/SetNetworkProfileRequest.d.ts

@@ -0,0 +1,198 @@
+/* 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.
+ */
+
+/**
+ * APN. APN_ Authentication. APN_ Authentication_ Code
+ * urn:x-oca:ocpp:uid:1:568828
+ * Authentication method.
+ *
+ */
+export type APNAuthenticationEnumType = "CHAP" | "NONE" | "PAP" | "AUTO";
+/**
+ * Communication_ Function. OCPP_ Version. OCPP_ Version_ Code
+ * urn:x-oca:ocpp:uid:1:569355
+ * Defines the OCPP version used for this communication function.
+ *
+ */
+export type OCPPVersionEnumType = "OCPP12" | "OCPP15" | "OCPP16" | "OCPP20";
+/**
+ * Communication_ Function. OCPP_ Transport. OCPP_ Transport_ Code
+ * urn:x-oca:ocpp:uid:1:569356
+ * Defines the transport protocol (e.g. SOAP or JSON). Note: SOAP is not supported in OCPP 2.0, but is supported by other versions of OCPP.
+ *
+ */
+export type OCPPTransportEnumType = "JSON" | "SOAP";
+/**
+ * Applicable Network Interface.
+ *
+ */
+export type OCPPInterfaceEnumType =
+  | "Wired0"
+  | "Wired1"
+  | "Wired2"
+  | "Wired3"
+  | "Wireless0"
+  | "Wireless1"
+  | "Wireless2"
+  | "Wireless3";
+/**
+ * VPN. Type. VPN_ Code
+ * urn:x-oca:ocpp:uid:1:569277
+ * Type of VPN
+ *
+ */
+export type VPNEnumType = "IKEv2" | "IPSec" | "L2TP" | "PPTP";
+
+export interface UrnOCPPCp220203SetNetworkProfileRequest {
+  customData?: CustomDataType;
+  /**
+   * Slot in which the configuration should be stored.
+   *
+   */
+  configurationSlot: number;
+  connectionData: NetworkConnectionProfileType;
+}
+/**
+ * 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;
+}
+/**
+ * Communication_ Function
+ * urn:x-oca:ocpp:uid:2:233304
+ * The NetworkConnectionProfile defines the functional and technical parameters of a communication link.
+ *
+ */
+export interface NetworkConnectionProfileType {
+  customData?: CustomDataType;
+  apn?: APNType;
+  ocppVersion: OCPPVersionEnumType;
+  ocppTransport: OCPPTransportEnumType;
+  /**
+   * Communication_ Function. OCPP_ Central_ System_ URL. URI
+   * urn:x-oca:ocpp:uid:1:569357
+   * URL of the CSMS(s) that this Charging Station  communicates with.
+   *
+   */
+  ocppCsmsUrl: string;
+  /**
+   * Duration in seconds before a message send by the Charging Station via this network connection times-out.
+   * The best setting depends on the underlying network and response times of the CSMS.
+   * If you are looking for a some guideline: use 30 seconds as a starting point.
+   *
+   */
+  messageTimeout: number;
+  /**
+   * This field specifies the security profile used when connecting to the CSMS with this NetworkConnectionProfile.
+   *
+   */
+  securityProfile: number;
+  ocppInterface: OCPPInterfaceEnumType;
+  vpn?: VPNType;
+}
+/**
+ * APN
+ * urn:x-oca:ocpp:uid:2:233134
+ * Collection of configuration data needed to make a data-connection over a cellular network.
+ *
+ * NOTE: When asking a GSM modem to dial in, it is possible to specify which mobile operator should be used. This can be done with the mobile country code (MCC) in combination with a mobile network code (MNC). Example: If your preferred network is Vodafone Netherlands, the MCC=204 and the MNC=04 which means the key PreferredNetwork = 20404 Some modems allows to specify a preferred network, which means, if this network is not available, a different network is used. If you specify UseOnlyPreferredNetwork and this network is not available, the modem will not dial in.
+ *
+ */
+export interface APNType {
+  customData?: CustomDataType;
+  /**
+   * APN. APN. URI
+   * urn:x-oca:ocpp:uid:1:568814
+   * The Access Point Name as an URL.
+   *
+   */
+  apn: string;
+  /**
+   * APN. APN. User_ Name
+   * urn:x-oca:ocpp:uid:1:568818
+   * APN username.
+   *
+   */
+  apnUserName?: string;
+  /**
+   * APN. APN. Password
+   * urn:x-oca:ocpp:uid:1:568819
+   * APN Password.
+   *
+   */
+  apnPassword?: string;
+  /**
+   * APN. SIMPIN. PIN_ Code
+   * urn:x-oca:ocpp:uid:1:568821
+   * SIM card pin code.
+   *
+   */
+  simPin?: number;
+  /**
+   * APN. Preferred_ Network. Mobile_ Network_ ID
+   * urn:x-oca:ocpp:uid:1:568822
+   * Preferred network, written as MCC and MNC concatenated. See note.
+   *
+   */
+  preferredNetwork?: string;
+  /**
+   * APN. Use_ Only_ Preferred_ Network. Indicator
+   * urn:x-oca:ocpp:uid:1:568824
+   * Default: false. Use only the preferred Network, do
+   * not dial in when not available. See Note.
+   *
+   */
+  useOnlyPreferredNetwork?: boolean;
+  apnAuthentication: APNAuthenticationEnumType;
+}
+/**
+ * VPN
+ * urn:x-oca:ocpp:uid:2:233268
+ * VPN Configuration settings
+ *
+ */
+export interface VPNType {
+  customData?: CustomDataType;
+  /**
+   * VPN. Server. URI
+   * urn:x-oca:ocpp:uid:1:569272
+   * VPN Server Address
+   *
+   */
+  server: string;
+  /**
+   * VPN. User. User_ Name
+   * urn:x-oca:ocpp:uid:1:569273
+   * VPN User
+   *
+   */
+  user: string;
+  /**
+   * VPN. Group. Group_ Name
+   * urn:x-oca:ocpp:uid:1:569274
+   * VPN group.
+   *
+   */
+  group?: string;
+  /**
+   * VPN. Password. Password
+   * urn:x-oca:ocpp:uid:1:569275
+   * VPN Password.
+   *
+   */
+  password: string;
+  /**
+   * VPN. Key. VPN_ Key
+   * urn:x-oca:ocpp:uid:1:569276
+   * VPN shared secret.
+   *
+   */
+  key: string;
+  type: VPNEnumType;
+}

package/v2.0/SetNetworkProfileResponse.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.
+ */
+
+/**
+ * Result of operation.
+ *
+ */
+export type SetNetworkProfileStatusEnumType = "Accepted" | "Rejected" | "Failed";
+
+export interface UrnOCPPCp220203SetNetworkProfileResponse {
+  customData?: CustomDataType;
+  status: SetNetworkProfileStatusEnumType;
+  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;
+}