options to switch between miles and km

hdurdle · Aug 7, 2019 · b3bf144 · b3bf144
1 parent 960a529
commit b3bf144
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 7 deletions.
diff --git a/MMM-BMWConnected.js b/MMM-BMWConnected.js
@@ -3,7 +3,9 @@ Module.register('MMM-BMWConnected', {
   defaults: {
     apiBase: "www.bmw-connecteddrive.co.uk",
     refresh: 15,
-    vehicleAngle: 300
+    vehicleAngle: 300,
+    distance: "miles",
+    debug: false
   },
 
   getStyles: function () {
@@ -55,6 +57,12 @@ Module.register('MMM-BMWConnected', {
   },
 
   getDom: function () {
+
+    var distanceSuffix = "mi";
+    if (this.config.distance === "km") {
+      distanceSuffix = "km";
+    }
+
     var wrapper = document.createElement("div");
 
     if (this.config.email === "" || this.config.password === "") {
@@ -68,7 +76,6 @@ Module.register('MMM-BMWConnected', {
       return wrapper;
     }
 
-
     var info = this.bmwInfo;
 
     var carContainer = document.createElement("div");
@@ -86,7 +93,7 @@ Module.register('MMM-BMWConnected', {
     var mileage = document.createElement("span");
     mileage.classList.add("mileage");
     mileage.appendChild(this.faIconFactory("fa-road"));
-    mileage.appendChild(document.createTextNode(info.mileage + " mi"));
+    mileage.appendChild(document.createTextNode(info.mileage + " " + distanceSuffix));
     carContainer.appendChild(mileage);
 
     wrapper.appendChild(carContainer);
@@ -138,13 +145,13 @@ Module.register('MMM-BMWConnected', {
     var elecRange = document.createElement("span");
     elecRange.classList.add("elecRange");
     elecRange.appendChild(this.faIconFactory("fa-charging-station"));
-    elecRange.appendChild(document.createTextNode(info.electricRange + " mi"));
+    elecRange.appendChild(document.createTextNode(info.electricRange + " " + distanceSuffix));
     carContainer.appendChild(elecRange);
 
     var fuelRange = document.createElement("span");
     fuelRange.classList.add("fuelRange");
     fuelRange.appendChild(this.faIconFactory("fa-gas-pump"));
-    fuelRange.appendChild(document.createTextNode(info.fuelRange + " mi"));
+    fuelRange.appendChild(document.createTextNode(info.fuelRange + " " + distanceSuffix));
     carContainer.appendChild(fuelRange);
     wrapper.appendChild(carContainer);
 
@@ -155,7 +162,11 @@ Module.register('MMM-BMWConnected', {
     var updated = document.createElement("span");
     updated.classList.add("updated");
     updated.appendChild(this.faIconFactory("fa-info"));
-    updated.appendChild(document.createTextNode("last updated " + moment(info.updateTime).fromNow()));
+    var lastUpdateText = "last updated " + moment(info.updateTime).fromNow();
+    if (this.config.debug) {
+      lastUpdateText += " [" + info.unitOfLength + "]";
+    }
+    updated.appendChild(document.createTextNode(lastUpdateText));
     carContainer.appendChild(updated);
     wrapper.appendChild(carContainer);
 

diff --git a/README.md b/README.md
@@ -63,6 +63,10 @@ The module has a few configuration options:
         <tr>
       <td><code>vehicleAngle</code></td>
       <td>The angle of rotation for the car image. <br /><br /><strong>Default: </strong><code>300</code><br/>Between 0 and 350 in increments of 10.</td>
+    </tr>
+            <tr>
+      <td><code>distance</code></td>
+      <td>The unit of distance used for mileage and range. <br /><br /><strong>Default: </strong><code>miles</code><br/>Can be: miles or km.</td>
     </tr>
   </tbody>
 </table>
@@ -71,6 +75,14 @@ The module has a few configuration options:
 
 If possible the module will pull an image of your car from BMW's API. I only have one BMW, so can't test the placement/graphics of other vehicles. I'd love to see what it looks like if you try it.  Tweet images to me at https://twitter.com/hdurdle 
 
+## Help
+
+If you have a moment, please set <code>debug</code> to <code>true</code> in the config and see what text appears in <code>[ ]</code> after the last updated time.  I'm trying to see what the BMW API returns for countries that use KM instead of miles.  I might be able to avoid making it a config option and pull it direct from the API.  Tweet images and comments to me at https://twitter.com/hdurdle 
+
+![Debug Screenshot](debug.png "Debug Screenshot")
+
+Also, if you can offer translations for the few bits of direct text ("last updated") for your language, let me know (along with where the placeholder should go in your language!).
+
 ## Thanks
 
 Hat tip to [Nils Schneider](https://github.com/Lyve1981/BMW-ConnectedDrive-JSON-Wrapper) for the library code for performing the BMW authentication dance.
diff --git a/debug.png b/debug.png
diff --git a/node_helper.js b/node_helper.js
@@ -54,9 +54,16 @@ module.exports = NodeHelper.create({
                       connectorStatus: attributes.connectorStatus,
                       vin: vin,
                       chargingLevelHv: Number(attributes.chargingLevelHv).toFixed(),
-                      imageUrl: null
+                      imageUrl: null,
+                      unitOfLength: attributes.unitOfLength
                     }
 
+                    if (self.config.distance === "km") {
+                      self.bmwInfo.electricRange = Number(attributes.beRemainingRangeElectricKm).toFixed();
+                      self.bmwInfo.fuelRange = Number(attributes.beRemainingRangeFuelKm).toFixed();
+                    }
+
+
                     var getImagesUri = '/api/vehicle/image/v1/' + vin + "?startAngle=0&stepAngle=10&width=640"
                     bmwrequest.call(self.config.apiBase, getImagesUri, '', token, tokenType, function (data) {
                         try {