Feature/376 ocpp 201 california pricing requirements tariff and cost #768

maaikez · 2024-07-08T12:58:47Z

Describe your changes

Interface changes needed for California Pricing Requirements: TariffAndCost and DisplayMessage.

Issue ticket number and link

libocpp / 376

Checklist before requesting a review

I have performed a self-review of my code
I have made corresponding changes to the documentation
I read the contribution documentation and made sure that my changes meet its requirements

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…se it for other than ocpp messages as well. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…irements-tariff-and-cost

…e this for other things than only ocpp as well probably. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…' qr code. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Pietfried · 2024-07-10T11:17:07Z

types/display_message.yaml

+      message_format:
+        description: The format of the message
+        type: string
+        $ref: /ocpp#/MessageFormat


This is a reference to an ocpp type, which we should try to avoid

Move over to display_message

Pietfried · 2024-07-10T11:24:49Z

interfaces/display_message.yaml

+        properties:
+          status:
+            description: Whether the charging station is able to display the message
+            $ref: /display_message#/DisplayMessageStatusEnum
+            type: object
+          status_info:
+            description: Detailed status information
+            $ref: /ocpp#/StatusInfoType
+            type: object
+        required:
+          - status


This has to be defined in another type definition like SetDisplayMessageResponse

I will, but it does just build.

Pietfried · 2024-07-10T11:26:04Z

interfaces/display_message.yaml

+        properties:
+          status_info:
+            description: Detailed status information
+            $ref: /ocpp#/StatusInfoType


This is a reference to an ocpp type, which we should try to avoid

Pietfried · 2024-07-10T11:27:05Z

types/session_cost.yaml

+    type: object
+    additionalProperties: false
+    properties:
+      graceMinutes:


we prefer to use snake_case for properties

Pietfried · 2024-07-10T11:27:12Z

types/session_cost.yaml

+          Grace minutes start counting from the timestamp of the message in which state
+          changed from "Charging" to "Idle".
+        type: integer
+      hourPrice:


we prefer to use snake_case for properties

Pietfried · 2024-07-10T11:52:43Z

interfaces/display_message.yaml

@@ -0,0 +1,83 @@
+description: >-
+  This interface allows to add / remove / change messages that should be showed on the display.


Add a more detailed description what to expect from a module that implements this interface e.g.:

store and retrieve predefined messages

Show messages on a display

...

Pietfried · 2024-07-10T12:14:58Z

types/session_cost.yaml

      cost:
        description: >-
          Cost of the energy (or other things like time, base price, ...) 
          consumed during this chunk in the currency specified in the session
          price
        type: object
        $ref: /money#/MoneyAmount
+      costAmount:


This can be dropped

Pietfried · 2024-07-10T12:15:40Z

types/session_cost.yaml

+        description: >-
+          Price per hour while idle
+        type: number
+  ChargingPriceComponent:


This can be removed

I kept it but changed the enum type to 'category'. Because we need an array with this information in SessionCost (otherwise I have to define it there, which is also fine by me).

but what is the difference to the SessionCostChunk?

A SessionCostChunk is the 'real cost' of the session (the total cost of the charging session until now for example), ChargingPriceComponent is the price per kWh, hour or flat fee. So if you want to calculate the total cost (for example if the charging station goes offline), you need the charging price components to be able to do that.

understood - but can it be modeled similarly to the SessionCostChunk and also named similarly, e.x. PriceChunk and allow the user to pass an array of chunks

Well that is only renaming ChargingPriceComponent to PriceChunk isn't it? As it already is an array.

Pietfried · 2024-07-10T12:16:38Z

types/session_cost.yaml

  SessionStatus:
    description: >-
      Session status enum. Session can be running or finished. Costs of the
      running session are not final and can change.
    type: string
    enum:
      - Running
+      - Idle
      - Finished
  SessionCost:


id_tag should move to optional and session_id to required to identify the session

Pietfried · 2024-07-10T12:17:15Z

interfaces/display_message.yaml

+            description: Whether the charging station is able to display the message
+            $ref: /display_message#/DisplayMessageStatusEnum
+            type: object
+          status_info:


Can be removed from this type definition / make it a string

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

interfaces/display_message.yaml

dorezyuk · 2024-07-11T06:08:03Z

types/session_cost.yaml

@@ -1,5 +1,62 @@
 description: Types to provide the session price
 types:
+  IdlePrice:


i'm a little confused - from what i understand we refer to idle to the state when the station has no customer. What does idle mean in this context?

For more info, you can read the California Pricing Requirements.
https://openchargealliance.org/whitepapers/ <- to be downloaded there.

Idle is when a car is attached but currently not charging. For example because the battery is already full. There are charging stations where you have to pay something when you are not charging (I mainly found them in the field with DC chargers, but also AC chargers sometimes have this).

cool understood - maybe you can link the req in the description

Ah yes the link is already in the issue:
EVerest/libocpp#376

dorezyuk · 2024-07-11T06:13:36Z

types/session_cost.yaml

+    type: object
+    properties:
+      timestamp_from:
+        description: Time when these prices become active.


should be singular as in other comments below

Well it refers to the charging prices and idle prices.

dorezyuk · 2024-07-11T06:14:05Z

types/session_cost.yaml

-          - Energy
-          - Time
-          - Other
+        $ref: /session_cost#/CostCategory
  SessionStatus:
    description: >-
      Session status enum. Session can be running or finished. Costs of the


the doc is then outdated

dorezyuk · 2024-07-11T06:22:48Z

types/session_cost.yaml

+      metervalue_from:
+        description: >-
+          Metervalue (energie Wh import) for the start of this chunk
+        type: integer


why not using powermeter types here?

Because this is as specified in California Pricing Requirements. We just get a metervalue from the CSMS. But if you think we should change this: what is your proposal?

i would use the powermeter type since it would fit better in the ecosystem

i would use the powermeter type since it would fit better in the ecosystem

I am fine with that, @Pietfried is that ok for you?

The chunk is really only defined for a range energy_wh_import right? In that case the powermeter type could bring in a lot of irrelevant data (voltage, reactive power) and even lead to confusion what this property actually means within this type, so I would stick with the current definition

dorezyuk · 2024-07-11T06:23:47Z

types/session_cost.yaml

+    description: Cost category
+    type: string
+    enum:
+      - Energy


can't we model the idle price not as a category in here?

So you would like to add a IdlePriceTime, ChargingTime, IdleGraceMinutes and remove Time? I thought about it but I don't know if that makes things more clear.

i don't really understand why we need to define actually idle as a separate category. Your linked whitepater says

It is up to the CSMS and not the charging station, to decide when a transaction is considered to be in idle time.

So at some point when the station sends a chargingState or atPowerkW and the CSMS thinks that its now idle it will send a price containing just the time component. The CSMS can internally also account for grace times or other conditions

Yes but what if the CSMS is not online?
I just reflect the fields from the California Pricing Requirements, which sends the idle price as well.

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…ChargingPriceComponent instead of Money because it includes the number of decimals. Add more conversions. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

… and session cost) Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…irements-tariff-and-cost

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Pietfried

Looks good overall, see in line comments 👍

types/display_message.yaml

modules/OCPP/conversions.hpp

types/session_cost.yaml

Pietfried · 2024-07-29T12:51:26Z

modules/OCPP/conversions.cpp

+    if (timestamp.has_value()) {
+        chunk.timestamp_to = timestamp.value().to_rfc3339();
+    }
+    chunk.metervalue_to = meter_value;


What about metervalue_from ?

Well in ocpp there is no metervalue_from. But there is a metervalue_from and metervalue_to in the interface (they were already there).

Pietfried · 2024-07-29T12:54:25Z

types/session_cost.yaml

+      metervalue_from:
+        description: >-
+          Metervalue (energie Wh import) for the start of this chunk
+        type: integer


The chunk is really only defined for a range energy_wh_import right? In that case the powermeter type could bring in a lot of irrelevant data (voltage, reactive power) and even lead to confusion what this property actually means within this type, so I would stick with the current definition

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…pp display message struct as well. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…nstead of a number (double) Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…it is not only about display messages. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…irements-tariff-and-cost

…uilds Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez · 2024-08-05T14:48:08Z

dependencies.yaml

@@ -60,7 +60,7 @@ libevse-security:
 # OCPP
 libocpp:
  git: https://github.com/EVerest/libocpp.git
-  git_tag: aab1d5785bde141203b1a89b03d66fa91edf8093
+  git_tag: 1009ca1550a54824b9e2c1eacdad69f9373fd542


TODO set to correct git tag before merging to main!!!

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Signed-off-by: Kai-Uwe Hermann <[email protected]>

Pietfried · 2024-08-07T16:04:04Z

modules/OCPP/display_message/display_messageImpl.cpp

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache-2.0


the whole display_message directory shall be removed from OCPP. Its not something that the module provides, but optionally requires (see the manifest)

Pietfried · 2024-08-07T16:06:15Z

modules/OCPP/OCPP.cpp

+            const types::session_cost::SessionCost cost =
+                conversions::create_session_cost(session_cost, number_of_decimals, {});
+            ocpp::v16::DataTransferResponse response;
+            if (this->p_session_cost == nullptr) {


nit: p_session_cost cannot really be null, since providing an interface implementation is not optional for a module.

ok i'll remove it. on your risk ;)

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

…irements-tariff-and-cost

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez added 4 commits July 4, 2024 17:19

Session cost proposal

167fed5

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Add types for display message and start working on interface.

e15dc8e

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Add interface for displaying messages.

d956f22

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Move display message interface and types outside ocpp as we want to u…

e907501

…se it for other than ocpp messages as well. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez linked an issue Jul 8, 2024 that may be closed by this pull request

OCPP 2.0.1 California Pricing Requirements: Tariff and Cost EVerest/libocpp#376

Closed

Added some types in the yaml and fix some other errors.

319459b

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez assigned maaikez and unassigned maaikez Jul 8, 2024

maaikez added 4 commits July 8, 2024 16:58

Fix some circular dependendies

9e19a15

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Merge branch 'main' into feature/376-ocpp-201-california-pricing-requ…

deb618d

…irements-tariff-and-cost

Do not require id and priority for a display message as we want to us…

7e18060

…e this for other things than only ocpp as well probably. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Add qr code to display message to be able to show a 'more information…

e4ca2e1

…' qr code. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Pietfried requested changes Jul 10, 2024

View reviewed changes

Update interfaces after review

dbb9033

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez force-pushed the feature/376-ocpp-201-california-pricing-requirements-tariff-and-cost branch from e6548b6 to dbb9033 Compare July 10, 2024 14:26

Work on conversions between types for display messages.

4d3eaa1

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

dorezyuk reviewed Jul 11, 2024

View reviewed changes

interfaces/display_message.yaml Show resolved Hide resolved

dorezyuk reviewed Jul 11, 2024

View reviewed changes

interfaces/display_message.yaml Show resolved Hide resolved

dorezyuk reviewed Jul 11, 2024

View reviewed changes

maaikez added 2 commits July 11, 2024 12:35

Write some conversions

3380ec9

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Some changes on the Session Cost type: type Price is now used in the …

5a87787

…ChargingPriceComponent instead of Money because it includes the number of decimals. Add more conversions. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez force-pushed the feature/376-ocpp-201-california-pricing-requirements-tariff-and-cost branch 2 times, most recently from 56d716f to fce06f8 Compare July 12, 2024 15:54

Start implementing the California Pricing interfaces (display message…

00fd07c

… and session cost) Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez force-pushed the feature/376-ocpp-201-california-pricing-requirements-tariff-and-cost branch from fce06f8 to 00fd07c Compare July 12, 2024 15:58

Call ocpp 1.6 callbacks for display message and session cost.

cc8b1cc

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez added 3 commits July 24, 2024 11:03

Merge branch 'main' into feature/376-ocpp-201-california-pricing-requ…

e06cf59

…irements-tariff-and-cost

Oops, ^ is not the same is 'the power of'.

5a99552

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Some more logging to check if things did go well while testing.

32e7ede

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Pietfried requested changes Jul 29, 2024

View reviewed changes

maaikez added 7 commits July 30, 2024 13:34

Review comments: Add comments, renaming

34c490b

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Make 'cost' of 'running_cost' required.

910a2f5

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Fix to only set timestamp in display message when it is set in the oc…

b314abb

…pp display message struct as well. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Make change in interface so idle price is also a /money#/Price type i…

43946f8

…nstead of a number (double) Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Rename TerminalDisplayMessage to TerminalCostAndPriceMessage because …

51a6976

…it is not only about display messages. Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Merge branch 'main' into feature/376-ocpp-201-california-pricing-requ…

390f4c2

…irements-tariff-and-cost

Make everest core dependent on the correct version of libocpp so it b…

6ae2448

…uilds Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez commented Aug 5, 2024

View reviewed changes

maaikez added 2 commits August 5, 2024 16:51

Formatting...

4310613

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

formatting?

d8c0b00

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez marked this pull request as ready for review August 5, 2024 15:36

maaikez requested review from hikinggrass and corneliusclaussen as code owners August 5, 2024 15:36

maaikez and others added 2 commits August 6, 2024 10:40

Removed custom config yaml that I should not have pushed

ea1d4cd

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Adapt RsPaymentTerminal to type changes

132bfa4

Signed-off-by: Kai-Uwe Hermann <[email protected]>

hikinggrass requested review from SirVer and golovasteek as code owners August 6, 2024 10:14

SirVer approved these changes Aug 6, 2024

View reviewed changes

Pietfried requested changes Aug 7, 2024

View reviewed changes

maaikez added 2 commits August 9, 2024 11:45

Remove unnecessary module. Review comments.

40397ab

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

Merge branch 'main' into feature/376-ocpp-201-california-pricing-requ…

6628fe9

…irements-tariff-and-cost

Pietfried approved these changes Aug 13, 2024

View reviewed changes

maaikez added 2 commits August 13, 2024 16:42

Merge branch 'main' into feature/376-ocpp-201-california-pricing-requ…

041167f

…irements-tariff-and-cost

Libocpp version to v0.15.1

97eb3b0

Signed-off-by: Maaike Zijderveld, iolar <[email protected]>

maaikez merged commit da0da54 into main Aug 13, 2024
11 checks passed

maaikez deleted the feature/376-ocpp-201-california-pricing-requirements-tariff-and-cost branch August 13, 2024 15:39

		@@ -0,0 +1,83 @@
		description: >-
		This interface allows to add / remove / change messages that should be showed on the display.

Feature/376 ocpp 201 california pricing requirements tariff and cost #768

Feature/376 ocpp 201 california pricing requirements tariff and cost #768

Conversation

maaikez commented Jul 8, 2024 • edited Loading

Describe your changes

Issue ticket number and link

Checklist before requesting a review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pietfried left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maaikez commented Jul 8, 2024 •

edited

Loading