feat: disable pump battery alarms at night option (nightscout#5359)

* feat: add feature to disable pump battery alarms at night * add timezone handling for server side * Update pump.test.js * Update pump.test.js * Update pump.test.js Co-authored-by: Jeremy Cunningham <[email protected]> Co-authored-by: Sulka Haro <[email protected]>
n0rbertg · n0rbertg · Apr 12, 2021 · Jan 7, 2021 · Jan 7, 2021 · Jan 7, 2021
commit 3ee90d69277f58dc501eccb1a5ff013455969013
diff --git a/README.md b/README.md
@@ -294,6 +294,8 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or
 ### Predefined values for your browser settings (optional)
 
   * `TIME_FORMAT` (`12`)- possible values `12` or `24`
+  * `DAY_START` (`7.0`) - time for start of day (0.0 - 24.0) for features using day time / night time options
+  * `DAY_END` (`21.0`) - time for end of day (0.0 - 24.0) for features using day time / night time options
   * `NIGHT_MODE` (`off`) - possible values `on` or `off`
   * `SHOW_RAWBG` (`never`) - possible values `always`, `never` or `noise`
   * `CUSTOM_TITLE` (`Nightscout`) - Title for the main view
@@ -511,6 +513,7 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or
   * `PUMP_URGENT_BATT_P` (`20`) - The % of the pump battery remaining, an urgent alarm will be triggered when dropping below this threshold.
   * `PUMP_WARN_BATT_V` (`1.35`) - The voltage (if percent isn't available) of the pump battery, a warning will be triggered when dropping below this threshold.
   * `PUMP_URGENT_BATT_V` (`1.30`) - The  voltage (if percent isn't available) of the pump battery, an urgent alarm will be triggered when dropping below this threshold.
+  * `PUMP_WARN_BATT_QUIET_NIGHT` (`false`) - Do not generate battery alarms at night.
 
 ##### `openaps` (OpenAPS)
   Integrated OpenAPS loop monitoring, uses these extended settings:

diff --git a/lib/plugins/pump.js b/lib/plugins/pump.js
@@ -34,6 +34,14 @@ function init (ctx) {
     var retroFields = cleanList(sbx.extendedSettings.retroFields);
     retroFields = isEmpty(retroFields) ? ['reservoir', 'battery'] : retroFields;
 
+    var profile = sbx.data.profile;
+    var warnBattQuietNight = sbx.extendedSettings.warnBattQuietNight;
+
+    if (warnBattQuietNight && (!profile || !profile.hasData() || !profile.getTimezone())) {
+      console.warn('PUMP_WARN_BATT_QUIET_NIGHT requires a treatment profile with time zone set to obtain user time zone');
+      warnBattQuietNight = false;
+    }
+
     return {
       fields: fields
       , retroFields: retroFields
@@ -47,6 +55,9 @@ function init (ctx) {
       , urgentBattP: sbx.extendedSettings.urgentBattP || 20
       , warnOnSuspend: sbx.extendedSettings.warnOnSuspend || false
       , enableAlerts: sbx.extendedSettings.enableAlerts || false
+      , warnBattQuietNight: warnBattQuietNight || false
+      , dayStart: sbx.settings.dayStart
+      , dayEnd: sbx.settings.dayEnd
     };
   };
 
@@ -246,17 +257,17 @@ function init (ctx) {
     }
   }
 
-  function updateBattery (type, prefs, result) {
+  function updateBattery (type, prefs, result, batteryWarn) {
     if (result.battery) {
       result.battery.label = 'Battery';
       result.battery.display = result.battery.value + type;
       var urgent = type === 'v' ? prefs.urgentBattV : prefs.urgentBattP;
       var warn = type === 'v' ? prefs.warnBattV : prefs.warnBattP;
 
-      if (result.battery.value < urgent) {
+      if (result.battery.value < urgent && batteryWarn) {
         result.battery.level = levels.URGENT;
         result.battery.message = 'URGENT: Pump Battery Low';
-      } else if (result.battery.value < warn) {
+      } else if (result.battery.value < warn && batteryWarn) {
         result.battery.level = levels.WARN;
         result.battery.message = 'Warning, Pump Battery Low';
       } else {
@@ -300,7 +311,9 @@ function init (ctx) {
 
   function prepareData (prop, prefs, sbx) {
     var pump = (prop && prop.pump) || { };
-
+    var time = (sbx.data.profile && sbx.data.profile.getTimezone()) ? moment(sbx.time).tz(sbx.data.profile.getTimezone()) : moment(sbx.time);
+    var now = time.hours() + time.minutes() / 60.0 + time.seconds() / 3600.0;
+    var batteryWarn = !(prefs.warnBattQuietNight && (now < prefs.dayStart || now > prefs.dayEnd));
     var result = {
       level: levels.NONE
       , clock: pump.clock ? { value: moment(pump.clock) } : null
@@ -317,10 +330,10 @@ function init (ctx) {
 
     if (pump.battery && pump.battery.percent) {
       result.battery = { value: pump.battery.percent, unit: 'percent' };
-      updateBattery('%', prefs, result);
+      updateBattery('%', prefs, result, batteryWarn);
     } else if (pump.battery && pump.battery.voltage) {
       result.battery = { value: pump.battery.voltage, unit: 'volts'};
-      updateBattery('v', prefs, result);
+      updateBattery('v', prefs, result, batteryWarn);
     }
 
     result.device = { label: translate('Device'), display: prop.device };

diff --git a/lib/settings.js b/lib/settings.js
@@ -8,6 +8,8 @@ function init () {
   var settings = {
     units: 'mg/dl'
     , timeFormat: 12
+    , dayStart: 7.0
+    , dayEnd: 21.0
     , nightMode: false
     , editMode: true
     , showRawbg: 'never'

diff --git a/tests/pump.test.js b/tests/pump.test.js
@@ -13,6 +13,7 @@ var top_ctx = {
 top_ctx.language.set('en');
 var env = require('../env')();
 var levels = require('../lib/levels');
+var profile = require('../lib/profilefunctions')();
 top_ctx.levels = levels;
 var pump = require('../lib/plugins/pump')(top_ctx);
 var sandbox = require('../lib/sandbox')(top_ctx);
@@ -51,6 +52,10 @@ var statuses = [{
   }
 }];
 
+var profileData =
+{
+  'timezone': moment.tz.guess()
+};
 
 var statuses2 = [{
   created_at: '2015-12-05T17:35:00.000Z'
@@ -183,7 +188,7 @@ describe('pump', function ( ) {
     var sbx = sandbox.clientInit(ctx, now.valueOf(), {
       devicestatus: statuses
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);
 
@@ -211,7 +216,7 @@ describe('pump', function ( ) {
     var sbx = sandbox.clientInit(ctx, now.valueOf(), {
       devicestatus: lowResStatuses
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);
 
@@ -240,7 +245,7 @@ describe('pump', function ( ) {
     var sbx = sandbox.clientInit(ctx, now.valueOf(), {
       devicestatus: lowResStatuses
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);
 
@@ -270,7 +275,7 @@ describe('pump', function ( ) {
     var sbx = sandbox.clientInit(ctx, now.valueOf(), {
       devicestatus: lowBattStatuses
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);
 
@@ -299,7 +304,7 @@ describe('pump', function ( ) {
     var sbx = sandbox.clientInit(ctx, now.valueOf(), {
       devicestatus: lowBattStatuses
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);
 
@@ -310,6 +315,50 @@ describe('pump', function ( ) {
     done();
   });
 
+  it('not generate a battery alarm during night when PUMP_WARN_BATT_QUIET_NIGHT is true', function (done) {
+    var ctx = {
+      settings: {
+        units: 'mg/dl'
+        , dayStart: 24 // Set to 24 so it always evaluates true in test
+        , dayEnd: 21.0
+      }
+      , pluginBase: {
+        updatePillText: function mockedUpdatePillText(plugin, options) {
+          options.label.should.equal('Pump');
+          options.value.should.equal('86.4U');
+          done();
+        }
+      }
+      , notifications: require('../lib/notifications')(env, top_ctx)
+      , language: require('../lib/language')()
+      , levels: levels
+    };
+
+    ctx.notifications.initRequests();
+
+    var lowBattStatuses = _.cloneDeep(statuses);
+    lowBattStatuses[1].pump.battery.voltage = 1.00;
+
+    var sbx = sandbox.clientInit(ctx, now.valueOf(), {
+      devicestatus: lowBattStatuses
+      , profiles: [profileData]
+    });
+    profile.loadData(_.cloneDeep([profileData]));
+    sbx.data.profile = profile;
+
+    sbx.extendedSettings = {
+      enableAlerts: true
+      , warnBattQuietNight: true
+    };
+    pump.setProperties(sbx);
+    pump.checkNotifications(sbx);
+
+    var highest = ctx.notifications.findHighestAlarm('Pump');
+    should.not.exist(highest);
+
+    done();
+  });
+
   it('not generate an alert for a stale pump data, when there is an offline marker', function (done) {
     var ctx = {
       settings: {
@@ -326,7 +375,7 @@ describe('pump', function ( ) {
       devicestatus: statuses
       , treatments: [{eventType: 'OpenAPS Offline', mills: now.valueOf(), duration: 60}]
     });
-    sbx.extendedSettings = { 'enableAlerts': 'TRUE' };
+    sbx.extendedSettings = { 'enableAlerts': true };
     pump.setProperties(sbx);
     pump.checkNotifications(sbx);