Merge pull request #58 from LutzHelling/master

datatime attribute added

Author: kaklakariada

CHANGELOG.md

@@ -1,94 +1,99 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.7.0] - unreleased
+## [1.8.0] - unreleased
+
+## [1.7.0] - 2023-10-07
 
 ### Added
 
-* [#29](https://github.com/kaklakariada/fritzbox-java-api/issues/29) Add support for login via Pbkdf2 challenge-response (propsed by [@linnex81](https://github.com/linnex81))
+- [#29](https://github.com/kaklakariada/fritzbox-java-api/issues/29) Add support for login via Pbkdf2 challenge-response (propsed by [@linnex81](https://github.com/linnex81))
+- [#58](https://github.com/kaklakariada/fritzbox-java-api/pull/58) Datatime attribute added in devicestats XML response since Fritz OS 7.50 (thanks to [@LutzHelling](https://github.com/LutzHelling))
 
 ### Fixed
 
-* [#37](https://github.com/kaklakariada/fritzbox-java-api/issues/37) Support empty device lists
+- [#37](https://github.com/kaklakariada/fritzbox-java-api/issues/37) Support empty device lists
 
 ### Refactoring
 
-* [#50](https://github.com/kaklakariada/fritzbox-java-api/pull/50) Migrate to Junit 5
+- [#50](https://github.com/kaklakariada/fritzbox-java-api/pull/50) Migrate to Junit 5
 
 ## [1.6.0] - 2021-12-04
 
 ### Added
 
-* [#39](https://github.com/kaklakariada/fritzbox-java-api/pull/39) Add new command "getdeviceinfo" (thanks to [@odin568](https://github.com/odin568))
-* [#46](https://github.com/kaklakariada/fritzbox-java-api/pull/46) Add additional attributes to group (thanks to [@TDesjardins](https://github.com/TDesjardins))
-* [#47](https://github.com/kaklakariada/fritzbox-java-api/pull/47) Add hkr attribute supported by FritzOS 7.29 (thanks to [@philippn](https://github.com/philippn))
-* [#38](https://github.com/kaklakariada/fritzbox-java-api/pull/38) Add commands to set status for hkr (tsoll) and for blind (open, close etc.) (thanks to [@JunkerMartin](https://github.com/JunkerMartin))
+- [#39](https://github.com/kaklakariada/fritzbox-java-api/pull/39) Add new command "getdeviceinfo" (thanks to [@odin568](https://github.com/odin568))
+- [#46](https://github.com/kaklakariada/fritzbox-java-api/pull/46) Add additional attributes to group (thanks to [@TDesjardins](https://github.com/TDesjardins))
+- [#47](https://github.com/kaklakariada/fritzbox-java-api/pull/47) Add hkr attribute supported by FritzOS 7.29 (thanks to [@philippn](https://github.com/philippn))
+- [#38](https://github.com/kaklakariada/fritzbox-java-api/pull/38) Add commands to set status for hkr (tsoll) and for blind (open, close etc.) (thanks to [@JunkerMartin](https://github.com/JunkerMartin))
 
 ### Updated
 
-* [#45](https://github.com/kaklakariada/fritzbox-java-api/pull/45) Upgrade dependencies
+- [#45](https://github.com/kaklakariada/fritzbox-java-api/pull/45) Upgrade dependencies
 
 ## [1.5.0] - 2021-12-04
 
 ### Added
 
-* [#34](https://github.com/kaklakariada/fritzbox-java-api/pull/34) Support new device "Blind" and supply device statistics (thanks to [@JunkerMartin](https://github.com/JunkerMartin) for his contribution!)
+- [#34](https://github.com/kaklakariada/fritzbox-java-api/pull/34) Support new device "Blind" and supply device statistics (thanks to [@JunkerMartin](https://github.com/JunkerMartin) for his contribution!)
 
 ### Updated
 
-* [#35](https://github.com/kaklakariada/fritzbox-java-api/pull/35) Upgraded dependencies
+- [#35](https://github.com/kaklakariada/fritzbox-java-api/pull/35) Upgraded dependencies
 
 ## [1.4.0] - 2021-03-03
 
 ### Added
-* [#18](https://github.com/kaklakariada/fritzbox-java-api/pull/18) Added new fields to be compatible with Fritz!OS 7.25
-  * Device (Fritz!Dect440) serves now relative humidity
-  * ColorControl (Fritz!Dect500) got some more fields
-  * Added some getter for fields that did miss them
-* [#19](https://github.com/kaklakariada/fritzbox-java-api/pull/19) Support for device groups
+
+- [#18](https://github.com/kaklakariada/fritzbox-java-api/pull/18) Added new fields to be compatible with Fritz!OS 7.25
+  - Device (Fritz!Dect440) serves now relative humidity
+  - ColorControl (Fritz!Dect500) got some more fields
+  - Added some getter for fields that did miss them
+- [#19](https://github.com/kaklakariada/fritzbox-java-api/pull/19) Support for device groups
 
 ## [1.3.1] - 2021-02-26
 
-* No changes, update deployment to Maven Central
+- No changes, update deployment to Maven Central
 
 ## [1.3.0] - 2021-02-22
 
 ### Breaking Changes
 
-* Requires Java 11 instead of Java 8
-* Moved from JCenter to Maven Central due to [deprecation of JCenter](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/). In your build script use
+- Requires Java 11 instead of Java 8
+- Moved from JCenter to Maven Central due to [deprecation of JCenter](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/). In your build script use
 
-    ```gradle
-    repositories {
-        mavenCentral()
-    }
-    ```
+  ```gradle
+  repositories {
+      mavenCentral()
+  }
+  ```
 
 ## [1.2.2] - 2021-01-16
 
 ### Added
 
-* [#17](https://github.com/kaklakariada/fritzbox-java-api/pull/17): Update for Fritz-Dect!4XX devices. Thanks to [SmokingDevices](https://github.com/SmokingDevices)!
+- [#17](https://github.com/kaklakariada/fritzbox-java-api/pull/17): Update for Fritz-Dect!4XX devices. Thanks to [SmokingDevices](https://github.com/SmokingDevices)!
 
 ## [1.2.1] - 2020-12-06
 
 ### Added
 
-* [#16](https://github.com/kaklakariada/fritzbox-java-api/pull/16): Update for FRITZ-Dect 500 devices. Thanks to [SmokingDevices](https://github.com/SmokingDevices)!
+- [#16](https://github.com/kaklakariada/fritzbox-java-api/pull/16): Update for FRITZ-Dect 500 devices. Thanks to [SmokingDevices](https://github.com/SmokingDevices)!
 
 ## [1.2.0] - 2020-12-06 - invalid
 
 ## [1.1.0] - 2020-10-25
 
 ### Added
 
-* [#15](https://github.com/kaklakariada/fritzbox-java-api/pull/15): Added new fields to be compatible with Fritz!OS 7.21. Thanks to [philippn](https://github.com/philippn)!
+- [#15](https://github.com/kaklakariada/fritzbox-java-api/pull/15): Added new fields to be compatible with Fritz!OS 7.21. Thanks to [philippn](https://github.com/philippn)!
 
 ## [1.0.0] - 2019-12-27
 
 ### Breaking change
 
-* Make Device properties `battery` and `batterylow` optional to distinguish between missing values and zero, see [issue #11](https://github.com/kaklakariada/fritzbox-java-api/issues/11).
+- Make Device properties `battery` and `batterylow` optional to distinguish between missing values and zero, see [issue #11](https://github.com/kaklakariada/fritzbox-java-api/issues/11).

README.md

@@ -36,7 +36,7 @@ See [CHANGELOG.md](CHANGELOG.md).
 
     ```groovy
     dependencies {
-        compile 'com.github.kaklakariada:fritzbox-java-api:1.6.0'
+        compile 'com.github.kaklakariada:fritzbox-java-api:1.6.1'
     }
     ```
 
@@ -46,7 +46,7 @@ See [CHANGELOG.md](CHANGELOG.md).
 <dependency>
   <groupId>com.github.kaklakariada</groupId>
   <artifactId>fritzbox-java-api</artifactId>
-  <version>1.6.0</version>
+  <version>1.6.1</version>
 </dependency>
 ```
 

build.gradle

@@ -11,7 +11,7 @@ plugins {
 }
 
 group 'com.github.kaklakariada'
-version = '1.6.0'
+version = '1.7.0'
 
 java {
     toolchain {

src/main/java/com/github/kaklakariada/fritzbox/model/homeautomation/Statistics.java

@@ -17,17 +17,13 @@
  */
 package com.github.kaklakariada.fritzbox.model.homeautomation;
 
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Optional;
+import java.time.Instant;
+import java.util.*;
 import java.util.stream.Collectors;
 
-import com.github.kaklakariada.fritzbox.helper.StringHelper;
+import org.simpleframework.xml.*;
 
-import org.simpleframework.xml.Attribute;
-import org.simpleframework.xml.Root;
-import org.simpleframework.xml.Text;
+import com.github.kaklakariada.fritzbox.helper.StringHelper;
 
 @Root(name = "stats")
 public class Statistics {
@@ -40,9 +36,25 @@ public class Statistics {
     @Attribute(name = "grid", required = false)
     private int grid;
 
+    @Attribute(name = "datatime", required = false)
+    private Long datatime;
+
     @Text()
     private String csvValues;
 
+    public Statistics() {
+        // Default constructor for XML deserialization
+    }
+
+    Statistics(final MeasurementUnit measurementUnit, final int count, final int grid, final Long datatime,
+            final String csvValues) {
+        this.measurementUnit = measurementUnit;
+        this.count = count;
+        this.grid = grid;
+        this.datatime = datatime;
+        this.csvValues = csvValues;
+    }
+
     public int getCount() {
         return count;
     }
@@ -51,6 +63,26 @@ public int getGrid() {
         return grid;
     }
 
+    /**
+     * Get the raw timestamp in seconds since epoch.
+     * 
+     * @return raw timestamp or {@code null} if not available
+     */
+    public Long getDataTimeRaw() {
+        return datatime;
+    }
+
+    /**
+     * Get the timestamp.
+     * 
+     * @return timestamp or {@code null} if not available
+     */
+    public Instant getDataTime() {
+        return Optional.ofNullable(getDataTimeRaw()) //
+                .map(Instant::ofEpochSecond) //
+                .orElse(null);
+    }
+
     /**
      * Provide the gathered data as provided by Fritz!Box
      * 

src/test/java/com/github/kaklakariada/fritzbox/mapping/DeserializerTest.java

@@ -116,7 +116,8 @@ DeviceList parseDeviceList(final Path file) throws IOException {
 
     @Test
     void parseDeviceStatsFritzDect200() throws IOException {
-        final InputStream fileContent = Files.newInputStream(Paths.get("src/test/resources/FritzOS29/devicestatsFritzDect200.xml"));
+        final InputStream fileContent = Files
+                .newInputStream(Paths.get("src/test/resources/FritzOS29/devicestatsFritzDect200.xml"));
         final DeviceStats stats = new Deserializer().parse(fileContent, DeviceStats.class);
         assertEquals(1, stats.getTemperature().get().getStats().size(), "Temperature has just one statistics Element");
         assertEquals(Double.valueOf(0.1),
@@ -126,6 +127,12 @@ void parseDeviceStatsFritzDect200() throws IOException {
         assertEquals(2, stats.getEnergy().get().getStats().size(), "Energy has two statistics Element");
 
         assertEquals(false, stats.getHumidity().isPresent(), "Humidity is missing");
+
+        assertEquals(true, stats.getEnergy().get().getStats().get(0).getDataTimeRaw() == 1665897036,
+                "DataTime (raw) is missing");
+        assertEquals(false,
+                stats.getEnergy().get().getStats().get(0).getDataTime().toEpochMilli() == 1665897,
+                "DataTime is missing");
     }
 
     @Test

src/test/java/com/github/kaklakariada/fritzbox/model/homeautomation/StatisticsTest.java

@@ -19,15 +19,20 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import java.lang.System.Logger;
+import java.time.Instant;
 import java.util.List;
 import java.util.Optional;
 
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
 
 class StatisticsTest {
 
     private static Statistics statistics;
+    private static final Logger LOGGER = System.getLogger("StatisticsTest");
 
     @BeforeAll
     static void setupStatistics() {
@@ -74,4 +79,15 @@ void getCsvValuesTest() {
         assertEquals(Double.valueOf(11.11), result.get(1).get(), "(5) Second number");
         assertEquals(true, result.get(2).isEmpty(), "(5) Third number is empty");
     }
+
+    @ParameterizedTest
+    @CsvSource(nullValues = "null", value = { "null, null",
+            "0, 1970-01-01T00:00:00Z",
+            "1665897036, 2022-10-16T05:10:36Z",
+    })
+    void dateTime(final Long rawDateTime, final Instant expectedInstant) {
+        final Statistics stat = new Statistics(null, 0, 0, rawDateTime, null);
+        assertEquals(expectedInstant, stat.getDataTime());
+        assertEquals(rawDateTime, stat.getDataTimeRaw());
+    }
 }