refactor battery status to an optional characteristic

ccutrer · ccutrer · commit 1544779aa4ac · 2019-02-14T09:45:03.000-07:00
rather than have everyone implement an interface directly for every
concrete accessory

also refactor in an AbstractSensor[Service] base class/interface
so taht all the different sensors don't have to repeat their
optional characteristics
diff --git a/src/main/java/com/beowulfe/hap/accessories/AbstractSensor.java b/src/main/java/com/beowulfe/hap/accessories/AbstractSensor.java
@@ -0,0 +1,18 @@
+package com.beowulfe.hap.accessories;
+
+import com.beowulfe.hap.HomekitAccessory;
+import com.beowulfe.hap.accessories.characteristics.LowBatteryStatus;
+import java.util.Optional;
+
+/**
+ * A several characteristics that are shared among all Sensor type accesories
+ *
+ * @author Cody Cutrer initial contribution
+ */
+public interface AbstractSensor extends HomekitAccessory {
+  /** returns the optional implementation of LowBatteryStatus */
+  default Optional<LowBatteryStatus> getLowBatteryStatusCharacteristic() {
+    Optional<LowBatteryStatus> result = Optional.empty();
+    return result;
+  }
+}
diff --git a/src/main/java/com/beowulfe/hap/accessories/BatteryAccessory.java b/src/main/java/com/beowulfe/hap/accessories/BatteryAccessory.java
@@ -4,7 +4,8 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * Do not use. Devices that have battery levels should implement LowBatteryStatusAccessory.
+ * Do not use. Devices that have battery levels should implement Characteristic.LowBatteryStatus
+ * instead.
  *
  * @author Gaston Dombiak
  */
diff --git a/src/main/java/com/beowulfe/hap/accessories/CarbonMonoxideSensor.java b/src/main/java/com/beowulfe/hap/accessories/CarbonMonoxideSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.accessories.properties.CarbonMonoxideDetectedState;
@@ -13,11 +12,11 @@
  * A carbon monoxide sensor reports whether carbon monoxide has been detected or not.
  *
  * <p>Carbon monoxide sensors that run on batteries will need to implement this interface and also
- * implement {@link BatteryStatusAccessory}.
+ * implement LowBatteryStatus.
  *
  * @author Gaston Dombiak
  */
-public interface CarbonMonoxideSensor extends HomekitAccessory {
+public interface CarbonMonoxideSensor extends AbstractSensor {
 
   /**
    * Retrieves the state of the sensor that indicates if carbon monoxide has been detected.
diff --git a/src/main/java/com/beowulfe/hap/accessories/ContactSensor.java b/src/main/java/com/beowulfe/hap/accessories/ContactSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.accessories.properties.ContactState;
@@ -14,11 +13,11 @@
  * window/door sensors. When contact is detected it means that the door/window is closed.
  *
  * <p>Contact sensors that run on batteries will need to implement this interface and also implement
- * {@link BatteryStatusAccessory}.
+ * LowBatteryStatus.
  *
  * @author Gaston Dombiak
  */
-public interface ContactSensor extends HomekitAccessory {
+public interface ContactSensor extends AbstractSensor {
 
   /**
    * Retrieves the state of the contact. This is whether the contact is detected or not. Detected
diff --git a/src/main/java/com/beowulfe/hap/accessories/HumiditySensor.java b/src/main/java/com/beowulfe/hap/accessories/HumiditySensor.java
@@ -11,7 +11,7 @@
  *
  * @author Andy Lintner
  */
-public interface HumiditySensor extends HomekitAccessory {
+public interface HumiditySensor extends AbstractSensor {
 
   /**
    * Retrieves the current relative humidity.
diff --git a/src/main/java/com/beowulfe/hap/accessories/LeakSensor.java b/src/main/java/com/beowulfe/hap/accessories/LeakSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.impl.services.LeakSensorService;
@@ -12,11 +11,11 @@
  * A leak sensor that reports whether a leak has been detected.
  *
  * <p>Leak sensors that run on batteries will need to implement this interface and also implement
- * {@link BatteryStatusAccessory}.
+ * LowBatteryStatus.
  *
  * @author Tim Harper
  */
-public interface LeakSensor extends HomekitAccessory {
+public interface LeakSensor extends AbstractSensor {
 
   /**
    * Retrieves the state of the leak sensor. If true then leak has been detected.
diff --git a/src/main/java/com/beowulfe/hap/accessories/LightSensor.java b/src/main/java/com/beowulfe/hap/accessories/LightSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.impl.services.LightSensorService;
@@ -13,7 +12,7 @@
  *
  * @author Gaston Dombiak
  */
-public interface LightSensor extends HomekitAccessory {
+public interface LightSensor extends AbstractSensor {
 
   /**
    * Retrieves the current ambient light level.
diff --git a/src/main/java/com/beowulfe/hap/accessories/LockMechanism.java b/src/main/java/com/beowulfe/hap/accessories/LockMechanism.java
@@ -13,9 +13,6 @@
  * A lock capable of exposing its binary locked state. For a lock that can be locked/unlocked, use
  * {@link LockableLockMechanism}.
  *
- * <p>Locks that run on batteries will need to implement this interface and also implement {@link
- * BatteryStatusAccessory}.
- *
  * @author Andy Lintner
  */
 public interface LockMechanism extends HomekitAccessory {
diff --git a/src/main/java/com/beowulfe/hap/accessories/MotionSensor.java b/src/main/java/com/beowulfe/hap/accessories/MotionSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.impl.services.MotionSensorService;
@@ -11,12 +10,9 @@
 /**
  * A motion sensor that reports whether motion has been detected.
  *
- * <p>Motion sensors that run on batteries will need to implement this interface and also implement
- * {@link BatteryStatusAccessory}.
- *
  * @author Gaston Dombiak
  */
-public interface MotionSensor extends HomekitAccessory {
+public interface MotionSensor extends AbstractSensor {
 
   /**
    * Retrieves the state of the motion sensor. If true then motion has been detected.
diff --git a/src/main/java/com/beowulfe/hap/accessories/OccupancySensor.java b/src/main/java/com/beowulfe/hap/accessories/OccupancySensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.impl.services.OccupancySensorService;
@@ -11,12 +10,9 @@
 /**
  * An occupancy sensor that reports whether occupancy has been detected.
  *
- * <p>Occupancy sensors that run on batteries will need to implement this interface and also
- * implement {@link BatteryStatusAccessory}.
- *
  * @author Tim Harper
  */
-public interface OccupancySensor extends HomekitAccessory {
+public interface OccupancySensor extends AbstractSensor {
   /**
    * Retrieves the state of the occupancy sensor. If true then occupancy has been detected.
    *
diff --git a/src/main/java/com/beowulfe/hap/accessories/SmokeSensor.java b/src/main/java/com/beowulfe/hap/accessories/SmokeSensor.java
@@ -1,6 +1,5 @@
 package com.beowulfe.hap.accessories;
 
-import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.accessories.properties.SmokeDetectedState;
@@ -12,12 +11,9 @@
 /**
  * A smoke sensor reports whether smoke has been detected or not.
  *
- * <p>Smoke sensors that run on batteries will need to implement this interface and also implement
- * {@link BatteryStatusAccessory}.
- *
  * @author Gaston Dombiak
  */
-public interface SmokeSensor extends HomekitAccessory {
+public interface SmokeSensor extends AbstractSensor {
 
   /**
    * Retrieves the state of the smoke sensor. This is whether smoke has been detected or not.
diff --git a/src/main/java/com/beowulfe/hap/accessories/TemperatureSensor.java b/src/main/java/com/beowulfe/hap/accessories/TemperatureSensor.java
@@ -12,7 +12,7 @@
  *
  * @author Andy Lintner
  */
-public interface TemperatureSensor extends HomekitAccessory {
+public interface TemperatureSensor extends AbstractSensor {
 
   /**
    * Retrieves the current temperature, in celsius degrees.
diff --git a/src/main/java/com/beowulfe/hap/accessories/characteristics/LowBatteryStatus.java b/src/main/java/com/beowulfe/hap/accessories/characteristics/LowBatteryStatus.java
@@ -1,16 +1,9 @@
-package com.beowulfe.hap.accessories;
+package com.beowulfe.hap.accessories.characteristics;
 
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * An accessory that runs on batteries. Accessories that run on batteries are able to report battery
- * level.
- *
- * @author Tim Harper
- */
-public interface BatteryStatusAccessory {
-
+public interface LowBatteryStatus {
   /**
    * Queries if the device battery level is low; returning a value of true will cause a low-battery
    * status to appear in Home for the device.
diff --git a/src/main/java/com/beowulfe/hap/impl/services/AbstractSensorServiceImpl.java b/src/main/java/com/beowulfe/hap/impl/services/AbstractSensorServiceImpl.java
@@ -0,0 +1,20 @@
+package com.beowulfe.hap.impl.services;
+
+import com.beowulfe.hap.accessories.AbstractSensor;
+import com.beowulfe.hap.impl.characteristics.common.LowBatteryStatusCharacteristic;
+
+public class AbstractSensorServiceImpl extends AbstractServiceImpl {
+  public AbstractSensorServiceImpl(String type, AbstractSensor sensor, String serviceName) {
+    super(type, sensor, serviceName);
+
+    sensor
+        .getLowBatteryStatusCharacteristic()
+        .ifPresent(
+            status ->
+                addCharacteristic(
+                    new LowBatteryStatusCharacteristic(
+                        status::getLowBatteryState,
+                        status::subscribeLowBatteryState,
+                        status::unsubscribeLowBatteryState)));
+  }
+}
diff --git a/src/main/java/com/beowulfe/hap/impl/services/AbstractServiceImpl.java b/src/main/java/com/beowulfe/hap/impl/services/AbstractServiceImpl.java
@@ -3,10 +3,7 @@
 import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.Service;
 import com.beowulfe.hap.accessories.BatteryAccessory;
-import com.beowulfe.hap.accessories.BatteryStatusAccessory;
 import com.beowulfe.hap.characteristics.Characteristic;
-import com.beowulfe.hap.impl.characteristics.common.BatteryLevelCharacteristic;
-import com.beowulfe.hap.impl.characteristics.common.LowBatteryStatusCharacteristic;
 import com.beowulfe.hap.impl.characteristics.common.Name;
 import java.util.Collections;
 import java.util.LinkedList;
@@ -60,16 +57,6 @@ public AbstractServiceImpl(String type, HomekitAccessory accessory, String servi
                 + "Battery-powered devices should report their battery status using LowBatteryStatusAccessory",
             accessory.getClass());
       }
-
-      // If battery operated accessory then add LowBatteryStatusAccessory
-      if (accessory instanceof BatteryStatusAccessory) {
-        BatteryStatusAccessory batteryStatusAccessory = (BatteryStatusAccessory) accessory;
-        addCharacteristic(
-            new LowBatteryStatusCharacteristic(
-                batteryStatusAccessory::getLowBatteryState,
-                batteryStatusAccessory::subscribeLowBatteryState,
-                batteryStatusAccessory::unsubscribeLowBatteryState));
-      }
     }
   }
 
diff --git a/src/main/java/com/beowulfe/hap/impl/services/CarbonMonoxideSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/CarbonMonoxideSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.CarbonMonoxideSensor;
 import com.beowulfe.hap.impl.characteristics.carbonmonoxide.CarbonMonoxideDetectedCharacteristic;
 
-public class CarbonMonoxideSensorService extends AbstractServiceImpl {
+public class CarbonMonoxideSensorService extends AbstractSensorServiceImpl {
 
   public CarbonMonoxideSensorService(CarbonMonoxideSensor carbonMonoxideSensor) {
     this(carbonMonoxideSensor, carbonMonoxideSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/ContactSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/ContactSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.ContactSensor;
 import com.beowulfe.hap.impl.characteristics.contactsensor.ContactSensorStateCharacteristic;
 
-public class ContactSensorService extends AbstractServiceImpl {
+public class ContactSensorService extends AbstractSensorServiceImpl {
 
   public ContactSensorService(ContactSensor contactSensor) {
     this(contactSensor, contactSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/HumiditySensorService.java b/src/main/java/com/beowulfe/hap/impl/services/HumiditySensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.HumiditySensor;
 import com.beowulfe.hap.impl.characteristics.humiditysensor.CurrentRelativeHumidityCharacteristic;
 
-public class HumiditySensorService extends AbstractServiceImpl {
+public class HumiditySensorService extends AbstractSensorServiceImpl {
 
   public HumiditySensorService(HumiditySensor sensor) {
     this(sensor, sensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/LeakSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/LeakSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.LeakSensor;
 import com.beowulfe.hap.impl.characteristics.leaksensor.LeakDetectedStateCharacteristic;
 
-public class LeakSensorService extends AbstractServiceImpl {
+public class LeakSensorService extends AbstractSensorServiceImpl {
 
   public LeakSensorService(LeakSensor leakSensor) {
     this(leakSensor, leakSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/LightSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/LightSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.LightSensor;
 import com.beowulfe.hap.impl.characteristics.light.AmbientLightLevelCharacteristic;
 
-public class LightSensorService extends AbstractServiceImpl {
+public class LightSensorService extends AbstractSensorServiceImpl {
 
   public LightSensorService(LightSensor lightSensor) {
     this(lightSensor, lightSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/MotionSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/MotionSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.MotionSensor;
 import com.beowulfe.hap.impl.characteristics.motionsensor.MotionDetectedStateCharacteristic;
 
-public class MotionSensorService extends AbstractServiceImpl {
+public class MotionSensorService extends AbstractSensorServiceImpl {
 
   public MotionSensorService(MotionSensor motionSensor) {
     this(motionSensor, motionSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/OccupancySensorService.java b/src/main/java/com/beowulfe/hap/impl/services/OccupancySensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.OccupancySensor;
 import com.beowulfe.hap.impl.characteristics.occupancysensor.OccupancyDetectedStateCharacteristic;
 
-public class OccupancySensorService extends AbstractServiceImpl {
+public class OccupancySensorService extends AbstractSensorServiceImpl {
 
   public OccupancySensorService(OccupancySensor occupancySensor) {
     this(occupancySensor, occupancySensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/SmokeSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/SmokeSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.SmokeSensor;
 import com.beowulfe.hap.impl.characteristics.smokesensor.SmokeDetectedCharacteristic;
 
-public class SmokeSensorService extends AbstractServiceImpl {
+public class SmokeSensorService extends AbstractSensorServiceImpl {
 
   public SmokeSensorService(SmokeSensor smokeSensor) {
     this(smokeSensor, smokeSensor.getLabel());
diff --git a/src/main/java/com/beowulfe/hap/impl/services/TemperatureSensorService.java b/src/main/java/com/beowulfe/hap/impl/services/TemperatureSensorService.java
@@ -3,7 +3,7 @@
 import com.beowulfe.hap.accessories.TemperatureSensor;
 import com.beowulfe.hap.impl.characteristics.thermostat.CurrentTemperatureCharacteristic;
 
-public class TemperatureSensorService extends AbstractServiceImpl {
+public class TemperatureSensorService extends AbstractSensorServiceImpl {
 
   public TemperatureSensorService(TemperatureSensor sensor) {
     this(sensor, sensor.getLabel());

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@`
`4`	`4`	`import java.util.concurrent.CompletableFuture;`
`5`	`5`
`6`	`6`	`/**`
`7`		`- * Do not use. Devices that have battery levels should implement LowBatteryStatusAccessory.`
	`7`	`+ * Do not use. Devices that have battery levels should implement Characteristic.LowBatteryStatus`
	`8`	`+ * instead.`
`8`	`9`	`*`
`9`	`10`	`* @author Gaston Dombiak`
`10`	`11`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`*`
`12`	`12`	`* @author Andy Lintner`
`13`	`13`	`*/`
`14`		`-public interface HumiditySensor extends HomekitAccessory {`
	`14`	`+public interface HumiditySensor extends AbstractSensor {`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Retrieves the current relative humidity.`