ocpp-messages 0.2.3 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/compile.js +30 -2
- package/index.js +8 -0
- package/package.json +2 -1
- package/v2.0/AuthorizeResponse.d.ts +4 -4
- package/v2.0/BootNotificationResponse.d.ts +1 -1
- package/v2.0/CertificateSignedRequest.d.ts +2 -2
- package/v2.0/ChangeAvailabilityRequest.d.ts +1 -1
- package/v2.0/CostUpdatedRequest.d.ts +1 -1
- package/v2.0/GetCertificateStatusResponse.d.ts +1 -1
- package/v2.0/GetChargingProfilesRequest.d.ts +2 -2
- package/v2.0/GetChargingProfilesResponse.d.ts +1 -1
- package/v2.0/GetDisplayMessagesRequest.d.ts +1 -1
- package/v2.0/GetDisplayMessagesResponse.d.ts +1 -1
- package/v2.0/GetMonitoringReportRequest.d.ts +1 -1
- package/v2.0/GetReportRequest.d.ts +1 -1
- package/v2.0/GetVariablesRequest.d.ts +1 -1
- package/v2.0/GetVariablesResponse.d.ts +2 -2
- package/v2.0/MeterValuesRequest.d.ts +1 -1
- package/v2.0/NotifyChargingLimitRequest.d.ts +2 -2
- package/v2.0/NotifyDisplayMessagesRequest.d.ts +3 -3
- package/v2.0/NotifyEVChargingScheduleRequest.d.ts +2 -2
- package/v2.0/NotifyEventRequest.d.ts +2 -2
- package/v2.0/NotifyMonitoringReportRequest.d.ts +1 -1
- package/v2.0/NotifyReportRequest.d.ts +3 -3
- package/v2.0/ReportChargingProfilesRequest.d.ts +2 -2
- package/v2.0/RequestStartTransactionRequest.d.ts +3 -3
- package/v2.0/SendLocalListRequest.d.ts +4 -4
- package/v2.0/SetChargingProfileRequest.d.ts +1 -1
- package/v2.0/SetDisplayMessageRequest.d.ts +2 -2
- package/v2.0/SetVariableMonitoringRequest.d.ts +1 -1
- package/v2.0/SetVariableMonitoringResponse.d.ts +1 -1
- package/v2.0/SetVariablesRequest.d.ts +2 -2
- package/v2.0/SetVariablesResponse.d.ts +1 -1
- package/v2.0/SignCertificateRequest.d.ts +1 -1
- package/v2.0/TransactionEventRequest.d.ts +2 -2
- package/v2.0/TransactionEventResponse.d.ts +6 -6
- package/v2.0/TriggerMessageRequest.d.ts +1 -1
package/compile.js
CHANGED
|
@@ -2,6 +2,30 @@
|
|
|
2
2
|
const { compileFromFile } = require("json-schema-to-typescript");
|
|
3
3
|
const fs = require("fs");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Decode HTML entities in comments
|
|
7
|
+
* Converts HTML entities like < > & etc. to their actual characters
|
|
8
|
+
* @param {string} ts - The generated TypeScript code
|
|
9
|
+
* @returns {string} - The transformed TypeScript code
|
|
10
|
+
*/
|
|
11
|
+
function decodeHtmlEntities(ts) {
|
|
12
|
+
const entities = {
|
|
13
|
+
"<": "<",
|
|
14
|
+
">": ">",
|
|
15
|
+
"&": "&",
|
|
16
|
+
""": '"',
|
|
17
|
+
"'": "'",
|
|
18
|
+
"'": "'",
|
|
19
|
+
"/": "/",
|
|
20
|
+
"'": "'",
|
|
21
|
+
"/": "/",
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
return ts.replace(/&[#\w]+;/g, (entity) => {
|
|
25
|
+
return entities[entity] || entity;
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
|
|
5
29
|
/**
|
|
6
30
|
* Extract inline enum types with more than 3 values into named type aliases
|
|
7
31
|
* @param {string} ts - The generated TypeScript code
|
|
@@ -92,8 +116,10 @@ fs.readdir(__dirname + "/schema/v1.6", function (err, files) {
|
|
|
92
116
|
files.forEach(function (file) {
|
|
93
117
|
// compile from file
|
|
94
118
|
compileFromFile(`${__dirname}/schema/v1.6/${file}`).then((ts) => {
|
|
119
|
+
// Decode HTML entities in comments
|
|
120
|
+
let transformedTs = decodeHtmlEntities(ts);
|
|
95
121
|
// Extract large enums into named types
|
|
96
|
-
|
|
122
|
+
transformedTs = extractLargeEnums(transformedTs, file.replace(".json", ""));
|
|
97
123
|
fs.writeFileSync(`${__dirname}/v1.6/${file.replace(".json", ".d.ts")}`, transformedTs);
|
|
98
124
|
});
|
|
99
125
|
console.log(file);
|
|
@@ -128,8 +154,10 @@ fs.readdir(__dirname + "/schema/v2.0", function (err, files) {
|
|
|
128
154
|
// compile from schema
|
|
129
155
|
compile(schema, baseName)
|
|
130
156
|
.then((ts) => {
|
|
157
|
+
// Decode HTML entities in comments
|
|
158
|
+
let cleanedTs = decodeHtmlEntities(ts);
|
|
131
159
|
// Replace any remaining URN-based interface names with clean names
|
|
132
|
-
|
|
160
|
+
cleanedTs = cleanedTs.replace(/export interface Urn\w+/g, `export interface ${baseName}`);
|
|
133
161
|
// Extract large enums into named types
|
|
134
162
|
cleanedTs = extractLargeEnums(cleanedTs, baseName);
|
|
135
163
|
fs.writeFileSync(`${__dirname}/v2.0/${baseName}.d.ts`, cleanedTs);
|
package/index.js
ADDED
package/package.json
CHANGED
|
@@ -87,14 +87,14 @@ export interface IdTokenInfoType {
|
|
|
87
87
|
*/
|
|
88
88
|
cacheExpiryDateTime?: string;
|
|
89
89
|
/**
|
|
90
|
-
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in
|
|
90
|
+
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules this one.
|
|
91
91
|
*
|
|
92
92
|
*/
|
|
93
93
|
chargingPriority?: number;
|
|
94
94
|
/**
|
|
95
95
|
* ID_ Token. Language1. Language_ Code
|
|
96
96
|
* urn:x-oca:ocpp:uid:1:569374
|
|
97
|
-
* Preferred user interface language of identifier user. Contains a language code as defined in
|
|
97
|
+
* Preferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
98
98
|
*
|
|
99
99
|
*
|
|
100
100
|
*/
|
|
@@ -111,7 +111,7 @@ export interface IdTokenInfoType {
|
|
|
111
111
|
/**
|
|
112
112
|
* ID_ Token. Language2. Language_ Code
|
|
113
113
|
* urn:x-oca:ocpp:uid:1:569375
|
|
114
|
-
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in
|
|
114
|
+
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
115
115
|
*
|
|
116
116
|
*/
|
|
117
117
|
language2?: string;
|
|
@@ -164,7 +164,7 @@ export interface MessageContentType {
|
|
|
164
164
|
/**
|
|
165
165
|
* Message_ Content. Language. Language_ Code
|
|
166
166
|
* urn:x-enexis:ecdm:uid:1:570849
|
|
167
|
-
* Message language identifier. Contains a language code as defined in
|
|
167
|
+
* Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
168
168
|
*
|
|
169
169
|
*/
|
|
170
170
|
language?: string;
|
|
@@ -20,7 +20,7 @@ export interface BootNotificationResponse {
|
|
|
20
20
|
*/
|
|
21
21
|
currentTime: string;
|
|
22
22
|
/**
|
|
23
|
-
* When
|
|
23
|
+
* When <<cmn_registrationstatusenumtype,Status>> is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
interval: number;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Indicates the type of the signed certificate that is returned. When omitted the certificate is used for both the 15118 connection (if implemented) and the Charging Station to CSMS connection. This field is required when a typeOfCertificate was included in the
|
|
9
|
+
* Indicates the type of the signed certificate that is returned. When omitted the certificate is used for both the 15118 connection (if implemented) and the Charging Station to CSMS connection. This field is required when a typeOfCertificate was included in the <<signcertificaterequest,SignCertificateRequest>> that requested this certificate to be signed AND both the 15118 connection and the Charging Station connection are implemented.
|
|
10
10
|
*
|
|
11
11
|
*
|
|
12
12
|
*/
|
|
@@ -17,7 +17,7 @@ export interface CertificateSignedRequest {
|
|
|
17
17
|
/**
|
|
18
18
|
* The signed PEM encoded X.509 certificate. This can also contain the necessary sub CA certificates. In that case, the order of the bundle should follow the certificate chain, starting from the leaf certificate.
|
|
19
19
|
*
|
|
20
|
-
* The Configuration Variable
|
|
20
|
+
* The Configuration Variable <<configkey-max-certificate-chain-size,MaxCertificateChainSize>> can be used to limit the maximum size of this field.
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
23
|
certificateChain: string;
|
|
@@ -35,7 +35,7 @@ export interface EVSEType {
|
|
|
35
35
|
/**
|
|
36
36
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
37
37
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
38
|
-
* EVSE Identifier. This contains a number (
|
|
38
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
41
|
id: number;
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
export interface CostUpdatedRequest {
|
|
9
9
|
customData?: CustomDataType;
|
|
10
10
|
/**
|
|
11
|
-
* Current total cost, based on the information known by the CSMS, of the transaction including taxes. In the currency configured with the configuration Variable: [
|
|
11
|
+
* Current total cost, based on the information known by the CSMS, of the transaction including taxes. In the currency configured with the configuration Variable: [<<configkey-currency, Currency>>]
|
|
12
12
|
*
|
|
13
13
|
*
|
|
14
14
|
*/
|
|
@@ -16,7 +16,7 @@ export interface GetCertificateStatusResponse {
|
|
|
16
16
|
status: GetCertificateStatusEnumType;
|
|
17
17
|
statusInfo?: StatusInfoType;
|
|
18
18
|
/**
|
|
19
|
-
* OCSPResponse class as defined in
|
|
19
|
+
* OCSPResponse class as defined in <<ref-ocpp_security_24, IETF RFC 6960>>. DER encoded (as defined in <<ref-ocpp_security_24, IETF RFC 6960>>), and then base64 encoded. MAY only be omitted when status is not Accepted.
|
|
20
20
|
*
|
|
21
21
|
*/
|
|
22
22
|
ocspResult?: string;
|
|
@@ -21,7 +21,7 @@ export type ChargingLimitSourceEnumType = "EMS" | "Other" | "SO" | "CSO";
|
|
|
21
21
|
export interface GetChargingProfilesRequest {
|
|
22
22
|
customData?: CustomDataType;
|
|
23
23
|
/**
|
|
24
|
-
* Reference identification that is to be used by the Charging Station in the
|
|
24
|
+
* Reference identification that is to be used by the Charging Station in the <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> when provided.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
requestId: number;
|
|
@@ -56,7 +56,7 @@ export interface ChargingProfileCriterionType {
|
|
|
56
56
|
*/
|
|
57
57
|
stackLevel?: number;
|
|
58
58
|
/**
|
|
59
|
-
* 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
|
|
59
|
+
* 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>>
|
|
60
60
|
*
|
|
61
61
|
*
|
|
62
62
|
*
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* This indicates whether the Charging Station is able to process this request and will send
|
|
9
|
+
* This indicates whether the Charging Station is able to process this request and will send <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> messages.
|
|
10
10
|
*
|
|
11
11
|
*/
|
|
12
12
|
export type GetChargingProfileStatusEnumType = "Accepted" | "NoProfiles";
|
|
@@ -19,7 +19,7 @@ export type MessageStateEnumType = "Charging" | "Faulted" | "Idle" | "Unavailabl
|
|
|
19
19
|
export interface GetDisplayMessagesRequest {
|
|
20
20
|
customData?: CustomDataType;
|
|
21
21
|
/**
|
|
22
|
-
* If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in
|
|
22
|
+
* 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>>
|
|
23
23
|
*
|
|
24
24
|
*
|
|
25
25
|
*
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Indicates if the Charging Station has Display Messages that match the request criteria in the
|
|
9
|
+
* Indicates if the Charging Station has Display Messages that match the request criteria in the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>>
|
|
10
10
|
*
|
|
11
11
|
*/
|
|
12
12
|
export type GetDisplayMessagesStatusEnumType = "Accepted" | "Unknown";
|
|
@@ -75,7 +75,7 @@ export interface EVSEType {
|
|
|
75
75
|
/**
|
|
76
76
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
77
77
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
78
|
-
* EVSE Identifier. This contains a number (
|
|
78
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
79
79
|
*
|
|
80
80
|
*/
|
|
81
81
|
id: number;
|
|
@@ -76,7 +76,7 @@ export interface EVSEType {
|
|
|
76
76
|
/**
|
|
77
77
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
78
78
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
79
|
-
* EVSE Identifier. This contains a number (
|
|
79
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
80
80
|
*
|
|
81
81
|
*/
|
|
82
82
|
id: number;
|
|
@@ -64,7 +64,7 @@ export interface EVSEType {
|
|
|
64
64
|
/**
|
|
65
65
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
66
66
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
67
|
-
* EVSE Identifier. This contains a number (
|
|
67
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
68
68
|
*
|
|
69
69
|
*/
|
|
70
70
|
id: number;
|
|
@@ -48,7 +48,7 @@ export interface GetVariableResultType {
|
|
|
48
48
|
/**
|
|
49
49
|
* Value of requested attribute type of component-variable. This field can only be empty when the given status is NOT accepted.
|
|
50
50
|
*
|
|
51
|
-
* The Configuration Variable
|
|
51
|
+
* 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.
|
|
52
52
|
*
|
|
53
53
|
*
|
|
54
54
|
*/
|
|
@@ -102,7 +102,7 @@ export interface EVSEType {
|
|
|
102
102
|
/**
|
|
103
103
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
104
104
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
105
|
-
* EVSE Identifier. This contains a number (
|
|
105
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
106
106
|
*
|
|
107
107
|
*/
|
|
108
108
|
id: number;
|
|
@@ -78,7 +78,7 @@ export interface MeterValuesRequest {
|
|
|
78
78
|
/**
|
|
79
79
|
* Request_ Body. EVSEID. Numeric_ Identifier
|
|
80
80
|
* urn:x-enexis:ecdm:uid:1:571101
|
|
81
|
-
* This contains a number (
|
|
81
|
+
* This contains a number (>0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter.
|
|
82
82
|
*
|
|
83
83
|
*/
|
|
84
84
|
evseId: number;
|
|
@@ -34,7 +34,7 @@ export interface NotifyChargingLimitRequest {
|
|
|
34
34
|
*/
|
|
35
35
|
chargingSchedule?: [ChargingScheduleType, ...ChargingScheduleType[]];
|
|
36
36
|
/**
|
|
37
|
-
* The charging schedule contained in this notification applies to an EVSE. evseId must be
|
|
37
|
+
* The charging schedule contained in this notification applies to an EVSE. evseId must be > 0.
|
|
38
38
|
*
|
|
39
39
|
*/
|
|
40
40
|
evseId?: number;
|
|
@@ -128,7 +128,7 @@ export interface ChargingSchedulePeriodType {
|
|
|
128
128
|
/**
|
|
129
129
|
* Sales_ Tariff
|
|
130
130
|
* urn:x-oca:ocpp:uid:2:233272
|
|
131
|
-
* NOTE: This dataType is based on dataTypes from
|
|
131
|
+
* NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
|
|
132
132
|
*
|
|
133
133
|
*/
|
|
134
134
|
export interface SalesTariffType {
|
|
@@ -34,7 +34,7 @@ export interface NotifyDisplayMessagesRequest {
|
|
|
34
34
|
*/
|
|
35
35
|
messageInfo?: [MessageInfoType, ...MessageInfoType[]];
|
|
36
36
|
/**
|
|
37
|
-
* The id of the
|
|
37
|
+
* The id of the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>> that requested this message.
|
|
38
38
|
*
|
|
39
39
|
*/
|
|
40
40
|
requestId: number;
|
|
@@ -121,7 +121,7 @@ export interface EVSEType {
|
|
|
121
121
|
/**
|
|
122
122
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
123
123
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
124
|
-
* EVSE Identifier. This contains a number (
|
|
124
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
125
125
|
*
|
|
126
126
|
*/
|
|
127
127
|
id: number;
|
|
@@ -144,7 +144,7 @@ export interface MessageContentType {
|
|
|
144
144
|
/**
|
|
145
145
|
* Message_ Content. Language. Language_ Code
|
|
146
146
|
* urn:x-enexis:ecdm:uid:1:570849
|
|
147
|
-
* Message language identifier. Contains a language code as defined in
|
|
147
|
+
* Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
148
148
|
*
|
|
149
149
|
*/
|
|
150
150
|
language?: string;
|
|
@@ -29,7 +29,7 @@ export interface NotifyEVChargingScheduleRequest {
|
|
|
29
29
|
timeBase: string;
|
|
30
30
|
chargingSchedule: ChargingScheduleType;
|
|
31
31
|
/**
|
|
32
|
-
* The charging schedule contained in this notification applies to an EVSE. EvseId must be
|
|
32
|
+
* The charging schedule contained in this notification applies to an EVSE. EvseId must be > 0.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
evseId: number;
|
|
@@ -122,7 +122,7 @@ export interface ChargingSchedulePeriodType {
|
|
|
122
122
|
/**
|
|
123
123
|
* Sales_ Tariff
|
|
124
124
|
* urn:x-oca:ocpp:uid:2:233272
|
|
125
|
-
* NOTE: This dataType is based on dataTypes from
|
|
125
|
+
* NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
|
|
126
126
|
*
|
|
127
127
|
*/
|
|
128
128
|
export interface SalesTariffType {
|
|
@@ -78,7 +78,7 @@ export interface EventDataType {
|
|
|
78
78
|
/**
|
|
79
79
|
* Actual value (_attributeType_ Actual) of the variable.
|
|
80
80
|
*
|
|
81
|
-
* The Configuration Variable
|
|
81
|
+
* 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.
|
|
82
82
|
*
|
|
83
83
|
*
|
|
84
84
|
*/
|
|
@@ -142,7 +142,7 @@ export interface EVSEType {
|
|
|
142
142
|
/**
|
|
143
143
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
144
144
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
145
|
-
* EVSE Identifier. This contains a number (
|
|
145
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
146
146
|
*
|
|
147
147
|
*/
|
|
148
148
|
id: number;
|
|
@@ -88,7 +88,7 @@ export interface EVSEType {
|
|
|
88
88
|
/**
|
|
89
89
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
90
90
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
91
|
-
* EVSE Identifier. This contains a number (
|
|
91
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
92
92
|
*
|
|
93
93
|
*/
|
|
94
94
|
id: number;
|
|
@@ -113,7 +113,7 @@ export interface EVSEType {
|
|
|
113
113
|
/**
|
|
114
114
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
115
115
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
116
|
-
* EVSE Identifier. This contains a number (
|
|
116
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
117
117
|
*
|
|
118
118
|
*/
|
|
119
119
|
id: number;
|
|
@@ -150,7 +150,7 @@ export interface VariableAttributeType {
|
|
|
150
150
|
/**
|
|
151
151
|
* Value of the attribute. May only be omitted when mutability is set to 'WriteOnly'.
|
|
152
152
|
*
|
|
153
|
-
* The Configuration Variable
|
|
153
|
+
* 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.
|
|
154
154
|
*
|
|
155
155
|
*/
|
|
156
156
|
value?: string;
|
|
@@ -199,7 +199,7 @@ export interface VariableCharacteristicsType {
|
|
|
199
199
|
*
|
|
200
200
|
* This is a comma separated list.
|
|
201
201
|
*
|
|
202
|
-
* The Configuration Variable
|
|
202
|
+
* 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.
|
|
203
203
|
*
|
|
204
204
|
*
|
|
205
205
|
*/
|
|
@@ -53,7 +53,7 @@ export type CostKindEnumType = "CarbonDioxideEmission" | "RelativePricePercentag
|
|
|
53
53
|
export interface ReportChargingProfilesRequest {
|
|
54
54
|
customData?: CustomDataType;
|
|
55
55
|
/**
|
|
56
|
-
* Id used to match the
|
|
56
|
+
* Id used to match the <<getchargingprofilesrequest, GetChargingProfilesRequest>> message with the resulting ReportChargingProfilesRequest messages. When the CSMS provided a requestId in the <<getchargingprofilesrequest, GetChargingProfilesRequest>>, this field SHALL contain the same value.
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
requestId: number;
|
|
@@ -214,7 +214,7 @@ export interface ChargingSchedulePeriodType {
|
|
|
214
214
|
/**
|
|
215
215
|
* Sales_ Tariff
|
|
216
216
|
* urn:x-oca:ocpp:uid:2:233272
|
|
217
|
-
* NOTE: This dataType is based on dataTypes from
|
|
217
|
+
* NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
|
|
218
218
|
*
|
|
219
219
|
*/
|
|
220
220
|
export interface SalesTariffType {
|
|
@@ -61,14 +61,14 @@ export type CostKindEnumType = "CarbonDioxideEmission" | "RelativePricePercentag
|
|
|
61
61
|
export interface RequestStartTransactionRequest {
|
|
62
62
|
customData?: CustomDataType;
|
|
63
63
|
/**
|
|
64
|
-
* Number of the EVSE on which to start the transaction. EvseId SHALL be
|
|
64
|
+
* Number of the EVSE on which to start the transaction. EvseId SHALL be > 0
|
|
65
65
|
*
|
|
66
66
|
*/
|
|
67
67
|
evseId?: number;
|
|
68
68
|
groupIdToken?: IdTokenType;
|
|
69
69
|
idToken: IdTokenType;
|
|
70
70
|
/**
|
|
71
|
-
* Id given by the server to this start request. The Charging Station might return this in the
|
|
71
|
+
* Id given by the server to this start request. The Charging Station might return this in the <<transactioneventrequest, TransactionEventRequest>>, letting the server know which transaction was started for this request. Use to start a transaction.
|
|
72
72
|
*
|
|
73
73
|
*/
|
|
74
74
|
remoteStartId: number;
|
|
@@ -249,7 +249,7 @@ export interface ChargingSchedulePeriodType {
|
|
|
249
249
|
/**
|
|
250
250
|
* Sales_ Tariff
|
|
251
251
|
* urn:x-oca:ocpp:uid:2:233272
|
|
252
|
-
* NOTE: This dataType is based on dataTypes from
|
|
252
|
+
* NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
|
|
253
253
|
*
|
|
254
254
|
*/
|
|
255
255
|
export interface SalesTariffType {
|
|
@@ -129,14 +129,14 @@ export interface IdTokenInfoType {
|
|
|
129
129
|
*/
|
|
130
130
|
cacheExpiryDateTime?: string;
|
|
131
131
|
/**
|
|
132
|
-
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in
|
|
132
|
+
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules this one.
|
|
133
133
|
*
|
|
134
134
|
*/
|
|
135
135
|
chargingPriority?: number;
|
|
136
136
|
/**
|
|
137
137
|
* ID_ Token. Language1. Language_ Code
|
|
138
138
|
* urn:x-oca:ocpp:uid:1:569374
|
|
139
|
-
* Preferred user interface language of identifier user. Contains a language code as defined in
|
|
139
|
+
* Preferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
140
140
|
*
|
|
141
141
|
*
|
|
142
142
|
*/
|
|
@@ -153,7 +153,7 @@ export interface IdTokenInfoType {
|
|
|
153
153
|
/**
|
|
154
154
|
* ID_ Token. Language2. Language_ Code
|
|
155
155
|
* urn:x-oca:ocpp:uid:1:569375
|
|
156
|
-
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in
|
|
156
|
+
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
157
157
|
*
|
|
158
158
|
*/
|
|
159
159
|
language2?: string;
|
|
@@ -172,7 +172,7 @@ export interface MessageContentType {
|
|
|
172
172
|
/**
|
|
173
173
|
* Message_ Content. Language. Language_ Code
|
|
174
174
|
* urn:x-enexis:ecdm:uid:1:570849
|
|
175
|
-
* Message language identifier. Contains a language code as defined in
|
|
175
|
+
* Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
176
176
|
*
|
|
177
177
|
*/
|
|
178
178
|
language?: string;
|
|
@@ -195,7 +195,7 @@ export interface ChargingSchedulePeriodType {
|
|
|
195
195
|
/**
|
|
196
196
|
* Sales_ Tariff
|
|
197
197
|
* urn:x-oca:ocpp:uid:2:233272
|
|
198
|
-
* NOTE: This dataType is based on dataTypes from
|
|
198
|
+
* NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
|
|
199
199
|
*
|
|
200
200
|
*/
|
|
201
201
|
export interface SalesTariffType {
|
|
@@ -108,7 +108,7 @@ export interface EVSEType {
|
|
|
108
108
|
/**
|
|
109
109
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
110
110
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
111
|
-
* EVSE Identifier. This contains a number (
|
|
111
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
112
112
|
*
|
|
113
113
|
*/
|
|
114
114
|
id: number;
|
|
@@ -131,7 +131,7 @@ export interface MessageContentType {
|
|
|
131
131
|
/**
|
|
132
132
|
* Message_ Content. Language. Language_ Code
|
|
133
133
|
* urn:x-enexis:ecdm:uid:1:570849
|
|
134
|
-
* Message language identifier. Contains a language code as defined in
|
|
134
|
+
* Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
135
135
|
*
|
|
136
136
|
*/
|
|
137
137
|
language?: string;
|
|
@@ -112,7 +112,7 @@ export interface EVSEType {
|
|
|
112
112
|
/**
|
|
113
113
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
114
114
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
115
|
-
* EVSE Identifier. This contains a number (
|
|
115
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
116
116
|
*
|
|
117
117
|
*/
|
|
118
118
|
id: number;
|
|
@@ -128,7 +128,7 @@ export interface EVSEType {
|
|
|
128
128
|
/**
|
|
129
129
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
130
130
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
131
|
-
* EVSE Identifier. This contains a number (
|
|
131
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
132
132
|
*
|
|
133
133
|
*/
|
|
134
134
|
id: number;
|
|
@@ -31,7 +31,7 @@ export interface SetVariableDataType {
|
|
|
31
31
|
/**
|
|
32
32
|
* Value to be assigned to attribute of variable.
|
|
33
33
|
*
|
|
34
|
-
* The Configuration Variable
|
|
34
|
+
* 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.
|
|
35
35
|
*
|
|
36
36
|
*/
|
|
37
37
|
attributeValue: string;
|
|
@@ -67,7 +67,7 @@ export interface EVSEType {
|
|
|
67
67
|
/**
|
|
68
68
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
69
69
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
70
|
-
* EVSE Identifier. This contains a number (
|
|
70
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
71
71
|
*
|
|
72
72
|
*/
|
|
73
73
|
id: number;
|
|
@@ -90,7 +90,7 @@ export interface EVSEType {
|
|
|
90
90
|
/**
|
|
91
91
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
92
92
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
93
|
-
* EVSE Identifier. This contains a number (
|
|
93
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
94
94
|
*
|
|
95
95
|
*/
|
|
96
96
|
id: number;
|
|
@@ -15,7 +15,7 @@ export type CertificateSigningUseEnumType = "ChargingStationCertificate" | "V2GC
|
|
|
15
15
|
export interface SignCertificateRequest {
|
|
16
16
|
customData?: CustomDataType;
|
|
17
17
|
/**
|
|
18
|
-
* The Charging Station SHALL send the public key in form of a Certificate Signing Request (CSR) as described in RFC 2986 [22] and then PEM encoded, using the
|
|
18
|
+
* The Charging Station SHALL send the public key in form of a Certificate Signing Request (CSR) as described in RFC 2986 [22] and then PEM encoded, using the <<signcertificaterequest,SignCertificateRequest>> message.
|
|
19
19
|
*
|
|
20
20
|
*/
|
|
21
21
|
csr: string;
|
|
@@ -309,7 +309,7 @@ export interface TransactionType {
|
|
|
309
309
|
timeSpentCharging?: number;
|
|
310
310
|
stoppedReason?: ReasonEnumType;
|
|
311
311
|
/**
|
|
312
|
-
* The ID given to remote start request (
|
|
312
|
+
* The ID given to remote start request (<<requeststarttransactionrequest, RequestStartTransactionRequest>>. This enables to CSMS to match the started transaction to the given start request.
|
|
313
313
|
*
|
|
314
314
|
*/
|
|
315
315
|
remoteStartId?: number;
|
|
@@ -325,7 +325,7 @@ export interface EVSEType {
|
|
|
325
325
|
/**
|
|
326
326
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
327
327
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
328
|
-
* EVSE Identifier. This contains a number (
|
|
328
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
329
329
|
*
|
|
330
330
|
*/
|
|
331
331
|
id: number;
|
|
@@ -46,13 +46,13 @@ export type MessageFormatEnumType = "ASCII" | "HTML" | "URI" | "UTF8";
|
|
|
46
46
|
export interface TransactionEventResponse {
|
|
47
47
|
customData?: CustomDataType;
|
|
48
48
|
/**
|
|
49
|
-
* SHALL only be sent when charging has ended. Final total cost of this transaction, including taxes. In the currency configured with the Configuration Variable:
|
|
49
|
+
* SHALL only be sent when charging has ended. Final total cost of this transaction, including taxes. In the currency configured with the Configuration Variable: <<configkey-currency,`Currency`>>. When omitted, the transaction was NOT free. To indicate a free transaction, the CSMS SHALL send 0.00.
|
|
50
50
|
*
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
53
|
totalCost?: number;
|
|
54
54
|
/**
|
|
55
|
-
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in
|
|
55
|
+
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> is temporarily, so it may not be set in the <<cmn_idtokeninfotype,IdTokenInfoType>> afterwards. Also the chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules the one in <<cmn_idtokeninfotype,IdTokenInfoType>>.
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
chargingPriority?: number;
|
|
@@ -84,14 +84,14 @@ export interface IdTokenInfoType {
|
|
|
84
84
|
*/
|
|
85
85
|
cacheExpiryDateTime?: string;
|
|
86
86
|
/**
|
|
87
|
-
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in
|
|
87
|
+
* Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules this one.
|
|
88
88
|
*
|
|
89
89
|
*/
|
|
90
90
|
chargingPriority?: number;
|
|
91
91
|
/**
|
|
92
92
|
* ID_ Token. Language1. Language_ Code
|
|
93
93
|
* urn:x-oca:ocpp:uid:1:569374
|
|
94
|
-
* Preferred user interface language of identifier user. Contains a language code as defined in
|
|
94
|
+
* Preferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
95
95
|
*
|
|
96
96
|
*
|
|
97
97
|
*/
|
|
@@ -108,7 +108,7 @@ export interface IdTokenInfoType {
|
|
|
108
108
|
/**
|
|
109
109
|
* ID_ Token. Language2. Language_ Code
|
|
110
110
|
* urn:x-oca:ocpp:uid:1:569375
|
|
111
|
-
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in
|
|
111
|
+
* Second preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
112
112
|
*
|
|
113
113
|
*/
|
|
114
114
|
language2?: string;
|
|
@@ -161,7 +161,7 @@ export interface MessageContentType {
|
|
|
161
161
|
/**
|
|
162
162
|
* Message_ Content. Language. Language_ Code
|
|
163
163
|
* urn:x-enexis:ecdm:uid:1:570849
|
|
164
|
-
* Message language identifier. Contains a language code as defined in
|
|
164
|
+
* Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.
|
|
165
165
|
*
|
|
166
166
|
*/
|
|
167
167
|
language?: string;
|
|
@@ -45,7 +45,7 @@ export interface EVSEType {
|
|
|
45
45
|
/**
|
|
46
46
|
* Identified_ Object. MRID. Numeric_ Identifier
|
|
47
47
|
* urn:x-enexis:ecdm:uid:1:569198
|
|
48
|
-
* EVSE Identifier. This contains a number (
|
|
48
|
+
* EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
|
|
49
49
|
*
|
|
50
50
|
*/
|
|
51
51
|
id: number;
|