Merge pull request #4587 from jasoncalabrese/override-mode

feat: Override mode plugin

Author: jasoncalabrese

README.md

@@ -96,6 +96,7 @@ Community maintained fork of the
         - [`pump` (Pump Monitoring)](#pump-pump-monitoring)
         - [`openaps` (OpenAPS)](#openaps-openaps)
         - [`loop` (Loop)](#loop-loop)
+        - [`override` (Override Mode)](#override-override-mode)
         - [`xdrip-js` (xDrip-js)](#xdrip-js-xdrip-js)
         - [`alexa` (Amazon Alexa)](#alexa-amazon-alexa)
         - [`speech` (Speech)](#speech-speech)
@@ -485,6 +486,10 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm
   * `LOOP_URGENT` (`60`) - The number of minutes since the last loop that needs to be exceeded before an urgent alarm is triggered
   * Add `loop` to `SHOW_FORECAST` to show forecasted BG.
 
+##### `override` (Override Mode)
+  Additional monitoring for DIY automated insulin delivery systems to display real-time overrides such as Eating Soon or Exercise Mode:
+  * Requires `DEVICESTATUS_ADVANCED="true"` to be set
+
 ##### `xdrip-js` (xDrip-js)
   Integrated xDrip-js monitoring, uses these extended settings:
   * Requires `DEVICESTATUS_ADVANCED="true"` to be set

lib/plugins/index.js

@@ -37,6 +37,7 @@ function init (ctx) {
     , require('./openaps')(ctx)
     , require('./xdrip-js')(ctx)
     , require('./loop')(ctx)
+    , require('./override')(ctx)
     , require('./boluswizardpreview')(ctx)
     , require('./cannulaage')(ctx)
     , require('./sensorage')(ctx)

lib/plugins/loop.js

@@ -113,6 +113,16 @@ function init(ctx) {
       }
     }
 
+    function assignLastOverride (status) {
+      var override = status.override;
+      if (override && override.timestamp) {
+        override.moment = moment(override.timestamp);
+        if (!result.lastOverride || override.moment.isAfter(result.lastOverride.moment)) {
+          result.lastOverride = override;
+        }
+      }
+    }
+
     function assignLastOkMoment (loopStatus) {
       if (!loopStatus.failureReason && (!result.lastOkMoment || loopStatus.moment.isAfter(result.lastOkMoment))) {
         result.lastOkMoment = loopStatus.moment;
@@ -126,6 +136,7 @@ function init(ctx) {
         assignLastEnacted(loopStatus);
         assignLastLoop(loopStatus);
         assignLastPredicted(loopStatus);
+        assignLastOverride(status);
         assignLastOkMoment(loopStatus);
       }
     });
@@ -299,27 +310,28 @@ function init(ctx) {
       if (prop.lastLoop && prop.lastLoop.predicted) {
         var predictedBGvalues = prop.lastLoop.predicted.values;
         var eventualBG = predictedBGvalues[predictedBGvalues.length-1];
-	var maxBG = Math.max.apply(null,predictedBGvalues);
-	var minBG = Math.min.apply(null,predictedBGvalues);
-	var eventualBGscaled = sbx.settings.units === 'mmol' ? 
+        var maxBG = Math.max.apply(null,predictedBGvalues);
+        var minBG = Math.min.apply(null,predictedBGvalues);
+        var eventualBGscaled = sbx.settings.units === 'mmol' ?
             sbx.roundBGToDisplayFormat(sbx.scaleMgdl(eventualBG)) : eventualBG;
         var maxBGscaled = sbx.settings.units === 'mmol' ? 
             sbx.roundBGToDisplayFormat(sbx.scaleMgdl(maxBG)) : maxBG;
         var minBGscaled = sbx.settings.units === 'mmol' ? 
             sbx.roundBGToDisplayFormat(sbx.scaleMgdl(minBG)) : minBG;
+
         valueParts = valueParts.concat([
           ', Predicted Min-Max BG: '
-	  , minBGscaled
-	  , '-'
-	  , maxBGscaled
+          , minBGscaled
+          , '-'
+          , maxBGscaled
           ,', Eventual BG: '
-	  , eventualBGscaled
+          , eventualBGscaled
         ]);
       }
-	    
+
       return valueParts;
     } 
-	  
+
     function concatRecommendedBolus (valueParts) {
       if (prop.lastLoop && prop.lastLoop.recommendedBolus) {
         var recommendedBolus = prop.lastLoop.recommendedBolus;
@@ -331,8 +343,7 @@ function init(ctx) {
 
       return valueParts;
     }  
- 
-	  
+
     function getForecastPoints ( ) {
       var points = [ ];
 
@@ -397,12 +408,23 @@ function init(ctx) {
       loopName = prop.lastLoop.name;
     }
 
+    var eventualBGValue = '';
+    if (prop.lastLoop && prop.lastLoop.predicted) {
+      var predictedBGvalues = prop.lastLoop.predicted.values;
+      var eventualBG = predictedBGvalues[predictedBGvalues.length-1];
+      if (sbx.settings.units === 'mmol') {
+        eventualBG = sbx.roundBGToDisplayFormat(sbx.scaleMgdl(eventualBG));
+      }
+      eventualBGValue = ' ↝ ' + eventualBG;
+    }
+
     var label = loopName + ' ' + prop.display.symbol;
 
-    var lastLoopMoment = prop.lastLoop ? prop.lastLoop.moment : null;
+    var lastLoopValue = prop.lastLoop ?
+      utils.timeFormat(prop.lastLoop.moment, sbx) + eventualBGValue : null;
 
     sbx.pluginBase.updatePillText(loop, {
-      value: utils.timeFormat(lastLoopMoment, sbx)
+      value: lastLoopValue
       , label: label
       , info: info
       , pillClass: statusClass(prop, prefs, sbx)

lib/plugins/override.js

@@ -0,0 +1,67 @@
+'use strict';
+
+function init() {
+  var override = {
+    name: 'override'
+    , label: 'Override'
+    , pluginType: 'pill-status'
+  };
+
+  override.isActive = function isActive(overrideStatus, sbx) {
+
+    if (!overrideStatus) {
+      return false;
+    } else {
+      var endMoment = overrideStatus.duration ? overrideStatus.moment.clone().add(overrideStatus.duration, 'seconds') : null;
+      overrideStatus.endMoment = endMoment;
+      return overrideStatus.active && (!endMoment || endMoment.isAfter(sbx.time));
+    }
+
+  };
+
+  override.updateVisualisation = function updateVisualisation (sbx) {
+    var lastOverride = sbx.properties.loop.lastOverride;
+    var info = [ ];
+    var label = '';
+    var isActive = override.isActive(lastOverride, sbx);
+
+    if (isActive) {
+      if (lastOverride.currentCorrectionRange) {
+        var max = lastOverride.currentCorrectionRange.maxValue;
+        var min = lastOverride.currentCorrectionRange.minValue;
+
+        if (sbx.settings.units === 'mmol') {
+          max = sbx.roundBGToDisplayFormat(sbx.scaleMgdl(max));
+          min = sbx.roundBGToDisplayFormat(sbx.scaleMgdl(min));
+        }
+
+        if (lastOverride.currentCorrectionRange.minValue === lastOverride.currentCorrectionRange.maxValue) {
+          label += 'BG Target: ' + min;
+        } else {
+          label += 'BG Targets: ' + min + ':' + max;
+        }
+      }
+      if ((lastOverride.multiplier || lastOverride.multiplier === 0) && lastOverride.multiplier !== 1) {
+        var multiplier = (lastOverride.multiplier * 100).toFixed(0);
+        label += ' | O: ' + multiplier + '%';
+      }
+    }
+
+    var endOverrideValue = lastOverride && lastOverride.endMoment ?
+      '⇥ ' + lastOverride.endMoment.format('LT') : (lastOverride ? '∞' : '');
+
+    sbx.pluginBase.updatePillText(override, {
+      value: endOverrideValue
+      , label: label
+      , info: info
+      , hide: !isActive
+    });
+
+  };
+
+  return override;
+
+}
+
+
+module.exports = init;

static/css/main.css

@@ -119,12 +119,13 @@ a, a:visited, a:link {
   font-family: 'Ubuntu', Verdana, Helvetica, Arial, sans-serif;
   vertical-align: middle;
   clear: both;
+  white-space: nowrap;
 }
 
 .bgStatus {
   float: right;
   text-align: center;
-  white-space: nowrap;
+  white-space: normal;
   padding-right: 20px;
 }
 
@@ -240,14 +241,16 @@ a, a:visited, a:link {
 .status {
   color: #808080;
   font-size: 100px;
+  white-space: normal;
 }
 .statusBox {
   text-align: center;
-  width: 250px;
+  width: 40%;
 }
 .statusPills {
   font-size: 20px;
   line-height: 23px;
+  margin-left: 5px;
 }
 
 .loading .statusPills {
@@ -397,7 +400,7 @@ a, a:visited, a:link {
   margin: 4px;
   padding: 0;
   color: #808080;
-  width: 250px;
+  width: 40%;
   text-align: center;
 }
 
@@ -474,6 +477,7 @@ a, a:visited, a:link {
 
   .focus-range {
     margin: 0;
+    width: 50%;
   }
 
   .focus-range li {
@@ -491,7 +495,7 @@ a, a:visited, a:link {
 
 @media (max-width: 750px) {
   .bgStatus {
-    width: 240px;
+    width: 50%;
     padding: 0 0 20px 0;
   }
 
@@ -503,6 +507,10 @@ a, a:visited, a:link {
     font-size: 12px;
   }
 
+  .statusBox {
+    width: auto;
+  }
+
   .bgStatus .currentBG {
     font-size: 70px;
     line-height: 60px;
@@ -741,10 +749,6 @@ a, a:visited, a:link {
     display: block;
   }
 
-  .statusBox {
-    width: 220px;
-  }
-
   .statusPills {
     display: inline;
     margin-left: auto;