Commit | Line | Data |
---|---|---|
d270cc87 JB |
1 | { |
2 | "$schema": "http://json-schema.org/draft-06/schema#", | |
3 | "$id": "urn:OCPP:Cp:2:2020:3:NotifyEVChargingNeedsRequest", | |
4 | "comment": "OCPP 2.0.1 FINAL", | |
5 | "definitions": { | |
6 | "CustomDataType": { | |
7 | "description": "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.", | |
8 | "javaType": "CustomData", | |
9 | "type": "object", | |
10 | "properties": { | |
11 | "vendorId": { | |
12 | "type": "string", | |
13 | "maxLength": 255 | |
14 | } | |
15 | }, | |
16 | "required": ["vendorId"] | |
17 | }, | |
18 | "EnergyTransferModeEnumType": { | |
19 | "description": "Charging_ Needs. Requested. Energy_ Transfer_ Mode_ Code\r\nurn:x-oca:ocpp:uid:1:569209\r\nMode of energy transfer requested by the EV.\r\n", | |
20 | "javaType": "EnergyTransferModeEnum", | |
21 | "type": "string", | |
22 | "additionalProperties": false, | |
23 | "enum": ["DC", "AC_single_phase", "AC_two_phase", "AC_three_phase"] | |
24 | }, | |
25 | "ACChargingParametersType": { | |
26 | "description": "AC_ Charging_ Parameters\r\nurn:x-oca:ocpp:uid:2:233250\r\nEV AC charging parameters.\r\n\r\n", | |
27 | "javaType": "ACChargingParameters", | |
28 | "type": "object", | |
29 | "additionalProperties": false, | |
30 | "properties": { | |
31 | "customData": { | |
32 | "$ref": "#/definitions/CustomDataType" | |
33 | }, | |
34 | "energyAmount": { | |
35 | "description": "AC_ Charging_ Parameters. Energy_ Amount. Energy_ Amount\r\nurn:x-oca:ocpp:uid:1:569211\r\nAmount of energy requested (in Wh). This includes energy required for preconditioning.\r\n", | |
36 | "type": "integer" | |
37 | }, | |
38 | "evMinCurrent": { | |
39 | "description": "AC_ Charging_ Parameters. EV_ Min. Current\r\nurn:x-oca:ocpp:uid:1:569212\r\nMinimum current (amps) supported by the electric vehicle (per phase).\r\n", | |
40 | "type": "integer" | |
41 | }, | |
42 | "evMaxCurrent": { | |
43 | "description": "AC_ Charging_ Parameters. EV_ Max. Current\r\nurn:x-oca:ocpp:uid:1:569213\r\nMaximum current (amps) supported by the electric vehicle (per phase). Includes cable capacity.\r\n", | |
44 | "type": "integer" | |
45 | }, | |
46 | "evMaxVoltage": { | |
47 | "description": "AC_ Charging_ Parameters. EV_ Max. Voltage\r\nurn:x-oca:ocpp:uid:1:569214\r\nMaximum voltage supported by the electric vehicle\r\n", | |
48 | "type": "integer" | |
49 | } | |
50 | }, | |
51 | "required": ["energyAmount", "evMinCurrent", "evMaxCurrent", "evMaxVoltage"] | |
52 | }, | |
53 | "ChargingNeedsType": { | |
54 | "description": "Charging_ Needs\r\nurn:x-oca:ocpp:uid:2:233249\r\n", | |
55 | "javaType": "ChargingNeeds", | |
56 | "type": "object", | |
57 | "additionalProperties": false, | |
58 | "properties": { | |
59 | "customData": { | |
60 | "$ref": "#/definitions/CustomDataType" | |
61 | }, | |
62 | "acChargingParameters": { | |
63 | "$ref": "#/definitions/ACChargingParametersType" | |
64 | }, | |
65 | "dcChargingParameters": { | |
66 | "$ref": "#/definitions/DCChargingParametersType" | |
67 | }, | |
68 | "requestedEnergyTransfer": { | |
69 | "$ref": "#/definitions/EnergyTransferModeEnumType" | |
70 | }, | |
71 | "departureTime": { | |
72 | "description": "Charging_ Needs. Departure_ Time. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569223\r\nEstimated departure time of the EV.\r\n", | |
73 | "type": "string", | |
74 | "format": "date-time" | |
75 | } | |
76 | }, | |
77 | "required": ["requestedEnergyTransfer"] | |
78 | }, | |
79 | "DCChargingParametersType": { | |
80 | "description": "DC_ Charging_ Parameters\r\nurn:x-oca:ocpp:uid:2:233251\r\nEV DC charging parameters\r\n\r\n\r\n", | |
81 | "javaType": "DCChargingParameters", | |
82 | "type": "object", | |
83 | "additionalProperties": false, | |
84 | "properties": { | |
85 | "customData": { | |
86 | "$ref": "#/definitions/CustomDataType" | |
87 | }, | |
88 | "evMaxCurrent": { | |
89 | "description": "DC_ Charging_ Parameters. EV_ Max. Current\r\nurn:x-oca:ocpp:uid:1:569215\r\nMaximum current (amps) supported by the electric vehicle. Includes cable capacity.\r\n", | |
90 | "type": "integer" | |
91 | }, | |
92 | "evMaxVoltage": { | |
93 | "description": "DC_ Charging_ Parameters. EV_ Max. Voltage\r\nurn:x-oca:ocpp:uid:1:569216\r\nMaximum voltage supported by the electric vehicle\r\n", | |
94 | "type": "integer" | |
95 | }, | |
96 | "energyAmount": { | |
97 | "description": "DC_ Charging_ Parameters. Energy_ Amount. Energy_ Amount\r\nurn:x-oca:ocpp:uid:1:569217\r\nAmount of energy requested (in Wh). This inludes energy required for preconditioning.\r\n", | |
98 | "type": "integer" | |
99 | }, | |
100 | "evMaxPower": { | |
101 | "description": "DC_ Charging_ Parameters. EV_ Max. Power\r\nurn:x-oca:ocpp:uid:1:569218\r\nMaximum power (in W) supported by the electric vehicle. Required for DC charging.\r\n", | |
102 | "type": "integer" | |
103 | }, | |
104 | "stateOfCharge": { | |
105 | "description": "DC_ Charging_ Parameters. State_ Of_ Charge. Numeric\r\nurn:x-oca:ocpp:uid:1:569219\r\nEnergy available in the battery (in percent of the battery capacity)\r\n", | |
106 | "type": "integer", | |
107 | "minimum": 0.0, | |
108 | "maximum": 100.0 | |
109 | }, | |
110 | "evEnergyCapacity": { | |
111 | "description": "DC_ Charging_ Parameters. EV_ Energy_ Capacity. Numeric\r\nurn:x-oca:ocpp:uid:1:569220\r\nCapacity of the electric vehicle battery (in Wh)\r\n", | |
112 | "type": "integer" | |
113 | }, | |
114 | "fullSoC": { | |
115 | "description": "DC_ Charging_ Parameters. Full_ SOC. Percentage\r\nurn:x-oca:ocpp:uid:1:569221\r\nPercentage of SoC at which the EV considers the battery fully charged. (possible values: 0 - 100)\r\n", | |
116 | "type": "integer", | |
117 | "minimum": 0.0, | |
118 | "maximum": 100.0 | |
119 | }, | |
120 | "bulkSoC": { | |
121 | "description": "DC_ Charging_ Parameters. Bulk_ SOC. Percentage\r\nurn:x-oca:ocpp:uid:1:569222\r\nPercentage of SoC at which the EV considers a fast charging process to end. (possible values: 0 - 100)\r\n", | |
122 | "type": "integer", | |
123 | "minimum": 0.0, | |
124 | "maximum": 100.0 | |
125 | } | |
126 | }, | |
127 | "required": ["evMaxCurrent", "evMaxVoltage"] | |
128 | } | |
129 | }, | |
130 | "type": "object", | |
131 | "additionalProperties": false, | |
132 | "properties": { | |
133 | "customData": { | |
134 | "$ref": "#/definitions/CustomDataType" | |
135 | }, | |
136 | "maxScheduleTuples": { | |
137 | "description": "Contains the maximum schedule tuples the car supports per schedule.\r\n", | |
138 | "type": "integer" | |
139 | }, | |
140 | "chargingNeeds": { | |
141 | "$ref": "#/definitions/ChargingNeedsType" | |
142 | }, | |
143 | "evseId": { | |
144 | "description": "Defines the EVSE and connector to which the EV is connected. EvseId may not be 0.\r\n", | |
145 | "type": "integer" | |
146 | } | |
147 | }, | |
148 | "required": ["evseId", "chargingNeeds"] | |
149 | } |