Feature/327 use case h01 reservation

config/v201/component_config/standardized/ReservationCtrlr.json

@@ -45,7 +45,8 @@
       "attributes": [
         {
           "type": "Actual",
-          "mutability": "ReadOnly"
+          "mutability": "ReadOnly",
+          "value": true
         }
       ],
       "description": "If this configuration variable is present and set to true: Charging Station supports Reservation where EVSE id is not specified.",

doc/v201/ocpp_201_status.md

@@ -1071,21 +1071,21 @@ This document contains the status of which OCPP 2.0.1 numbered functional requir
 
 | ID        | Status | Remark |
 |-----------|--------|--------|
-| H01.FR.01 |        |        |
-| H01.FR.02 |        |        |
-| H01.FR.03 |        |        |
-| H01.FR.04 |        |        |
-| H01.FR.06 |        |        |
-| H01.FR.07 |        |        |
-| H01.FR.09 |        |        |
-| H01.FR.11 |        |        |
-| H01.FR.12 |        |        |
-| H01.FR.14 |        |        |
-| H01.FR.15 |        |        |
-| H01.FR.16 |        |        |
-| H01.FR.17 |        |        |
-| H01.FR.18 |        |        |
-| H01.FR.19 |        |        |
+| H01.FR.01 | ✅      |        |
+| H01.FR.02 | ✅      |        |
+| H01.FR.03 | ✅      |        |
+| H01.FR.04 | ✅      |        |
+| H01.FR.06 | ✅      |        |
+| H01.FR.07 | ✅      |        |
+| H01.FR.09 | ✅      |        |
+| H01.FR.11 | ✅      |        |
+| H01.FR.12 | ✅      |        |
+| H01.FR.14 | ✅      |        |
+| H01.FR.15 | ✅      |        |
+| H01.FR.16 | ✅      |        |
+| H01.FR.17 | ✅      |        |
+| H01.FR.18 | ✅      |        |
+| H01.FR.19 | ✅      |        |
 | H01.FR.20 |        |        |
 | H01.FR.23 |        |        |
 | H01.FR.24 |        |        |
@@ -1094,29 +1094,31 @@ This document contains the status of which OCPP 2.0.1 numbered functional requir
 
 | ID        | Status | Remark |
 |-----------|--------|--------|
-| H02.FR.01 |        |        |
-| H02.FR.02 |        |        |
+| H02.FR.01 | ✅      |        |
+| H02.FR.02 | ✅      |        |
 
 ## Reservation - Use a reserved EVSE
 
 | ID        | Status | Remark |
 |-----------|--------|--------|
-| H03.FR.01 |        |        |
-| H03.FR.02 |        |        |
-| H03.FR.03 |        |        |
-| H03.FR.04 |        |        |
-| H03.FR.05 |        |        |
-| H03.FR.06 |        |        |
-| H03.FR.07 |        |        |
-| H03.FR.08 |        |        |
+| H03.FR.01 | ✅      |        |
+| H03.FR.02 | ✅      |        |
+| H03.FR.03 | ✅      |        |
+| H03.FR.04 | ✅      |        |
+| H03.FR.05 | ✅      |        |
+| H03.FR.06 | ✅      |        |
+| H03.FR.07 | ⛽️      |        |
+| H03.FR.08 | ⛽️      |        |
+| H03.FR.09 | ✅      |        |
+| H03.FR.10 | ✅      |        |
 
 ## Reservation - Reservation Ended, not used
 
 | ID        | Status | Remark |
 |-----------|--------|--------|
-| H04.FR.01 |        |        |
-| H04.FR.02 |        |        |
-| H04.FR.03 |        |        |
+| H04.FR.01 | ✅      |        |
+| H04.FR.02 | ✅      |        |
+| H04.FR.03 |        | Not all the connectors maybe?       |
 
 ## TariffAndCost - Show EV Driver-specific Tariff Information
 

include/ocpp/v201/charge_point.hpp

@@ -29,6 +29,7 @@
 #include "ocpp/v201/messages/Get15118EVCertificate.hpp"
 #include <ocpp/v201/messages/Authorize.hpp>
 #include <ocpp/v201/messages/BootNotification.hpp>
+#include <ocpp/v201/messages/CancelReservation.hpp>
 #include <ocpp/v201/messages/CertificateSigned.hpp>
 #include <ocpp/v201/messages/ChangeAvailability.hpp>
 #include <ocpp/v201/messages/ClearCache.hpp>
@@ -60,6 +61,7 @@
 #include <ocpp/v201/messages/ReportChargingProfiles.hpp>
 #include <ocpp/v201/messages/RequestStartTransaction.hpp>
 #include <ocpp/v201/messages/RequestStopTransaction.hpp>
+#include <ocpp/v201/messages/ReserveNow.hpp>
 #include <ocpp/v201/messages/Reset.hpp>
 #include <ocpp/v201/messages/SecurityEventNotification.hpp>
 #include <ocpp/v201/messages/SendLocalList.hpp>
@@ -232,6 +234,11 @@ class ChargePointInterface {
     /// \param connector_id     Reserved connector id
     virtual void on_reserved(const int32_t evse_id, const int32_t connector_id) = 0;
 
+    /// \brief Event handler that should be called when the reservation of the connector is cleared.
+    /// \param evse_id          Cleared EVSE id
+    /// \param connector_id     Cleared connector id.
+    virtual void on_reservation_cleared(const int32_t evse_id, const int32_t connector_id) = 0;
+
     /// \brief Event handler that will update the charging state internally when it has been changed.
     /// \param evse_id          The evse id of which the charging state has changed.
     /// \param charging_state   The new charging state.
@@ -273,6 +280,11 @@ class ChargePointInterface {
     ///
     virtual void on_variable_changed(const SetVariableData& set_variable_data) = 0;
 
+    /// \brief Event handler that will send a ReservationStatusUpdate request.
+    /// \param reservation_id   The reservation id.
+    /// \param status           The status.
+    virtual void on_reservation_status(const int32_t reservation_id, const ReservationUpdateStatusEnum status) = 0;
+
     /// @}  // End handlers group
 
     /// @}
@@ -583,6 +595,22 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     ///
     void set_evse_connectors_unavailable(EvseInterface& evse, bool persist);
 
+    ///
+    /// \brief Check if there is a connector available with the given connector type.
+    /// \param evse_id          The evse to check for.
+    /// \param connector_type   The connector type.
+    /// \return True when a connector is available and the evse id exists.
+    ///
+    bool is_connector_available(const uint32_t evse_id, std::optional<ConnectorEnum> connector_type);
+
+    ///
+    /// \brief Check if the connector exists on the given evse id.
+    /// \param evse_id          The evse id to check for.
+    /// \param connector_type   The connector type.
+    /// \return False if evse id does not exist or evse does not have the given connector type.
+    ///
+    bool does_connector_exist(const uint32_t evse_id, std::optional<ConnectorEnum> connector_type);
+
     /// \brief Get the value optional offline flag
     /// \return true if the charge point is offline. std::nullopt if it is online;
     bool is_offline();
@@ -727,6 +755,11 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     void handle_change_availability_req(Call<ChangeAvailabilityRequest> call);
     void handle_heartbeat_response(CallResult<HeartbeatResponse> call);
 
+    // Function Block H: Reservations
+    void handle_reserve_now_request(Call<ReserveNowRequest> call);
+    void handle_cancel_reservation_callback(Call<CancelReservationRequest> call);
+    void send_reserve_now_rejected_response(const MessageId& unique_id, const std::string& status_info);
+
     // Functional Block I: TariffAndCost
     void handle_costupdated_req(const Call<CostUpdatedRequest> call);
 
@@ -916,6 +949,8 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
 
     void on_reserved(const int32_t evse_id, const int32_t connector_id) override;
 
+    void on_reservation_cleared(const int32_t evse_id, const int32_t connector_id) override;
+
     bool on_charging_state_changed(
         const uint32_t evse_id, const ChargingStateEnum charging_state,
         const TriggerReasonEnum trigger_reason = TriggerReasonEnum::ChargingStateChanged) override;
@@ -935,6 +970,8 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
 
     void on_variable_changed(const SetVariableData& set_variable_data) override;
 
+    void on_reservation_status(const int32_t reservation_id, const ReservationUpdateStatusEnum status) override;
+
     std::optional<DataTransferResponse> data_transfer_req(const CiString<255>& vendorId,
                                                           const std::optional<CiString<50>>& messageId,
                                                           const std::optional<json>& data) override;

include/ocpp/v201/charge_point_callbacks.hpp

@@ -12,6 +12,7 @@
 #include <ocpp/v201/messages/GetDisplayMessages.hpp>
 #include <ocpp/v201/messages/GetLog.hpp>
 #include <ocpp/v201/messages/RequestStartTransaction.hpp>
+#include <ocpp/v201/messages/ReserveNow.hpp>
 #include <ocpp/v201/messages/SetDisplayMessage.hpp>
 #include <ocpp/v201/messages/TransactionEvent.hpp>
 #include <ocpp/v201/messages/UnlockConnector.hpp>
@@ -160,6 +161,11 @@ struct Callbacks {
                                      std::optional<std::string> currency_code)>>
         set_running_cost_callback;
 
+    /// \brief Callback function is called when a reservation request is received from the CSMS
+    std::optional<std::function<ReserveNowStatusEnum(const ReserveNowRequest& request)>> reserve_now_callback;
+    /// \brief Callback function is called when a cancel reservation request is received from the CSMS
+    std::optional<std::function<bool(const int32_t reservationId)>> cancel_reservation_callback;
+
     /// @} // End ocpp 201 callbacks group / topic
 
     /// @} // End group

include/ocpp/v201/evse.hpp

@@ -36,6 +36,26 @@ class EvseInterface {
     /// \return
     virtual uint32_t get_number_of_connectors() const = 0;
 
+    ///
+    /// \brief Check if the given connector type exists on this evse.
+    /// \param connector_type   The connector type to check.
+    /// \return True if connector type is unknown or this evse has the given connector type.
+    ///
+    virtual bool does_connector_exist(ConnectorEnum connector_type) = 0;
+
+    ///
+    /// \brief Get connector status.
+    ///
+    /// This will search if there is a connector on this evse with status 'Available'. It will search through all
+    /// connectors, optionally filtering by connector type, and return on the first connector that is 'Available'. If
+    /// there is no 'Available' connector, it will return the status of the last found connector with the given
+    /// connector type.
+    ///
+    /// \param connector_type   The connector type to filter on (optional).
+    /// \return Connector status. If connector type is given and does not exist, std::nullopt.
+    ///
+    virtual std::optional<ConnectorStatusEnum> get_connector_status(std::optional<ConnectorEnum> connector_type) = 0;
+
     /// \brief Opens a new transaction
     /// \param transaction_id id of the transaction
     /// \param connector_id id of the connector
@@ -198,6 +218,13 @@ class Evse : public EvseInterface {
     /// \brief Component responsible for maintaining and persisting the operational status of CS, EVSEs, and connectors.
     std::shared_ptr<ComponentStateManagerInterface> component_state_manager;
 
+    ///
+    /// \brief Get connector type of Connector
+    /// \param connector_id     Connector id
+    /// \return The connector type. If evse or connector id is not correct: std::nullopt.
+    ///
+    std::optional<ConnectorEnum> get_evse_connector_type(const uint32_t connector_id);
+
 public:
     /// \brief Construct a new Evse object
     /// \param evse_id id of the evse
@@ -220,6 +247,8 @@ class Evse : public EvseInterface {
     int32_t get_id() const;
 
     uint32_t get_number_of_connectors() const;
+    bool does_connector_exist(const ConnectorEnum connector_type) override;
+    std::optional<ConnectorStatusEnum> get_connector_status(std::optional<ConnectorEnum> connector_type) override;
 
     void open_transaction(const std::string& transaction_id, const int32_t connector_id, const DateTime& timestamp,
                           const MeterValue& meter_start, const std::optional<IdToken>& id_token,

include/ocpp/v201/evse_manager.hpp

@@ -50,9 +50,9 @@ class EvseManager : public EvseManagerInterface {
                 const std::function<void(int32_t evse_id)>& pause_charging_callback);
 
     EvseInterface& get_evse(int32_t id) override;
-    const EvseInterface& get_evse(int32_t id) const override;
+    const EvseInterface& get_evse(const int32_t id) const override;
 
-    bool does_evse_exist(int32_t id) const override;
+    bool does_evse_exist(const int32_t id) const override;
 
     size_t get_number_of_evses() const override;
 

lib/ocpp/v16/charge_point_configuration.cpp

@@ -1512,7 +1512,7 @@ std::optional<KeyValue> ChargePointConfiguration::getReserveConnectorZeroSupport
         KeyValue kv;
         kv.key = "ReserveConnectorZeroSupported";
         kv.readonly = true;
-        kv.value.emplace(std::to_string(reserve_connector_zero_supported.value()));
+        kv.value.emplace(ocpp::conversions::bool_to_string(reserve_connector_zero_supported.value()));
         reserve_connector_zero_supported_kv.emplace(kv);
     }
     return reserve_connector_zero_supported_kv;