Reservation changes for 2.0.1

config/config-sil-ocpp.yaml

@@ -23,6 +23,7 @@ active_modules:
     config_module:
       connector_id: 1
       evse_id: "1"
+      connector_type: "cType2"
       session_logging: true
       session_logging_xml: false
       session_logging_path: /tmp/everest-logs
@@ -55,6 +56,7 @@ active_modules:
     config_module:
       connector_id: 2
       evse_id: "2"
+      connector_type: "cType2"
       session_logging: true
       session_logging_xml: false
       session_logging_path: /tmp

config/config-sil-ocpp201-pnc.yaml

@@ -143,6 +143,9 @@ active_modules:
           implementation_id: external_limits
         - module_id: evse_manager_2_ocpp_sink
           implementation_id: external_limits
+      reservation:
+        - module_id: auth
+          implementation_id: reservation
   evse_security:
     module: EvseSecurity
     config_module:

config/config-sil-ocpp201.yaml

@@ -21,6 +21,7 @@ active_modules:
     config_module:
       connector_id: 1
       evse_id: "1"
+      connector_type: "cType2"
       session_logging: true
       session_logging_xml: false
       session_logging_path: /tmp
@@ -49,6 +50,7 @@ active_modules:
     config_module:
       connector_id: 2
       evse_id: "2"
+      connector_type: "cType2"
       session_logging: true
       session_logging_xml: false
       session_logging_path: /tmp
@@ -142,6 +144,9 @@ active_modules:
           implementation_id: external_limits
         - module_id: evse_manager_2_ocpp_sink
           implementation_id: external_limits
+      reservation:
+        - module_id: auth
+          implementation_id: reservation
   persistent_store:
     module: PersistentStore
   evse_security:
@@ -169,6 +174,9 @@ active_modules:
           implementation_id: evse
         - module_id: evse_manager_2
           implementation_id: evse
+      kvs:
+        - module_id: persistent_store
+          implementation_id: main
   energy_manager:
     module: EnergyManager
     connections:

dependencies.yaml

@@ -67,7 +67,7 @@ libevse-security:
 # OCPP
 libocpp:
   git: https://github.com/EVerest/libocpp.git
-  git_tag: v0.19.0
+  git_tag: feature/327-use-case-h01-reservation
   cmake_condition: "EVEREST_DEPENDENCY_ENABLED_LIBOCPP"
 # Josev
 Josev:

interfaces/reservation.yaml

@@ -1,21 +1,15 @@
 description: Interface for reservations
 cmds:
   reserve_now:
-    description: Reserves this evse.
+    description: Reserves an evse.
     arguments:
-      connector_id:
-        description: >-
-          The id of the connector to be reserved. A value of 0 means that
-          the reservation is not for a specific connector
-        type: integer
-      reservation:
-        description: The information about the Reservation to be placed
+      request:
         type: object
         $ref: /reservation#/Reservation
+        description: Requests to make a reservation
     result:
       description: >-
-        Returns Accepted if reservation was succesfull or specifies error
-        code.
+        Returns Accepted if reservation was succesful or specifies error code.
       type: string
       $ref: /reservation#/ReservationResult
   cancel_reservation:
@@ -29,4 +23,24 @@ cmds:
         Returns true if reservation was cancelled. Returns false if there
         was no reservation to cancel.
       type: boolean
-vars: {}
+  exists_reservation:
+    description: >-
+      Checks if there is a reservation made for the given connector and token. Will also return true if there
+      is a reservation with this token for evse id 0.
+    arguments:
+      request:
+        type: object
+        $ref: /reservation#/ReservationCheck
+        description: >-
+          The information to send for the check if there is a reservation on the given connector for the given token.
+    result:
+      description: >-
+        Returns true if there is a reservation for the given evse id and token or group id token. If there is an
+        evse id given, it will also return true if a reservation with this token was made for evse id 0.
+      type: boolean
+vars:
+  reservation_update:
+    description: >-
+      Update of the reservation.
+    type: object
+    $ref: /reservation#/ReservationUpdateStatus

modules/Auth/Auth.cpp

@@ -14,7 +14,8 @@ void Auth::init() {
 
     this->auth_handler = std::make_unique<AuthHandler>(
         string_to_selection_algorithm(this->config.selection_algorithm), this->config.connection_timeout,
-        this->config.prioritize_authorization_over_stopping_transaction, this->config.ignore_connector_faults);
+        this->config.prioritize_authorization_over_stopping_transaction, this->config.ignore_connector_faults,
+        this->info.id, (!this->r_kvs.empty() ? this->r_kvs.at(0).get() : nullptr));
 
     for (const auto& token_provider : this->r_token_provider) {
         token_provider->subscribe_provided_token([this](ProvidedIdToken provided_token) {
@@ -30,20 +31,28 @@ void Auth::ready() {
 
     int32_t evse_index = 0;
     for (const auto& evse_manager : this->r_evse_manager) {
-        int32_t connector_id = evse_manager->call_get_evse().id;
-        this->auth_handler->init_connector(connector_id, evse_index);
+        const int32_t evse_id = evse_manager->call_get_evse().id;
+        std::vector<Connector> connectors;
+        for (const auto& connector : evse_manager->call_get_evse().connectors) {
+            connectors.push_back(
+                Connector(connector.id, connector.type.value_or(types::evse_manager::ConnectorTypeEnum::Unknown)));
+        }
+
+        this->auth_handler->init_evse(evse_id, evse_index, connectors);
 
-        evse_manager->subscribe_session_event([this, connector_id](SessionEvent session_event) {
-            this->auth_handler->handle_session_event(connector_id, session_event);
+        evse_manager->subscribe_session_event([this, evse_id](SessionEvent session_event) {
+            this->auth_handler->handle_session_event(evse_id, session_event);
         });
 
         evse_manager->subscribe_error(
             "evse_manager/Inoperative",
-            [this, connector_id](const Everest::error::Error& error) {
-                this->auth_handler->handle_permanent_fault_raised(connector_id);
+            // If no connector id is given, it defaults to connector id 1.
+            [this, evse_id](const Everest::error::Error& error) {
+                this->auth_handler->handle_permanent_fault_raised(evse_id, 1);
             },
-            [this, connector_id](const Everest::error::Error& error) {
-                this->auth_handler->handle_permanent_fault_cleared(connector_id);
+            // If no connector id is given, it defaults to connector id 1.
+            [this, evse_id](const Everest::error::Error& error) {
+                this->auth_handler->handle_permanent_fault_cleared(evse_id, 1);
             });
 
         evse_index++;
@@ -53,6 +62,7 @@ void Auth::ready() {
         [this](const ProvidedIdToken& token, TokenValidationStatus status) {
             this->p_main->publish_token_validation_status({token, status});
         });
+
     this->auth_handler->register_notify_evse_callback(
         [this](const int evse_index, const ProvidedIdToken& provided_token, const ValidationResult& validation_result) {
             this->r_evse_manager.at(evse_index)->call_authorize_response(provided_token, validation_result);
@@ -70,11 +80,48 @@ void Auth::ready() {
         [this](const int32_t evse_index, const StopTransactionRequest& request) {
             this->r_evse_manager.at(evse_index)->call_stop_transaction(request);
         });
-    this->auth_handler->register_reserved_callback([this](const int32_t evse_index, const int32_t& reservation_id) {
-        this->r_evse_manager.at(evse_index)->call_reserve(reservation_id);
-    });
+    this->auth_handler->register_reserved_callback(
+        [this](const std::optional<int32_t> evse_id, const int32_t& reservation_id) {
+            // Only call the evse manager to store the reservation if it is done for a specific evse.
+            if (evse_id.has_value()) {
+                EVLOG_info << "Call reserved callback for evse id " << evse_id.value();
+
+                if (!this->r_evse_manager.at(evse_id.value() - 1)->call_reserve(reservation_id)) {
+                    EVLOG_warning << "EVSE manager does not allow placing a reservation for evse id " << evse_id.value()
+                                  << ": cancelling reservation.";
+                    this->auth_handler->handle_cancel_reservation(reservation_id);
+                    return false;
+                }
+            }
+
+            ReservationUpdateStatus status;
+            status.reservation_id = reservation_id;
+            status.reservation_status = Reservation_status::Placed;
+            this->p_reservation->publish_reservation_update(status);
+            return true;
+        });
     this->auth_handler->register_reservation_cancelled_callback(
-        [this](const int32_t evse_index) { this->r_evse_manager.at(evse_index)->call_cancel_reservation(); });
+        [this](const std::optional<int32_t> evse_id, const int32_t reservation_id, const ReservationEndReason reason) {
+            // Only call the evse manager to cancel the reservation if it was for a specific evse
+            if (evse_id.has_value()) {
+                EVLOG_debug << "Call evse manager to cancel the reservation with evse id " << evse_id.value();
+                this->r_evse_manager.at(evse_id.value() - 1)->call_cancel_reservation();
+            }
+
+            ReservationUpdateStatus status;
+            status.reservation_id = reservation_id;
+            if (reason == ReservationEndReason::Expired) {
+                status.reservation_status = Reservation_status::Expired;
+            } else if (reason == ReservationEndReason::Cancelled) {
+                status.reservation_status = Reservation_status::Removed;
+            } else {
+                // On reservation used: do not publish a reservation update!!
+                return;
+            }
+            this->p_reservation->publish_reservation_update(status);
+        });
+
+    this->auth_handler->initialize();
 }
 
 void Auth::set_connection_timeout(int& connection_timeout) {

modules/Auth/Auth.hpp

@@ -18,6 +18,7 @@
 #include <generated/interfaces/auth_token_provider/Interface.hpp>
 #include <generated/interfaces/auth_token_validator/Interface.hpp>
 #include <generated/interfaces/evse_manager/Interface.hpp>
+#include <generated/interfaces/kvs/Interface.hpp>
 
 // ev@4bf81b14-a215-475c-a1d3-0a484ae48918:v1
 // insert your custom include headers here
@@ -45,20 +46,24 @@ class Auth : public Everest::ModuleBase {
          std::unique_ptr<reservationImplBase> p_reservation,
          std::vector<std::unique_ptr<auth_token_providerIntf>> r_token_provider,
          std::vector<std::unique_ptr<auth_token_validatorIntf>> r_token_validator,
-         std::vector<std::unique_ptr<evse_managerIntf>> r_evse_manager, Conf& config) :
+         std::vector<std::unique_ptr<evse_managerIntf>> r_evse_manager, std::vector<std::unique_ptr<kvsIntf>> r_kvs,
+         Conf& config) :
         ModuleBase(info),
         p_main(std::move(p_main)),
         p_reservation(std::move(p_reservation)),
         r_token_provider(std::move(r_token_provider)),
         r_token_validator(std::move(r_token_validator)),
         r_evse_manager(std::move(r_evse_manager)),
-        config(config){};
+        r_kvs(std::move(r_kvs)),
+        config(config) {
+    }
 
     const std::unique_ptr<authImplBase> p_main;
     const std::unique_ptr<reservationImplBase> p_reservation;
     const std::vector<std::unique_ptr<auth_token_providerIntf>> r_token_provider;
     const std::vector<std::unique_ptr<auth_token_validatorIntf>> r_token_validator;
     const std::vector<std::unique_ptr<evse_managerIntf>> r_evse_manager;
+    const std::vector<std::unique_ptr<kvsIntf>> r_kvs;
     const Conf& config;
 
     // ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1

modules/Auth/BUILD.bazel

@@ -11,6 +11,7 @@ cc_library(
         "@everest-framework//:framework",
         "@com_github_HowardHinnant_date//:date",
         "//types:types_lib",
+        "//interfaces:interfaces_lib",
     ],
     # See https://github.com/HowardHinnant/date/issues/324
     local_defines = [

modules/Auth/CMakeLists.txt

@@ -21,6 +21,7 @@ target_link_libraries(${MODULE_NAME}
         date::date
         date::date-tz
         everest::timer
+        nlohmann_json::nlohmann_json
 )
 # ev@bcc62523-e22b-41d7-ba2f-825b493a3c97:v1