Merge pull request #1809 from steve-community/1759-txprofile-within-remotestarttransactionreq

TxProfile within RemoteStartTransaction.req

Author: goekay

src/main/java/de/rwth/idsg/steve/ocpp/task/RemoteStartTransactionTask.java

@@ -30,8 +30,12 @@
  */
 public class RemoteStartTransactionTask extends CommunicationTask<RemoteStartTransactionParams, String> {
 
-    public RemoteStartTransactionTask(RemoteStartTransactionParams params) {
+    private final ocpp.cp._2015._10.ChargingProfile chargingProfile;
+
+    public RemoteStartTransactionTask(RemoteStartTransactionParams params,
+                                      ocpp.cp._2015._10.ChargingProfile chargingProfile) {
         super(params);
+        this.chargingProfile = chargingProfile;
     }
 
     @Override
@@ -53,14 +57,12 @@ public ocpp.cp._2012._06.RemoteStartTransactionRequest getOcpp15Request() {
                 .withConnectorId(params.getConnectorId());
     }
 
-    /**
-     * TODO: RemoteStartTransactionRequest.chargingProfile not implemented
-     */
     @Override
     public ocpp.cp._2015._10.RemoteStartTransactionRequest getOcpp16Request() {
         return new ocpp.cp._2015._10.RemoteStartTransactionRequest()
                 .withIdTag(params.getIdTag())
-                .withConnectorId(params.getConnectorId());
+                .withConnectorId(params.getConnectorId())
+                .withChargingProfile(chargingProfile);
     }
 
     @Override

src/main/java/de/rwth/idsg/steve/ocpp/task/SetChargingProfileTaskFromDB.java

@@ -21,6 +21,7 @@
 import de.rwth.idsg.steve.ocpp.OcppCallback;
 import de.rwth.idsg.steve.repository.ChargingProfileRepository;
 import de.rwth.idsg.steve.repository.dto.ChargingProfile;
+import de.rwth.idsg.steve.utils.mapper.ChargingProfileDetailsMapper;
 import de.rwth.idsg.steve.web.dto.ocpp.SetChargingProfileParams;
 import jooq.steve.db.tables.records.ChargingProfileRecord;
 import ocpp.cp._2015._10.ChargingProfileKindType;
@@ -70,36 +71,7 @@ public void success(String chargeBoxId, String statusValue) {
 
     @Override
     public SetChargingProfileRequest getOcpp16Request() {
-        ChargingProfileRecord profile = details.getProfile();
-
-        List<ChargingSchedulePeriod> schedulePeriods =
-            details.getPeriods()
-                       .stream()
-                       .map(k -> {
-                           ChargingSchedulePeriod p = new ChargingSchedulePeriod();
-                           p.setStartPeriod(k.getStartPeriodInSeconds());
-                           p.setLimit(k.getPowerLimit());
-                           p.setNumberPhases(k.getNumberPhases());
-                           return p;
-                       })
-                       .collect(Collectors.toList());
-
-        ChargingSchedule schedule = new ChargingSchedule()
-                .withDuration(profile.getDurationInSeconds())
-                .withStartSchedule(profile.getStartSchedule())
-                .withChargingRateUnit(ChargingRateUnitType.fromValue(profile.getChargingRateUnit()))
-                .withMinChargingRate(profile.getMinChargingRate())
-                .withChargingSchedulePeriod(schedulePeriods);
-
-        ocpp.cp._2015._10.ChargingProfile ocppProfile = new ocpp.cp._2015._10.ChargingProfile()
-                .withChargingProfileId(profile.getChargingProfilePk())
-                .withStackLevel(profile.getStackLevel())
-                .withChargingProfilePurpose(ChargingProfilePurposeType.fromValue(profile.getChargingProfilePurpose()))
-                .withChargingProfileKind(ChargingProfileKindType.fromValue(profile.getChargingProfileKind()))
-                .withRecurrencyKind(profile.getRecurrencyKind() == null ? null : RecurrencyKindType.fromValue(profile.getRecurrencyKind()))
-                .withValidFrom(profile.getValidFrom())
-                .withValidTo(profile.getValidTo())
-                .withChargingSchedule(schedule);
+        ocpp.cp._2015._10.ChargingProfile ocppProfile = ChargingProfileDetailsMapper.mapToOcpp(details);
 
         var request = new SetChargingProfileRequest()
                 .withConnectorId(connectorId)

src/main/java/de/rwth/idsg/steve/service/ChargePointServiceClient.java

@@ -18,6 +18,7 @@
  */
 package de.rwth.idsg.steve.service;
 
+import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.config.DelegatingTaskExecutor;
 import de.rwth.idsg.steve.ocpp.ChargePointServiceInvokerImpl;
 import de.rwth.idsg.steve.ocpp.OcppCallback;
@@ -48,6 +49,7 @@
 import de.rwth.idsg.steve.repository.dto.ChargingProfile;
 import de.rwth.idsg.steve.repository.dto.InsertReservationParams;
 import de.rwth.idsg.steve.service.dto.EnhancedReserveNowParams;
+import de.rwth.idsg.steve.utils.mapper.ChargingProfileDetailsMapper;
 import de.rwth.idsg.steve.web.dto.ocpp.CancelReservationParams;
 import de.rwth.idsg.steve.web.dto.ocpp.ChangeAvailabilityParams;
 import de.rwth.idsg.steve.web.dto.ocpp.ChangeConfigurationParams;
@@ -199,7 +201,17 @@ public final int updateFirmware(UpdateFirmwareParams params,
     @SafeVarargs
     public final int remoteStartTransaction(RemoteStartTransactionParams params,
                                             OcppCallback<String>... callbacks) {
-        RemoteStartTransactionTask task = new RemoteStartTransactionTask(params);
+        ocpp.cp._2015._10.ChargingProfile chargingProfile = null;
+        Integer chargingProfilePk = params.getChargingProfilePk();
+        if (chargingProfilePk != null) {
+            ChargingProfile.Details details = chargingProfileRepository.getDetails(chargingProfilePk);
+            chargingProfile = ChargingProfileDetailsMapper.mapToOcpp(details);
+            if (chargingProfile.getChargingProfilePurpose() != ChargingProfilePurposeType.TX_PROFILE) {
+                throw new SteveException("ChargingProfilePurposeType is not TX_PROFILE");
+            }
+        }
+
+        RemoteStartTransactionTask task = new RemoteStartTransactionTask(params, chargingProfile);
 
         for (var callback : callbacks) {
             task.addCallback(callback);

src/main/java/de/rwth/idsg/steve/utils/mapper/ChargingProfileDetailsMapper.java

@@ -27,9 +27,12 @@
 import ocpp.cp._2015._10.ChargingProfileKindType;
 import ocpp.cp._2015._10.ChargingProfilePurposeType;
 import ocpp.cp._2015._10.ChargingRateUnitType;
+import ocpp.cp._2015._10.ChargingSchedule;
+import ocpp.cp._2015._10.ChargingSchedulePeriod;
 import ocpp.cp._2015._10.RecurrencyKindType;
 
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * @author Sevket Goekay <[email protected]>
@@ -38,6 +41,39 @@
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public final class ChargingProfileDetailsMapper {
 
+    public static ocpp.cp._2015._10.ChargingProfile mapToOcpp(ChargingProfile.Details details) {
+        ChargingProfileRecord profile = details.getProfile();
+
+        List<ChargingSchedulePeriod> schedulePeriods =
+            details.getPeriods()
+                .stream()
+                .map(k -> {
+                    ChargingSchedulePeriod p = new ChargingSchedulePeriod();
+                    p.setStartPeriod(k.getStartPeriodInSeconds());
+                    p.setLimit(k.getPowerLimit());
+                    p.setNumberPhases(k.getNumberPhases());
+                    return p;
+                })
+                .collect(Collectors.toList());
+
+        ChargingSchedule schedule = new ChargingSchedule()
+            .withDuration(profile.getDurationInSeconds())
+            .withStartSchedule(profile.getStartSchedule())
+            .withChargingRateUnit(ChargingRateUnitType.fromValue(profile.getChargingRateUnit()))
+            .withMinChargingRate(profile.getMinChargingRate())
+            .withChargingSchedulePeriod(schedulePeriods);
+
+        return new ocpp.cp._2015._10.ChargingProfile()
+            .withChargingProfileId(profile.getChargingProfilePk())
+            .withStackLevel(profile.getStackLevel())
+            .withChargingProfilePurpose(ChargingProfilePurposeType.fromValue(profile.getChargingProfilePurpose()))
+            .withChargingProfileKind(ChargingProfileKindType.fromValue(profile.getChargingProfileKind()))
+            .withRecurrencyKind(profile.getRecurrencyKind() == null ? null : RecurrencyKindType.fromValue(profile.getRecurrencyKind()))
+            .withValidFrom(profile.getValidFrom())
+            .withValidTo(profile.getValidTo())
+            .withChargingSchedule(schedule);
+    }
+
     public static ChargingProfileForm mapToForm(ChargingProfile.Details details) {
         ChargingProfileRecord profile = details.getProfile();
         List<ChargingSchedulePeriodRecord> periods = details.getPeriods();

src/main/java/de/rwth/idsg/steve/web/controller/Ocpp12Controller.java

@@ -81,6 +81,14 @@ public class Ocpp12Controller {
     // Helpers
     // -------------------------------------------------------------------------
 
+    /**
+     * https://github.com/steve-community/steve/issues/1759
+     * used to create form in order to send charging profile within remote start tx for ocpp 1.6.
+     */
+    protected void setCommonAttributesForRemoteStartTx(Model model) {
+        // nothing to do for versions below 1.6
+    }
+
     protected void setCommonAttributesForTx(Model model) {
         setCommonAttributes(model);
     }
@@ -149,6 +157,7 @@ public String getGetDiag(Model model) {
     public String getRemoteStartTx(Model model) {
         setCommonAttributesForTx(model);
         setActiveUserIdTagList(model);
+        setCommonAttributesForRemoteStartTx(model);
         model.addAttribute(PARAMS, new RemoteStartTransactionParams());
         return getPrefix() + REMOTE_START_TX_PATH;
     }
@@ -232,6 +241,7 @@ public String postRemoteStartTx(@Valid @ModelAttribute(PARAMS) RemoteStartTransa
         if (result.hasErrors()) {
             setCommonAttributesForTx(model);
             setActiveUserIdTagList(model);
+            setCommonAttributesForRemoteStartTx(model);
             return getPrefix() + REMOTE_START_TX_PATH;
         }
         return REDIRECT_TASKS_PATH + chargePointServiceClient.remoteStartTransaction(params);

src/main/java/de/rwth/idsg/steve/web/controller/Ocpp16Controller.java

@@ -70,6 +70,11 @@ public class Ocpp16Controller extends Ocpp15Controller {
     // Helpers
     // -------------------------------------------------------------------------
 
+    protected void setCommonAttributesForRemoteStartTx(Model model) {
+        model.addAttribute("profileForRemoteStartTx", Boolean.TRUE);
+        model.addAttribute("profileList", chargingProfileRepository.getBasicInfo());
+    }
+
     @Override
     protected void setCommonAttributesForTx(Model model) {
         model.addAttribute("cpList", chargePointHelperService.getChargePoints(OcppVersion.V_16));

src/main/java/de/rwth/idsg/steve/web/dto/ocpp/RemoteStartTransactionParams.java

@@ -24,20 +24,25 @@
 
 import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Positive;
 
 /**
  * @author Sevket Goekay <[email protected]>
  * @since 01.01.2015
  */
 @Getter
+@Setter
 public class RemoteStartTransactionParams extends SingleChargePointSelect {
 
     @Min(value = 0, message = "Connector ID must be at least {value}")
     private Integer connectorId;
 
     @NotBlank(message = "User ID Tag is required")
     @IdTag
-    @Setter private String idTag;
+    private String idTag;
+
+    @Positive
+    private Integer chargingProfilePk;
 
     /**
      * Not for a specific connector, when frontend sends the value 0.

src/main/resources/webapp/WEB-INF/views/op-forms/RemoteStartTransactionForm.jsp

@@ -33,6 +33,16 @@
                 </form:select>
             </td>
         </tr>
+        <c:if test="${profileForRemoteStartTx}">
+            <tr>
+                <td>Charging Profile ID:</td>
+                <td><form:select path="chargingProfilePk">
+                    <option value="" selected>-- Empty --</option>
+                    <form:options items="${profileList}" itemLabel="itemDescription" itemValue="chargingProfilePk"/>
+                </form:select>
+                </td>
+            </tr>
+        </c:if>
         <tr><td></td><td><div class="submit-button"><input type="submit" value="Perform"></div></td></tr>
     </table>
-</form:form>
+</form:form>