UNPKG

@citrineos/base

Version:

The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.

128 lines (127 loc) • 7.01 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
{ "$id": "PullDynamicScheduleUpdateResponse", "comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License", "definitions": { "ChargingProfileStatusEnumType": { "description": "Result of request.\r\n\r\n", "javaType": "ChargingProfileStatusEnum", "type": "string", "additionalProperties": false, "enum": ["Accepted", "Rejected"], "tsEnumNames": ["Accepted", "Rejected"] }, "ChargingScheduleUpdateType": { "description": "Updates to a ChargingSchedulePeriodType for dynamic charging profiles.\r\n\r\n", "javaType": "ChargingScheduleUpdate", "type": "object", "additionalProperties": false, "properties": { "limit": { "description": "Optional only when not required by the _operationMode_, as in CentralSetpoint, ExternalSetpoint, ExternalLimits, LocalFrequency, LocalLoadBalancing. +\r\nCharging rate limit during the schedule period, in the applicable _chargingRateUnit_. \r\nThis SHOULD be a non-negative value; a negative value is only supported for backwards compatibility with older systems that use a negative value to specify a discharging limit.\r\nFor AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.\r\n", "type": "number" }, "limit_L2": { "description": "*(2.1)* Charging rate limit on phase L2 in the applicable _chargingRateUnit_. \r\n", "type": "number" }, "limit_L3": { "description": "*(2.1)* Charging rate limit on phase L3 in the applicable _chargingRateUnit_. \r\n", "type": "number" }, "dischargeLimit": { "description": "*(2.1)* Limit in _chargingRateUnit_ that the EV is allowed to discharge with. Note, these are negative values in order to be consistent with _setpoint_, which can be positive and negative. +\r\nFor AC this field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.\r\n", "type": "number", "maximum": 0 }, "dischargeLimit_L2": { "description": "*(2.1)* Limit in _chargingRateUnit_ on phase L2 that the EV is allowed to discharge with. \r\n", "type": "number", "maximum": 0 }, "dischargeLimit_L3": { "description": "*(2.1)* Limit in _chargingRateUnit_ on phase L3 that the EV is allowed to discharge with. \r\n", "type": "number", "maximum": 0 }, "setpoint": { "description": "*(2.1)* Setpoint in _chargingRateUnit_ that the EV should follow as close as possible. Use negative values for discharging. +\r\nWhen a limit and/or _dischargeLimit_ are given the overshoot when following _setpoint_ must remain within these values.\r\nThis field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.\r\n", "type": "number" }, "setpoint_L2": { "description": "*(2.1)* Setpoint in _chargingRateUnit_ that the EV should follow on phase L2 as close as possible.\r\n", "type": "number" }, "setpoint_L3": { "description": "*(2.1)* Setpoint in _chargingRateUnit_ that the EV should follow on phase L3 as close as possible. \r\n", "type": "number" }, "setpointReactive": { "description": "*(2.1)* Setpoint for reactive power (or current) in _chargingRateUnit_ that the EV should follow as closely as possible. Positive values for inductive, negative for capacitive reactive power or current. +\r\nThis field represents the sum of all phases, unless values are provided for L2 and L3, in which case this field represents phase L1.\r\n", "type": "number" }, "setpointReactive_L2": { "description": "*(2.1)* Setpoint for reactive power (or current) in _chargingRateUnit_ that the EV should follow on phase L2 as closely as possible. \r\n", "type": "number" }, "setpointReactive_L3": { "description": "*(2.1)* Setpoint for reactive power (or current) in _chargingRateUnit_ that the EV should follow on phase L3 as closely as possible. \r\n", "type": "number" }, "customData": { "$ref": "#/definitions/CustomDataType" } } }, "StatusInfoType": { "description": "Element providing more information about the status.\r\n", "javaType": "StatusInfo", "type": "object", "additionalProperties": false, "properties": { "reasonCode": { "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n", "type": "string", "maxLength": 20 }, "additionalInfo": { "description": "Additional text to provide detailed information.\r\n", "type": "string", "maxLength": 1024 }, "customData": { "$ref": "#/definitions/CustomDataType" } }, "required": ["reasonCode"] }, "CustomDataType": { "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.", "javaType": "CustomData", "type": "object", "properties": { "vendorId": { "type": "string", "maxLength": 255 } }, "required": ["vendorId"] } }, "type": "object", "additionalProperties": false, "properties": { "scheduleUpdate": { "$ref": "#/definitions/ChargingScheduleUpdateType" }, "status": { "$ref": "#/definitions/ChargingProfileStatusEnumType" }, "statusInfo": { "$ref": "#/definitions/StatusInfoType" }, "customData": { "$ref": "#/definitions/CustomDataType" } }, "required": ["status"] }