Skip to content

Commit b9cc553

Browse files
committed
Updated OCPP + OCPP201 documentation
Signed-off-by: Sebastian Lukas <sebastian.lukas@pionix.de>
1 parent cbd4ae1 commit b9cc553

File tree

2 files changed

+34
-6
lines changed

2 files changed

+34
-6
lines changed

modules/OCPP/doc.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,6 @@ This module makes use of the following commands of this interface:
112112
publishes the result via the `Provides: ocpp_generic <#provides-ocpp_generic>`_ interface. The duration of the composite schedule can
113113
be configured by the configuration parameter **PublishChargingScheduleDurationS** of this module. The configuration parameter
114114
**PublishChargingScheduleIntervalS** defines the interval to use to periodically retrieve and publish the composite schedules.
115-
* **set_get_certificate_response** to report that the charging station received a **DataTransfer.conf(Get15118EVCertificateResponse)** from
116-
the CSMS (EV Contract installation for Plug&Charge)
117115
* **external_ready_to_start_charging**: To signal that the module has started to establish an OCPP connection to the CSMS
118116

119117
The interface is used to receive the following variables:
@@ -124,7 +122,6 @@ The interface is used to receive the following variables:
124122
* **limits** to obtain the current offered to the EV. If present, this is reported as part of a **MeterValues.req**
125123
* **session_event** to trigger **StatusNotification.req**, **StartTransaction.req**, and **StopTransaction.req** based on the reported event.
126124
This signal drives the state machine and the transaction handling of libocpp.
127-
* **iso15118_certificate_request** to trigger a **DataTransfer.req(Get15118EVCertificateRequest)** as part of the Plug&Charge process
128125
* **waiting_for_external_ready** to obtain the information that a module implementing this interface is waiting for an external ready signal
129126
* **ready** to obtain a ready signal from a module implementing this interface
130127

@@ -264,6 +261,23 @@ This module makes use of the following commands of this interface:
264261
* **set_display_message** to set a message on the charging station's display. This is executed when the CSMS sends a
265262
**DataTransfer.req(SetUserPrice)** message to the charging station.
266263

264+
Requires: extensions_15118
265+
^^^^^^^^^^^^^^^^^^^^^^^^^^
266+
267+
**Interface**: `iso15118_extensions <../../interfaces/iso15118_extensions.yaml>`_
268+
269+
This module optionally requires (0-128) implementations of this interface in order to share data between ISO15118 and OCPP modules. One
270+
connection represents one ISO15118 module.
271+
272+
This module makes use of the following commands of this interface:
273+
274+
* **set_get_certificate_response** to report that the charging station received a **DataTransfer.conf(Get15118EVCertificateResponse)** from
275+
the CSMS (EV Contract installation for Plug&Charge)
276+
277+
The interface is used to receive the following variables:
278+
279+
* **iso15118_certificate_request** to trigger a **DataTransfer.req(Get15118EVCertificateRequest)** as part of the Plug&Charge process
280+
267281
Global Errors and Error Reporting
268282
---------------------------------
269283

modules/OCPP201/doc.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,6 @@ This module makes use of the following commands of this interface:
113113
**PublishChargingScheduleDurationS** of this module. The configuration parameter **PublishChargingScheduleIntervalS** defines the interval to use to
114114
periodically retrieve and publish the composite schedules. The configuration parameter **RequestCompositeScheduleUnit** can be used to specify the unit in
115115
which composite schedules are requested and shared within EVerest.
116-
* **set_get_certificate_response** to report that the charging station received a **Get15118EVCertificate.conf** from the CSMS (EV Contract installation
117-
for Plug&Charge)
118116

119117
The interface is used to receive the following variables:
120118

@@ -124,7 +122,6 @@ The interface is used to receive the following variables:
124122
* **limits** to obtain the current offered to the EV. If present, this is reported as part of a **MeterValues.req**
125123
* **session_event** to trigger **StatusNotification.req** and **TransactionEvent.req** based on the reported event. This signal drives the state machine and
126124
the transaction handling of libocpp.
127-
* **iso15118_certificate_request** to trigger a **DataTransfer.req(Get15118EVCertificateRequest)** as part of the Plug&Charge process
128125
* **waiting_for_external_ready** to obtain the information that a module implementing this interface is waiting for an external ready signal
129126
* **ready** to obtain a ready signal from a module implementing this interface
130127

@@ -247,6 +244,23 @@ This module makes use of the following commands of this interface:
247244
* **get_display_messages** to forward a **GetDisplayMessage.req** from the CSMS
248245
* **clear_display_message** to forward a **ClearDisplayMessage.req** from the CSMS
249246

247+
Requires: extensions_15118
248+
^^^^^^^^^^^^^^^^^^^^^^^^^^
249+
250+
**Interface**: `iso15118_extensions <../../interfaces/iso15118_extensions.yaml>`_
251+
252+
This module optionally requires (0-128) implementations of this interface in order to share data between ISO15118 and OCPP modules. One
253+
connection represents one ISO15118 module.
254+
255+
This module makes use of the following commands of this interface:
256+
257+
* **set_get_certificate_response** to report that the charging station received a **DataTransfer.conf(Get15118EVCertificateResponse)** from
258+
the CSMS (EV Contract installation for Plug&Charge)
259+
260+
The interface is used to receive the following variables:
261+
262+
* **iso15118_certificate_request** to trigger a **DataTransfer.req(Get15118EVCertificateRequest)** as part of the Plug&Charge process
263+
250264
Error Handling
251265
--------------
252266

0 commit comments

Comments
 (0)