Merge pull request #20 from da4throux/history

update doc & clean velibHistory

MMM-Paris-RATP-PG.js

@@ -281,6 +281,9 @@ Module.register("MMM-Paris-RATP-PG",{
   },
 
   socketNotificationReceived: function(notification, payload) {
+    var maxVelibArchiveAge = this.config.velibTrendDay ? 24 * 60 * 60 : this.config.velibTrendTimeScale || 60 * 60;
+    var velibArchiveCleaned = 0;
+    var now = new Date();
     this.caller = notification;
     switch (notification) {
       case "BUS":
@@ -290,18 +293,32 @@ Module.register("MMM-Paris-RATP-PG",{
         this.updateDom();
         break;
       case "VELIB":
-        if (!this.velibHistory[payload.id]) {
+        if (!this.velibHistory[payload.id]) { // loading of data
           this.velibHistory[payload.id] = localStorage[payload.id] ? JSON.parse(localStorage[payload.id]) : [];
+          while ((this.velibHistory[payload.id].length > 0) && (((now - new Date(this.velibHistory[payload.id][0].lastUpdate)) / 1000) > maxVelibArchiveAge) ) {
+            this.velibHistory[payload.id].shift();
+            velibArchiveCleaned++;
+          }
+          if (this.config.debug) {
+            console.log (' *** First load size of velib History for ' + payload.id + ' is: ' + this.velibHistory[payload.id].length);
+            console.log (velibArchiveCleaned + ' elements removed');
+            console.log (this.velibHistory[payload.id]);
+          }
           this.velibHistory[payload.id].push(payload);
           localStorage[payload.id] = JSON.stringify(this.velibHistory[payload.id]);
           if (this.config.debug) {console.log (' *** size of velib History for ' + payload.id + ' is: ' + this.velibHistory[payload.id].length);}
           this.updateDom();
         } else if (this.velibHistory[payload.id][this.velibHistory[payload.id].length - 1].lastUpdate != payload.lastUpdate) {
+          while ((this.velibHistory[payload.id].length > 0) && (((now - new Date(this.velibHistory[payload.id][0].lastUpdate)) / 1000) > maxVelibArchiveAge) ) {
+            this.velibHistory[payload.id].shift();
+            velibArchiveCleaned++;
+          }
           this.velibHistory[payload.id].push(payload);
           localStorage[payload.id] = JSON.stringify(this.velibHistory[payload.id]);
           this.updateDom();
           if (this.config.debug) {
-            console.log (' *** size of velib History for ' + payload.id + ' is: ' + this.velibHistory[payload.id].length);
+            console.log (' *** Update - size of velib History for ' + payload.id + ' is: ' + this.velibHistory[payload.id].length);
+            console.log (velibArchiveCleaned + ' elements removed');
             console.log (this.velibHistory[payload.id]);
           }
         } else {

README.md

@@ -11,11 +11,11 @@ A module to display:
 * available docks & bikes in selected Velib stations, along with the trend over the last day (configurable).
 
 # Screenshot
-![screenshot](https://github.com/da4throux/MMM-Paris-RATP-PG/blob/master/MMM-Paris-RATP-PG2.png)
+![screenshot](https://github.com/da4throux/MMM-Paris-RATP-PG/blob/history/MMM-Paris-RATP-PG%201.6.png)
 
 # API
 
-It is based on the open REST API from Pierre Grimaud https://github.com/pgrimaud/horaires-ratp-api, which does not require any configuration / registration. Immediate use. Support v2 & v3.
+It is based on the open REST API from Pierre Grimaud https://github.com/pgrimaud/horaires-ratp-api, which does not require any configuration / registration. Immediate use. Support v2 & v3 (however the v2 seems to be deprecated, so you should rely on v3).
 It also use the Paris Open Data for the velib: https://opendata.paris.fr/explore/dataset/stations-velib-disponibilites-en-temps-reel/ (use it to get the 5 digits stations you will need for the configuration).
 
 # Install
@@ -83,4 +83,4 @@ busStations: [
 	{api: 'v3', type: 'metros', line: '6', stations: 'raspail', destination: 'A'},
 	{type: 'velib', stations: 05029, destination: 'leaving', label 'RER'}]
 ```
-# v1.5
+# v1.6