Added support for battery levels. Contact sensors, motion sensors and locks can now report battery levels.

Author: gdombiak

src/main/java/com/beowulfe/hap/accessories/BatteryAccessory.java

@@ -0,0 +1,33 @@
+package com.beowulfe.hap.accessories;
+
+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 Gaston Dombiak
+ */
+public interface BatteryAccessory {
+
+    /**
+     * Retrieves the battery level of the accessory.
+     *
+     * @return a future that will contain the accessory's battery state
+     */
+    CompletableFuture<Integer> getBatteryLevelState();
+
+    /**
+     * Subscribes to changes in the battery level.
+     *
+     * @param callback the function to call when battery level changes.
+     */
+    void subscribeBatteryLevelState(HomekitCharacteristicChangeCallback callback);
+
+    /**
+     * Unsubscribes from changes in the battery level.
+     */
+    void unsubscribeBatteryLevelState();
+}

src/main/java/com/beowulfe/hap/accessories/ContactSensor.java

@@ -11,9 +11,14 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * A contact sensor that reports whether contact is detected or not. Typical
+ * <p>A contact sensor that reports whether contact is detected or not. Typical
  * contact sensors are window/door sensors. When contact is detected it means
- * that the door/window is closed.
+ * that the door/window is closed.</p>
+ *
+ * <p>Contact sensors that run on batteries will need to implement this interface
+ * and also implement {@link BatteryAccessory}.</p>
+ *
+ * @author Gaston Dombiak
  */
 public interface ContactSensor extends HomekitAccessory {
 

src/main/java/com/beowulfe/hap/accessories/LockMechanism.java

@@ -1,16 +1,21 @@
 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.LockMechanismState;
+import com.beowulfe.hap.impl.services.LockMechanismService;
+
 import java.util.Collection;
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-import com.beowulfe.hap.*;
-import com.beowulfe.hap.accessories.properties.LockMechanismState;
-import com.beowulfe.hap.impl.services.LockMechanismService;
-
 /**
- * A lock capable of exposing its binary locked state. For a lock that can be locked/unlocked, use
- * {@link LockableLockMechanism}
+ * <p>A lock capable of exposing its binary locked state. For a lock that can be locked/unlocked, use
+ * {@link LockableLockMechanism}.</p>
+ *
+ * <p>Locks that run on batteries will need to implement this interface and also
+ * implement {@link BatteryAccessory}.</p>
  *
  * @author Andy Lintner
  */

src/main/java/com/beowulfe/hap/accessories/MotionSensor.java

@@ -10,7 +10,12 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * A motion sensor that reports whether motion has been detected.
+ * <p>A motion sensor that reports whether motion has been detected.</p>
+ *
+ * <p>Motion sensors that run on batteries will need to implement this interface
+ * and also implement {@link BatteryAccessory}.</p>
+ *
+ * @author Gaston Dombiak
  */
 public interface MotionSensor extends HomekitAccessory {
 

src/main/java/com/beowulfe/hap/impl/characteristics/common/BatteryLevelCharacteristic.java

@@ -0,0 +1,44 @@
+package com.beowulfe.hap.impl.characteristics.common;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.characteristics.IntegerCharacteristic;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+public class BatteryLevelCharacteristic extends IntegerCharacteristic implements EventableCharacteristic {
+
+    private final Supplier<CompletableFuture<Integer>> getter;
+    private final Consumer<HomekitCharacteristicChangeCallback> subscriber;
+    private final Runnable unsubscriber;
+
+    public BatteryLevelCharacteristic(Supplier<CompletableFuture<Integer>> getter,
+                                      Consumer<HomekitCharacteristicChangeCallback> subscriber, Runnable unsubscriber) {
+        super("00000068-0000-1000-8000-0026BB765291", false, true, "Battery Level", 0, 100, "%");
+        this.getter = getter;
+        this.subscriber = subscriber;
+        this.unsubscriber = unsubscriber;
+    }
+
+    @Override
+    protected CompletableFuture<Integer> getValue() {
+        return getter.get();
+    }
+
+    @Override
+    protected void setValue(Integer value) throws Exception {
+        //Read Only
+    }
+
+    @Override
+    public void subscribe(HomekitCharacteristicChangeCallback callback) {
+        subscriber.accept(callback);
+    }
+
+    @Override
+    public void unsubscribe() {
+        unsubscriber.run();
+    }
+}

src/main/java/com/beowulfe/hap/impl/services/ContactSensorService.java

@@ -1,6 +1,8 @@
 package com.beowulfe.hap.impl.services;
 
+import com.beowulfe.hap.accessories.BatteryAccessory;
 import com.beowulfe.hap.accessories.ContactSensor;
+import com.beowulfe.hap.impl.characteristics.common.BatteryLevelCharacteristic;
 import com.beowulfe.hap.impl.characteristics.common.Name;
 import com.beowulfe.hap.impl.characteristics.contactsensor.ContactSensorStateCharacteristic;
 
@@ -10,5 +12,14 @@ public ContactSensorService(ContactSensor contactSensor) {
         super("00000080-0000-1000-8000-0026BB765291");
         addCharacteristic(new Name(contactSensor));
         addCharacteristic(new ContactSensorStateCharacteristic(contactSensor));
+
+        if (contactSensor instanceof BatteryAccessory) {
+            BatteryAccessory batteryAccessory = (BatteryAccessory) contactSensor;
+            addCharacteristic(new BatteryLevelCharacteristic(
+                    batteryAccessory::getBatteryLevelState,
+                    batteryAccessory::subscribeBatteryLevelState,
+                    batteryAccessory::unsubscribeBatteryLevelState
+            ));
+        }
     }
 }

src/main/java/com/beowulfe/hap/impl/services/LockMechanismService.java

@@ -1,7 +1,9 @@
 package com.beowulfe.hap.impl.services;
 
+import com.beowulfe.hap.accessories.BatteryAccessory;
 import com.beowulfe.hap.accessories.LockMechanism;
 import com.beowulfe.hap.accessories.LockableLockMechanism;
+import com.beowulfe.hap.impl.characteristics.common.BatteryLevelCharacteristic;
 import com.beowulfe.hap.impl.characteristics.common.Name;
 import com.beowulfe.hap.impl.characteristics.lock.mechanism.CurrentLockMechanismStateCharacteristic;
 import com.beowulfe.hap.impl.characteristics.lock.mechanism.TargetLockMechanismStateCharacteristic;
@@ -16,7 +18,14 @@ public LockMechanismService(LockMechanism lock) {
 		if (lock instanceof LockableLockMechanism) {
 			addCharacteristic(new TargetLockMechanismStateCharacteristic((LockableLockMechanism) lock));
 		}
-		
-	}
 
+		if (lock instanceof BatteryAccessory) {
+			BatteryAccessory batteryAccessory = (BatteryAccessory) lock;
+			addCharacteristic(new BatteryLevelCharacteristic(
+					batteryAccessory::getBatteryLevelState,
+					batteryAccessory::subscribeBatteryLevelState,
+					batteryAccessory::unsubscribeBatteryLevelState
+			));
+		}
+	}
 }

src/main/java/com/beowulfe/hap/impl/services/MotionSensorService.java

@@ -1,6 +1,8 @@
 package com.beowulfe.hap.impl.services;
 
+import com.beowulfe.hap.accessories.BatteryAccessory;
 import com.beowulfe.hap.accessories.MotionSensor;
+import com.beowulfe.hap.impl.characteristics.common.BatteryLevelCharacteristic;
 import com.beowulfe.hap.impl.characteristics.common.Name;
 import com.beowulfe.hap.impl.characteristics.motionsensor.MotionDetectedStateCharacteristic;
 
@@ -10,5 +12,14 @@ public MotionSensorService(MotionSensor motionSensor) {
         super("00000085-0000-1000-8000-0026BB765291");
         addCharacteristic(new Name(motionSensor));
         addCharacteristic(new MotionDetectedStateCharacteristic(motionSensor));
+
+        if (motionSensor instanceof BatteryAccessory) {
+            BatteryAccessory batteryAccessory = (BatteryAccessory) motionSensor;
+            addCharacteristic(new BatteryLevelCharacteristic(
+                    batteryAccessory::getBatteryLevelState,
+                    batteryAccessory::subscribeBatteryLevelState,
+                    batteryAccessory::unsubscribeBatteryLevelState
+            ));
+        }
     }
 }