homebridge-securitysystem 7.0.0 → 7.1.0-beta.1

package/config.schema.json

@@ -68,6 +68,42 @@
         "default": false,
         "required": false
       },
+      "security_system_name": {
+        "title": "Security System Name",
+        "type": "string",
+        "default": "Security System",
+        "required": false
+      },
+      "trip_switch_name": {
+        "title": "Trip Switch Name",
+        "type": "string",
+        "default": "Trip",
+        "required": false
+      },
+      "trip_home_switch_name": {
+        "title": "Trip Home Switch Name",
+        "type": "string",
+        "default": "Trip Home",
+        "required": false
+      },
+      "trip_away_switch_name": {
+        "title": "Trip Away Switch Name",
+        "type": "string",
+        "default": "Trip Away",
+        "required": false
+      },
+      "trip_night_switch_name": {
+        "title": "Trip Night Switch Name",
+        "type": "string",
+        "default": "Trip Night",
+        "required": false
+      },
+      "trip_override_switch_name": {
+        "title": "Trip Override Switch Name",
+        "type": "string",
+        "default": "Trip Override",
+        "required": false
+      },
       "log_directory": {
         "title": "Log Directory Path",
         "type": "string",
@@ -516,6 +552,21 @@
     },
     "save_state",
     "test_mode",
+    {
+      "type": "fieldset",
+      "title": "Accessory Names",
+      "description": "Change the accessory names provided by your own.",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        "security_system_name",
+        "trip_switch_name",
+        "trip_home_switch_name",
+        "trip_away_switch_name",
+        "trip_night_switch_name",
+        "trip_override_switch_name"
+      ]
+    },
     {
       "type": "fieldset",
       "title": "Advanced Options",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "homebridge-securitysystem",
   "displayName": "Homebridge Security System",
-  "version": "7.0.0",
+  "version": "7.1.0-beta.1",
   "description": "Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.",
   "main": "src/index.js",
   "scripts": {
-    "debug": "npm install -g && homebridge -I -D",
+    "debug": "homebridge -I -D",
     "test": "exit 0",
     "build": "exit 0"
   },

package/src/index.js

@@ -135,14 +135,20 @@ function SecuritySystem(log, config) {
   }
 
   // Security system
-  this.service = new Service.SecuritySystem(options.name);
+  this.service = new Service.SecuritySystem(options.securitySystemName);
   this.availableTargetStates = this.getAvailableTargetStates();
 
   this.service.getCharacteristic(
     Characteristic.SecuritySystemTargetState
   ).value = this.targetState;
 
+  this.service.addCharacteristic(Characteristic.ConfiguredName);
+
   this.service
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.securitySystemName
+    )
     .getCharacteristic(Characteristic.SecuritySystemTargetState)
     .setProps({ validValues: this.availableTargetStates })
     .on("get", this.getTargetState.bind(this))
@@ -157,57 +163,85 @@ function SecuritySystem(log, config) {
     .on("get", this.getCurrentState.bind(this));
 
   // Trip switches
-  this.tripSwitchService = new Service.Switch("Trip", "siren-switch");
+  this.tripSwitchService = new Service.Switch(
+    options.tripSwitchName,
+    "siren-switch"
+  );
+
   this.tripSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.tripSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Trip")
+    .setCharacteristic(Characteristic.ConfiguredName, options.tripSwitchName)
     .getCharacteristic(Characteristic.On)
     .on("get", this.getTripSwitch.bind(this))
     .on("set", this.setTripSwitch.bind(this));
 
-  this.tripOverrideSwitchService = new Service.Switch(
-    "Trip Override",
-    "BdW9ce0mUYatqiRqEjT4iA"
+  this.tripHomeSwitchService = new Service.Switch(
+    options.tripHomeSwitchName,
+    "siren-home"
   );
 
-  this.tripOverrideSwitchService.addCharacteristic(
-    Characteristic.ConfiguredName
-  );
-
-  this.tripOverrideSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Trip Override")
-    .getCharacteristic(Characteristic.On)
-    .on("get", this.getTripOverrideSwitch.bind(this))
-    .on("set", this.setTripOverrideSwitch.bind(this));
-
-  this.tripHomeSwitchService = new Service.Switch("Trip Home", "siren-home");
   this.tripHomeSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.tripHomeSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Trip Home")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.tripHomeSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getTripHomeSwitch.bind(this))
     .on("set", this.setTripHomeSwitch.bind(this));
 
-  this.tripAwaySwitchService = new Service.Switch("Trip Away", "siren-away");
+  this.tripAwaySwitchService = new Service.Switch(
+    options.tripAwaySwitchName,
+    "siren-away"
+  );
+
   this.tripAwaySwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.tripAwaySwitchService
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.tripAwaySwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getTripAwaySwitch.bind(this))
     .on("set", this.setTripAwaySwitch.bind(this));
 
-  this.tripNightSwitchService = new Service.Switch("Trip Night", "siren-night");
+  this.tripNightSwitchService = new Service.Switch(
+    options.tripNightSwitchName,
+    "siren-night"
+  );
 
   this.tripNightSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.tripNightSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Trip Night")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.tripNightSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getTripNightSwitch.bind(this))
     .on("set", this.setTripNightSwitch.bind(this));
 
+  this.tripOverrideSwitchService = new Service.Switch(
+    options.tripOverrideSwitchName,
+    "BdW9ce0mUYatqiRqEjT4iA"
+  );
+
+  this.tripOverrideSwitchService.addCharacteristic(
+    Characteristic.ConfiguredName
+  );
+
+  this.tripOverrideSwitchService
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.tripOverrideSwitchName
+    )
+    .getCharacteristic(Characteristic.On)
+    .on("get", this.getTripOverrideSwitch.bind(this))
+    .on("set", this.setTripOverrideSwitch.bind(this));
+
   // Arming lock switches
   this.armingLockSwitchService = new Service.Switch(
     "Arming Lock",
@@ -1131,7 +1165,7 @@ SecuritySystem.prototype.updateTripSwitch = function (
   if (value) {
     // Already triggered
     if (isCurrentStateAlarmTriggered) {
-      this.log.warn("Trip Switch (Already triggered)");
+      this.log.warn("Security System (Already triggered)");
 
       if (callback !== null) {
         callback(HK_NOT_ALLOWED_IN_CURRENT_STATE, false);
@@ -1142,7 +1176,7 @@ SecuritySystem.prototype.updateTripSwitch = function (
 
     // Already about to trigger
     if (this.triggerTimeout !== null) {
-      this.log.warn("Trip Switch (Already on)");
+      this.log.warn("Security System (Already tripped)");
 
       if (callback !== null) {
         callback(HK_NOT_ALLOWED_IN_CURRENT_STATE, false);
@@ -1151,7 +1185,7 @@ SecuritySystem.prototype.updateTripSwitch = function (
       return false;
     }
 
-    this.log.info("Trip Switch (On)");
+    this.log.info("Security System (Tripped)");
 
     // Update tripped motion sensor
     if (options.trippedMotionSensor) {
@@ -1220,7 +1254,7 @@ SecuritySystem.prototype.updateTripSwitch = function (
     this.sendWebhookEvent("current", "warning", origin);
   } else {
     // Off
-    this.log.info("Trip Switch (Off)");
+    this.log.info("Security System (Cancelled)");
     this.stopAudio();
 
     if (isCurrentStateAlarmTriggered) {
@@ -1254,10 +1288,6 @@ SecuritySystem.prototype.updateTripSwitch = function (
   return true;
 };
 
-SecuritySystem.prototype.setTrip = function (value, callback) {
-  this.updateTripSwitch(value, originTypes.REGULAR_SWITCH, false, callback);
-};
-
 // Server
 SecuritySystem.prototype.isAuthenticated = function (req, res) {
   // Check if authentication is disabled
@@ -1804,52 +1834,68 @@ SecuritySystem.prototype.getTripSwitch = function (callback) {
 };
 
 SecuritySystem.prototype.setTripSwitch = function (value, callback) {
+  this.log.info(`Trip Switch (${value ? "On" : "Off"})`);
   this.updateTripSwitch(value, originTypes.REGULAR_SWITCH, false, callback);
 };
 
-SecuritySystem.prototype.getTripOverrideSwitch = function (callback) {
-  const value = this.tripOverrideSwitchService.getCharacteristic(
+SecuritySystem.prototype.getTripHomeSwitch = function (callback) {
+  const value = this.tripHomeSwitchService.getCharacteristic(
     Characteristic.On
   ).value;
   callback(null, value);
 };
 
-SecuritySystem.prototype.setTripOverrideSwitch = function (value, callback) {
-  this.updateTripSwitch(value, originTypes.SPECIAL_SWITCH, false, callback);
+SecuritySystem.prototype.setTripHomeSwitch = function (value, callback) {
+  this.log.info(`Trip Home Switch (${value ? "On" : "Off"})`);
+  this.triggerIfModeSet(
+    Characteristic.SecuritySystemCurrentState.STAY_ARM,
+    value,
+    callback
+  );
 };
 
-SecuritySystem.prototype.resetTripSwitches = function () {
-  const tripHomeOnCharacteristic = this.tripHomeSwitchService.getCharacteristic(
-    Characteristic.On
-  );
-  const tripAwayOnCharacteristic = this.tripAwaySwitchService.getCharacteristic(
+SecuritySystem.prototype.getTripAwaySwitch = function (callback) {
+  const value = this.tripAwaySwitchService.getCharacteristic(
     Characteristic.On
-  );
-  const tripNightOnCharacteristic =
-    this.tripNightSwitchService.getCharacteristic(Characteristic.On);
+  ).value;
+  callback(null, value);
+};
 
-  const tripOverrideOnCharacteristic =
-    this.tripOverrideSwitchService.getCharacteristic(Characteristic.On);
+SecuritySystem.prototype.setTripAwaySwitch = function (value, callback) {
+  this.log.info(`Trip Away Switch (${value ? "On" : "Off"})`);
+  this.triggerIfModeSet(
+    Characteristic.SecuritySystemCurrentState.AWAY_ARM,
+    value,
+    callback
+  );
+};
 
-  if (tripHomeOnCharacteristic.value) {
-    tripHomeOnCharacteristic.updateValue(false);
-    this.log.debug("Trip Home Switch (Off)");
-  }
+SecuritySystem.prototype.getTripNightSwitch = function (callback) {
+  const value = this.tripNightSwitchService.getCharacteristic(
+    Characteristic.On
+  ).value;
+  callback(null, value);
+};
 
-  if (tripAwayOnCharacteristic.value) {
-    tripAwayOnCharacteristic.updateValue(false);
-    this.log.debug("Trip Away Switch (Off)");
-  }
+SecuritySystem.prototype.setTripNightSwitch = function (value, callback) {
+  this.log.info(`Trip Night Switch (${value ? "On" : "Off"})`);
+  this.triggerIfModeSet(
+    Characteristic.SecuritySystemCurrentState.NIGHT_ARM,
+    value,
+    callback
+  );
+};
 
-  if (tripNightOnCharacteristic.value) {
-    tripNightOnCharacteristic.updateValue(false);
-    this.log.debug("Trip Night Switch (Off)");
-  }
+SecuritySystem.prototype.getTripOverrideSwitch = function (callback) {
+  const value = this.tripOverrideSwitchService.getCharacteristic(
+    Characteristic.On
+  ).value;
+  callback(null, value);
+};
 
-  if (tripOverrideOnCharacteristic.value) {
-    tripOverrideOnCharacteristic.updateValue(false);
-    this.log.debug("Trip Override Switch (Off)");
-  }
+SecuritySystem.prototype.setTripOverrideSwitch = function (value, callback) {
+  this.log.info(`Trip Override Switch (${value ? "On" : "Off"})`);
+  this.updateTripSwitch(value, originTypes.SPECIAL_SWITCH, false, callback);
 };
 
 SecuritySystem.prototype.triggerIfModeSet = function (
@@ -1868,7 +1914,7 @@ SecuritySystem.prototype.triggerIfModeSet = function (
     ) {
       this.updateTripSwitch(value, originTypes.REGULAR_SWITCH, false, callback);
     } else {
-      this.log.debug("Trip (Mode not set)");
+      this.log.debug("Security System (Trip mode not set)");
       callback(HK_NOT_ALLOWED_IN_CURRENT_STATE, false);
     }
   } else {
@@ -1876,52 +1922,38 @@ SecuritySystem.prototype.triggerIfModeSet = function (
   }
 };
 
-SecuritySystem.prototype.getTripHomeSwitch = function (callback) {
-  const value = this.tripHomeSwitchService.getCharacteristic(
+SecuritySystem.prototype.resetTripSwitches = function () {
+  const tripHomeOnCharacteristic = this.tripHomeSwitchService.getCharacteristic(
     Characteristic.On
-  ).value;
-  callback(null, value);
-};
-
-SecuritySystem.prototype.setTripHomeSwitch = function (value, callback) {
-  this.log.debug("Trip Home Switch (On)");
-  this.triggerIfModeSet(
-    Characteristic.SecuritySystemCurrentState.STAY_ARM,
-    value,
-    callback
   );
-};
-
-SecuritySystem.prototype.getTripAwaySwitch = function (callback) {
-  const value = this.tripAwaySwitchService.getCharacteristic(
+  const tripAwayOnCharacteristic = this.tripAwaySwitchService.getCharacteristic(
     Characteristic.On
-  ).value;
-  callback(null, value);
-};
-
-SecuritySystem.prototype.setTripAwaySwitch = function (value, callback) {
-  this.log.debug("Trip Away Switch (On)");
-  this.triggerIfModeSet(
-    Characteristic.SecuritySystemCurrentState.AWAY_ARM,
-    value,
-    callback
   );
-};
+  const tripNightOnCharacteristic =
+    this.tripNightSwitchService.getCharacteristic(Characteristic.On);
 
-SecuritySystem.prototype.getTripNightSwitch = function (callback) {
-  const value = this.tripNightSwitchService.getCharacteristic(
-    Characteristic.On
-  ).value;
-  callback(null, value);
-};
+  const tripOverrideOnCharacteristic =
+    this.tripOverrideSwitchService.getCharacteristic(Characteristic.On);
 
-SecuritySystem.prototype.setTripNightSwitch = function (value, callback) {
-  this.log.debug("Trip Night Switch (On)");
-  this.triggerIfModeSet(
-    Characteristic.SecuritySystemCurrentState.NIGHT_ARM,
-    value,
-    callback
-  );
+  if (tripHomeOnCharacteristic.value) {
+    tripHomeOnCharacteristic.updateValue(false);
+    this.log.debug("Trip Home Switch (Off)");
+  }
+
+  if (tripAwayOnCharacteristic.value) {
+    tripAwayOnCharacteristic.updateValue(false);
+    this.log.debug("Trip Away Switch (Off)");
+  }
+
+  if (tripNightOnCharacteristic.value) {
+    tripNightOnCharacteristic.updateValue(false);
+    this.log.debug("Trip Night Switch (Off)");
+  }
+
+  if (tripOverrideOnCharacteristic.value) {
+    tripOverrideOnCharacteristic.updateValue(false);
+    this.log.debug("Trip Override Switch (Off)");
+  }
 };
 
 // Arming lock switches

package/src/utils/options.js

@@ -12,8 +12,16 @@ const options = {
     options.saveState = config.save_state;
     options.proxyMode = config.proxy_mode;
     options.testMode = config.test_mode;
-    options.logDirectory = config.log_directory;
 
+    // Names
+    options.securitySystemName = config.security_system_name;
+    options.tripSwitchName = config.trip_switch_name;
+    options.tripHomeSwitchName = config.trip_home_switch_name;
+    options.tripAwaySwitchName = config.trip_away_switch_name;
+    options.tripNightSwitchName = config.trip_night_switch_name;
+    options.tripOverrideSwitchName = config.trip_override_switch_name;
+
+    options.logDirectory = config.log_directory;
     options.overrideOff = config.override_off;
     options.resetOffFlow = config.reset_off_flow;
     options.disabledModes = config.disabled_modes;
@@ -161,6 +169,30 @@ const options = {
       options.resetMinutes = 10;
     }
 
+    if (options.isValueSet(options.securitySystemName) === false) {
+      options.securitySystemName = "Security System";
+    }
+
+    if (options.isValueSet(options.tripSwitchName) === false) {
+      options.tripSwitchName = "Trip";
+    }
+
+    if (options.isValueSet(options.tripHomeSwitchName) === false) {
+      options.tripHomeSwitchName = "Trip Home";
+    }
+
+    if (options.isValueSet(options.tripAwaySwitchName) === false) {
+      options.tripAwaySwitchName = "Trip Away";
+    }
+
+    if (options.isValueSet(options.tripNightSwitchName) === false) {
+      options.tripNightSwitchName = "Trip Night";
+    }
+
+    if (options.isValueSet(options.tripOverrideSwitchName) === false) {
+      options.tripOverrideSwitchName = "Trip Override";
+    }
+
     if (options.isValueSet(options.overrideOff) === false) {
       options.overrideOff = false;
     }