[MQTT] encode dates as unquoted ISO 8601 strings with offset and without timezone

Author: tisoft

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - MQTT
   - **Breaking** The default refresh rate while the car is active has been changed to 30 seconds
   - **Breaking** The default refresh rate while the car is inactive has been changed to 24 hours
+  - **Breaking** encode dates as unquoted ISO 8601 strings with offset and without timezone
   - support configuring `refresh/mode`, `refresh/period/active`, `refresh/period/inActive` and `refresh/period/inActiveGrace` via MQTT
   - Handle fallback for SOC when charge status update fails
   - ensure that a changed systemd configuration is picked up

saic-java-mqtt-gateway/src/main/java/net/heberling/ismart/mqtt/MessageHandler.java

@@ -4,8 +4,8 @@
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
+import java.time.OffsetDateTime;
 import java.time.ZoneId;
-import java.time.ZonedDateTime;
 import net.heberling.ismart.Client;
 import net.heberling.ismart.asn1.v1_1.Message;
 import net.heberling.ismart.asn1.v1_1.MessageCoder;
@@ -89,7 +89,7 @@ private SaicMessage convert(net.heberling.ismart.asn1.v1_1.entity.Message messag
         message.getMessageId(),
         message.getMessageType(),
         new String(message.getTitle(), StandardCharsets.UTF_8),
-        ZonedDateTime.ofInstant(
+        OffsetDateTime.ofInstant(
             Instant.ofEpochSecond(message.getMessageTime().getSeconds()), ZoneId.systemDefault()),
         new String(message.getSender(), StandardCharsets.UTF_8),
         new String(message.getContent(), StandardCharsets.UTF_8),

saic-java-mqtt-gateway/src/main/java/net/heberling/ismart/mqtt/SaicMessage.java

@@ -1,6 +1,6 @@
 package net.heberling.ismart.mqtt;
 
-import java.time.ZonedDateTime;
+import java.time.OffsetDateTime;
 
 public class SaicMessage {
 
@@ -10,7 +10,7 @@ public class SaicMessage {
 
   private final String title;
 
-  private final ZonedDateTime messageTime;
+  private final OffsetDateTime messageTime;
 
   private final String sender;
 
@@ -26,7 +26,7 @@ public SaicMessage(
       Long messageId,
       String messageType,
       String title,
-      ZonedDateTime messageTime,
+      OffsetDateTime messageTime,
       String sender,
       String content,
       Integer readStatus,
@@ -53,7 +53,7 @@ public String getTitle() {
     return title;
   }
 
-  public ZonedDateTime getMessageTime() {
+  public OffsetDateTime getMessageTime() {
     return messageTime;
   }
 

saic-java-mqtt-gateway/src/main/java/net/heberling/ismart/mqtt/VehicleHandler.java

@@ -6,7 +6,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.nio.charset.StandardCharsets;
-import java.time.ZonedDateTime;
+import java.time.OffsetDateTime;
 import java.util.*;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeoutException;
@@ -64,10 +64,10 @@ public VehicleHandler(
   void handleVehicle() throws MqttException, IOException {
     vehicleState.configure(vinInfo);
     // we just got started, force some updates
-    ZonedDateTime startTime = ZonedDateTime.now();
+    OffsetDateTime startTime = OffsetDateTime.now();
     vehicleState.notifyCarActivityTime(startTime, true);
     while (true) {
-      if (!vehicleState.isComplete() && ZonedDateTime.now().isAfter(startTime.plusSeconds(10))) {
+      if (!vehicleState.isComplete() && OffsetDateTime.now().isAfter(startTime.plusSeconds(10))) {
         vehicleState.configureMissing();
       }
       if (vehicleState.isComplete() && vehicleState.shouldRefresh()) {
@@ -296,7 +296,7 @@ private void sendCommand(byte type, SortedMap<Integer, byte[]> parameter)
     MessageCoder<OTA_RVCReq> otaRvcReqMessageCoder = new MessageCoder<>(OTA_RVCReq.class);
 
     // we send a command end expect the car to wake up
-    vehicleState.notifyCarActivityTime(ZonedDateTime.now(), false);
+    vehicleState.notifyCarActivityTime(OffsetDateTime.now(), false);
 
     OTA_RVCReq req = new OTA_RVCReq();
     req.setRvcReqType(new byte[] {type});
@@ -373,7 +373,7 @@ private void sendCharging(boolean state)
         new net.heberling.ismart.asn1.v3_0.MessageCoder<>(OTA_ChrgCtrlReq.class);
 
     // we send a command end expect the car to wake up
-    vehicleState.notifyCarActivityTime(ZonedDateTime.now(), false);
+    vehicleState.notifyCarActivityTime(OffsetDateTime.now(), false);
 
     OTA_ChrgCtrlReq req = new OTA_ChrgCtrlReq();
     req.setTboxV2XReq(0);

saic-java-mqtt-gateway/src/main/java/net/heberling/ismart/mqtt/VehicleState.java

@@ -6,7 +6,7 @@
 
 import java.nio.charset.StandardCharsets;
 import java.time.Clock;
-import java.time.ZonedDateTime;
+import java.time.OffsetDateTime;
 import java.time.temporal.ChronoUnit;
 import java.util.HashMap;
 import java.util.Map;
@@ -27,10 +27,10 @@ public class VehicleState {
   private final IMqttClient client;
   private final String mqttVINPrefix;
   private Supplier<Clock> clockSupplier;
-  private ZonedDateTime lastCarActivity;
-  private ZonedDateTime lastSuccessfulRefresh;
-  private ZonedDateTime lastCarShutdown;
-  private ZonedDateTime lastVehicleMessage;
+  private OffsetDateTime lastCarActivity;
+  private OffsetDateTime lastSuccessfulRefresh;
+  private OffsetDateTime lastCarShutdown;
+  private OffsetDateTime lastVehicleMessage;
   // treat HV battery as active, if we don't have any other information
   private boolean hvBatteryActive = true;
   private Long refreshPeriodActive;
@@ -48,7 +48,7 @@ protected VehicleState(
     this.client = client;
     this.mqttVINPrefix = mqttAccountPrefix + "/" + VEHICLES + "/" + vin;
     this.clockSupplier = clockSupplier;
-    lastCarShutdown = ZonedDateTime.now(clockSupplier.get());
+    lastCarShutdown = OffsetDateTime.now(clockSupplier.get());
   }
 
   public String getMqttVINPrefix() {
@@ -373,8 +373,7 @@ public void handleVehicleStatusMessage(
     }
 
     msg =
-        new MqttMessage(
-            SaicMqttGateway.toJSON(ZonedDateTime.now(getClock())).getBytes(StandardCharsets.UTF_8));
+        new MqttMessage(OffsetDateTime.now(getClock()).toString().getBytes(StandardCharsets.UTF_8));
     msg.setQos(0);
     msg.setRetained(true);
     client.publish(mqttVINPrefix + "/" + REFRESH_LAST_VEHICLE_STATE, msg);
@@ -466,19 +465,18 @@ public void handleChargeStatusMessage(
     client.publish(mqttVINPrefix + "/" + DRIVETRAIN_SOC, msg);
 
     msg =
-        new MqttMessage(
-            SaicMqttGateway.toJSON(ZonedDateTime.now(getClock())).getBytes(StandardCharsets.UTF_8));
+        new MqttMessage(OffsetDateTime.now(getClock()).toString().getBytes(StandardCharsets.UTF_8));
     msg.setQos(0);
     msg.setRetained(true);
     client.publish(mqttVINPrefix + "/" + REFRESH_LAST_CHARGE_STATE, msg);
   }
 
-  public void notifyCarActivityTime(ZonedDateTime now, boolean force) throws MqttException {
+  public void notifyCarActivityTime(OffsetDateTime now, boolean force) throws MqttException {
     // if the car activity changed, notify the channel
     if (lastCarActivity == null || force || lastCarActivity.isBefore(now)) {
       lastCarActivity = now;
       MqttMessage msg =
-          new MqttMessage(SaicMqttGateway.toJSON(lastCarActivity).getBytes(StandardCharsets.UTF_8));
+          new MqttMessage(lastCarActivity.toString().getBytes(StandardCharsets.UTF_8));
       msg.setQos(0);
       msg.setRetained(true);
       client.publish(mqttVINPrefix + "/" + REFRESH_LAST_ACTIVITY, msg);
@@ -522,19 +520,19 @@ public boolean shouldRefresh() {
         if (hvBatteryActive
             || lastCarShutdown
                 .plus(refreshPeriodAfterShutdown, ChronoUnit.SECONDS)
-                .isAfter(ZonedDateTime.now(getClock()))) {
+                .isAfter(OffsetDateTime.now(getClock()))) {
           return lastSuccessfulRefresh.isBefore(
-              ZonedDateTime.now(getClock()).minus(refreshPeriodActive, ChronoUnit.SECONDS));
+              OffsetDateTime.now(getClock()).minus(refreshPeriodActive, ChronoUnit.SECONDS));
         } else {
           return lastSuccessfulRefresh.isBefore(
-              ZonedDateTime.now(getClock()).minus(refreshPeriodInactive, ChronoUnit.SECONDS));
+              OffsetDateTime.now(getClock()).minus(refreshPeriodInactive, ChronoUnit.SECONDS));
         }
     }
   }
 
   public void setHVBatteryActive(boolean hvBatteryActive) throws MqttException {
     if (!hvBatteryActive && this.hvBatteryActive) {
-      this.lastCarShutdown = ZonedDateTime.now(getClock());
+      this.lastCarShutdown = OffsetDateTime.now(getClock());
     }
     this.hvBatteryActive = hvBatteryActive;
 
@@ -545,7 +543,7 @@ public void setHVBatteryActive(boolean hvBatteryActive) throws MqttException {
     client.publish(mqttVINPrefix + "/" + DRIVETRAIN_HV_BATTERY_ACTIVE, msg);
 
     if (hvBatteryActive) {
-      notifyCarActivityTime(ZonedDateTime.now(getClock()), true);
+      notifyCarActivityTime(OffsetDateTime.now(getClock()), true);
     }
   }
 
@@ -617,7 +615,7 @@ public RefreshMode getRefreshMode() {
   }
 
   public void markSuccessfulRefresh() {
-    this.lastSuccessfulRefresh = ZonedDateTime.now(getClock());
+    this.lastSuccessfulRefresh = OffsetDateTime.now(getClock());
   }
 
   public void setRefreshPeriodAfterShutdown(long refreshPeriodAfterShutdown) {

saic-java-mqtt-gateway/src/test/java/net/heberling/ismart/mqtt/VehicleStateTest.java

@@ -5,8 +5,8 @@
 
 import java.time.Clock;
 import java.time.Instant;
+import java.time.OffsetDateTime;
 import java.time.ZoneId;
-import java.time.ZonedDateTime;
 import org.eclipse.paho.client.mqttv3.MqttClient;
 import org.eclipse.paho.client.mqttv3.MqttException;
 import org.junit.jupiter.api.BeforeEach;
@@ -29,7 +29,7 @@ public void setUp() throws MqttException {
     clock = Clock.fixed(Instant.ofEpochSecond(REFERENCE_TIME), ZoneId.systemDefault());
     vehicleState = new VehicleState(mqttClient, "test/topic", "test", () -> this.clock);
     vehicleState.configureMissing();
-    vehicleState.notifyCarActivityTime(ZonedDateTime.now(clock), true);
+    vehicleState.notifyCarActivityTime(OffsetDateTime.now(clock), true);
   }
 
   @Test
@@ -40,7 +40,7 @@ public void willAllwaysRefreshOnFirstCall() {
   @Test
   public void willRefreshIfCarWasActiveAfterLastRefresh() throws MqttException {
     clock = Clock.offset(clock, java.time.Duration.ofSeconds(60));
-    vehicleState.notifyCarActivityTime(ZonedDateTime.now(clock), true);
+    vehicleState.notifyCarActivityTime(OffsetDateTime.now(clock), true);
     assertThat(vehicleState.shouldRefresh(), is(true));
   }