Added charging schedules definition #582

james-ctc · 2024-03-13T13:46:24Z

Describe your changes

Create YAML/JSON definition for charging schedules.

Note this is an API breaking change. Originally charging schedules were published:

    { "0": {...}, "1": {...}}

Using the connector number as the key. This is not supported in the YAML interface or type definitions.

Instead an array is used with an additional key added:

    [ { "connector": 0, ...}, { "connector": 1, ...} ... ]

Unfortunately the generated code doesn't like arrays at that point, so the array has been wrapped in an object:

    { "schedules": [ { "connector": 0, ...}, { "connector": 1, ...} ... ] }

Note is should not be assumed that the array index will match the connector number.

The existing types in libocpp have not been changed. A new mapping has been created in the OCPP module to convert from the internal format to the MQTT JSON format.

Note OCPP201 doesn't publish schedules at the moment and has not changed.

Issue ticket number and link

None

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

Note this is an API breaking change. Originally charging schedules were published: { "0": {...}, "1": {...}} using the connector number as the key. This is not supported in the YAML interface or type definitions. Instead an array is used with an additional key added: [ { "connector": 0, ...}, { "connector": 1, ...} ... ] Note is should not be assumed that the array index will match the connector number. The existing types in libocpp have not been changed. A new mapping has been created in the OCPP module. (OCPP201 doesn't publish schedules at the moment) Signed-off-by: James Chapman <[email protected]>

The autogenerated code doesn't support a module var being an array (of a specific object type) [{},{}] Instead the array is now wrapped in an object: {"schedules": [{},{}]} Signed-off-by: James Chapman <[email protected]>

types/ocpp.yaml

Signed-off-by: James Chapman <[email protected]>

Pietfried

Types and interfaces look good from my side.

Although the definitions in the OCPP spec are camelCase, we try to stick to snake_case in our internal interfaces. I have added some suggestions inline, but the code also needs to apply the changes.

@corneliusclaussen : Do we need changes on the EnergyManager side if we make these changes?

Pietfried · 2024-03-14T09:44:46Z

types/ocpp.yaml

+      - startPeriod
+      - limit
+      - stackLevel


Suggested change

- startPeriod

- limit

- stackLevel

- start_period

- limit

- stack_level

Pietfried · 2024-03-14T09:45:10Z

types/ocpp.yaml

+      startPeriod:
+        type: integer
+      limit:
+        type: number
+      numberPhases:
+        type: integer
+      stackLevel:
+        type: integer


Suggested change

startPeriod:

type: integer

limit:

type: number

numberPhases:

type: integer

stackLevel:

type: integer

start_period:

type: integer

limit:

type: number

number_phases:

type: integer

stack_level:

type: integer

Pietfried · 2024-03-14T09:45:43Z

types/ocpp.yaml

+      - chargingRateUnit
+      - chargingSchedulePeriod


Suggested change

- chargingRateUnit

- chargingSchedulePeriod

- charging_rate_unit

- charging_schedule_period

Pietfried · 2024-03-14T09:46:01Z

types/ocpp.yaml

+      connector:
+        type: integer
+        minimum: 0
+      chargingRateUnit:


Suggested change

chargingRateUnit:

charging_rate_unit:

Pietfried · 2024-03-14T09:46:11Z

types/ocpp.yaml

+        minimum: 0
+      chargingRateUnit:
+        type: string
+      chargingSchedulePeriod:


Suggested change

chargingSchedulePeriod:

charging_schedule_period:

Pietfried · 2024-03-14T09:46:26Z

types/ocpp.yaml

+          $ref: /ocpp#/ChargingSchedulePeriod
+      duration:
+        type: integer
+      startSchedule:


Suggested change

startSchedule:

start_schedule:

Pietfried · 2024-03-14T09:46:37Z

types/ocpp.yaml

+        type: integer
+      startSchedule:
+        type: string
+      minChargingRate:


Suggested change

minChargingRate:

min_charging_rate:

Pietfried · 2024-03-14T11:32:23Z

modules/OCPP/OCPP.cpp

@@ -141,14 +142,46 @@ void OCPP::set_external_limits(const std::map<int32_t, ocpp::v16::EnhancedChargi
    }
 }

+namespace {
+types::ocpp::ChargingSchedulePeriod to_ChargingSchedulePeriod(const ocpp::v16::EnhancedChargingSchedulePeriod& period) {


Please use the conversions.hpp / cpp for these conversions

moved functions to conversions.[ch]pp

fix: moved conversions to separate file Signed-off-by: James Chapman <[email protected]>

james-ctc · 2024-03-14T15:39:39Z

Although the definitions in the OCPP spec are camelCase, we try to stick to snake_case in our internal interfaces

The case naming came from struct EnhancedChargingSchedule rather than OCPP.
CamelCase is used quite a bit within ocpp.yaml e.g.:

  DataTransferStatus:
    description: Data Transfer Status enum
    type: string
    enum:
      - Accepted
      - Rejected
      - UnknownMessageId
      - UnknownVendorId

Updated required: and properties: sections to use snake_case
Left ChargingSchedules ChargingSchedule and ChargingSchedulePeriod CamelCase to match existing entries.

james-ctc · 2024-03-14T15:51:26Z

Do we need changes on the EnergyManager side if we make these changes?

It doesn't look like EnergyManager depends on the ocpp interface and I can't locate any MQTT subscribe for charging_schedules.

Looking at recent updates to main it seems the API module now subscribes for charging_schedules.

james-ctc added 2 commits March 13, 2024 13:45

fix: Arrays not supported by the autogenerated code

f86d526

The autogenerated code doesn't support a module var being an array (of a specific object type) [{},{}] Instead the array is now wrapped in an object: {"schedules": [{},{}]} Signed-off-by: James Chapman <[email protected]>

james-ctc marked this pull request as ready for review March 13, 2024 16:08

james-ctc requested review from hikinggrass, Pietfried and corneliusclaussen as code owners March 13, 2024 16:08

james-ctc removed the request for review from corneliusclaussen March 13, 2024 16:09

james-ctc self-assigned this Mar 13, 2024

hikinggrass reviewed Mar 13, 2024

View reviewed changes

types/ocpp.yaml Show resolved Hide resolved

feat: add optional EVSE id for OCPP 2.0.1

bfe1aa6

Signed-off-by: James Chapman <[email protected]>

Pietfried requested changes Mar 14, 2024

View reviewed changes

fix: addressed PR comments on use of snake_case

fa3f464

fix: moved conversions to separate file Signed-off-by: James Chapman <[email protected]>

james-ctc requested a review from SebaLukas as a code owner March 14, 2024 16:04

james-ctc force-pushed the feat/charging-schedule-definition branch from c310bf6 to fa3f464 Compare March 14, 2024 16:05

james-ctc and others added 3 commits March 14, 2024 16:05

Merge branch 'main' into feat/charging-schedule-definition

66af61f

Merge branch 'main' into feat/charging-schedule-definition

755ac65

Merge branch 'main' into feat/charging-schedule-definition

472ab02

Pietfried approved these changes Mar 25, 2024

View reviewed changes

Pietfried assigned Pietfried and unassigned james-ctc Apr 2, 2024

Pietfried added 2 commits April 4, 2024 19:47

Merge branch 'main' into feat/charging-schedule-definition

a45217a

Merge branch 'main' into feat/charging-schedule-definition

497bfd5

Pietfried merged commit b135d38 into main Apr 10, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added charging schedules definition #582

Added charging schedules definition #582

james-ctc commented Mar 13, 2024 •

edited

Loading

Pietfried left a comment

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

Pietfried Mar 14, 2024

james-ctc Mar 14, 2024

james-ctc commented Mar 14, 2024

james-ctc commented Mar 14, 2024 •

edited

Loading

Added charging schedules definition #582

Added charging schedules definition #582

Conversation

james-ctc commented Mar 13, 2024 • edited Loading

Describe your changes

Issue ticket number and link

Checklist before requesting a review

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

james-ctc commented Mar 14, 2024

james-ctc commented Mar 14, 2024 • edited Loading

james-ctc commented Mar 13, 2024 •

edited

Loading

james-ctc commented Mar 14, 2024 •

edited

Loading