Added new Temperature and Humidity sensors

Author: andylintner

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

@@ -0,0 +1,41 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitAccessory;
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.Service;
+import com.beowulfe.hap.impl.services.HumiditySensorService;
+
+/**
+ * A humidity sensor that reports the current relative humidity.
+ *
+ * @author Andy Lintner
+ */
+public interface HumiditySensor extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current relative humidity.
+	 * @return a future that will contain the humidity as a value between 0 and 100
+	 */
+	CompletableFuture<Double> getCurrentRelativeHumidity();
+	
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new HumiditySensorService(this));
+	}
+	
+	/**
+	 * Subscribes to changes in the current relative humidity.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeCurrentRelativeHumidity(HomekitCharacteristicChangeCallback callback);
+
+	/**
+	 * Unsubscribes from changes in the current relative humidity.
+	 */
+	void unsubscribeCurrentRelativeHumidity();
+	
+}

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

@@ -0,0 +1,61 @@
+package com.beowulfe.hap.accessories;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitAccessory;
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.Service;
+import com.beowulfe.hap.accessories.properties.TemperatureUnit;
+import com.beowulfe.hap.impl.services.TemperatureSensorService;
+
+/**
+ * A temperature sensor that reports the current temperature
+ *
+ * @author Andy Lintner
+ */
+public interface TemperatureSensor extends HomekitAccessory {
+
+	/**
+	 * Retrieves the current temperature, in celsius degrees.
+	 * @return a future that will contain the temperature.
+	 */
+	CompletableFuture<Double> getCurrentTemperature();
+	
+	@Override
+	default public Collection<Service> getServices() {
+		return Collections.singleton(new TemperatureSensorService(this));
+	}
+	
+	/**
+	 * Subscribes to changes in the current temperature.
+	 * @param callback the function to call when the state changes.
+	 */
+	void subscribeCurrentTemperature(HomekitCharacteristicChangeCallback callback);
+
+	/**
+	 * Unsubscribes from changes in the current temperature.
+	 */
+	void unsubscribeCurrentTemperature();
+	
+	/**
+	 * Retrieves the minimum temperature, in celsius degrees, the thermostat can be set to.
+	 * @return the minimum temperature.
+	 */
+	double getMinimumTemperature();
+
+	/**
+	 * Retrieves the maximum temperature, in celsius degrees, the thermostat can be set to.
+	 * @return the maximum temperature.
+	 */
+	double getMaximumTemperature();
+	
+	/**
+	 * Retrieves the temperature unit of the thermostat. The impact of this is unclear, as the actual temperature
+	 * is always communicated in celsius degrees, and the iOS device uses the user's locale to determine
+	 * the unit to convert to.
+	 * @return the temperature unit of the thermostat.
+	 */
+	default TemperatureUnit getTemperatureUnit() { return TemperatureUnit.CELSIUS; }
+}

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

@@ -7,7 +7,6 @@
 import com.beowulfe.hap.HomekitAccessory;
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
 import com.beowulfe.hap.Service;
-import com.beowulfe.hap.accessories.properties.TemperatureUnit;
 import com.beowulfe.hap.accessories.properties.ThermostatMode;
 import com.beowulfe.hap.impl.services.ThermostatService;
 
@@ -16,7 +15,7 @@
  *
  * @author Andy Lintner
  */
-public interface Thermostat extends HomekitAccessory {
+public interface Thermostat extends HomekitAccessory, TemperatureSensor {
 
 	/**
 	 * Retrieves the current {@link ThermostatMode} of the thermostat.
@@ -59,43 +58,6 @@ public interface Thermostat extends HomekitAccessory {
 	 */
 	void unsubscribeTargetMode();
 
-	/**
-	 * Retrieves the temperature unit of the thermostat. The impact of this is unclear, as the actual temperature
-	 * is always communicated in celsius degrees, and the iOS device uses the user's locale to determine
-	 * the unit to convert to.
-	 * @return the temperature unit of the thermostat.
-	 */
-	TemperatureUnit getTemperatureUnit();
-
-	/**
-	 * Retrieves the minimum temperature, in celsius degrees, the thermostat can be set to.
-	 * @return the minimum temperature.
-	 */
-	double getMinimumTemperature();
-
-	/**
-	 * Retrieves the maximum temperature, in celsius degrees, the thermostat can be set to.
-	 * @return the maximum temperature.
-	 */
-	double getMaximumTemperature();
-
-	/**
-	 * Retrieves the current temperature, in celsius degrees.
-	 * @return a future that will contain the temperature.
-	 */
-	CompletableFuture<Double> getCurrentTemperature();
-	
-	/**
-	 * Subscribes to changes in the current temperature.
-	 * @param callback the function to call when the state changes.
-	 */
-	void subscribeCurrentTemperature(HomekitCharacteristicChangeCallback callback);
-
-	/**
-	 * Unsubscribes from changes in the current temperature.
-	 */
-	void unsubscribeCurrentTemperature();
-
 	/**
 	 * Retrieves the target temperature, in celsius degrees, used when the thermostat is in {@link ThermostatMode#AUTO} mode.
 	 * @return a future that will contain the target temperature.

src/main/java/com/beowulfe/hap/impl/characteristics/humiditysensor/CurrentRelativeHumidityCharacteristic.java

@@ -0,0 +1,39 @@
+package com.beowulfe.hap.impl.characteristics.humiditysensor;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
+import com.beowulfe.hap.accessories.HumiditySensor;
+import com.beowulfe.hap.characteristics.EventableCharacteristic;
+import com.beowulfe.hap.characteristics.FloatCharacteristic;
+
+public class CurrentRelativeHumidityCharacteristic extends FloatCharacteristic implements EventableCharacteristic {
+
+	private final HumiditySensor sensor;
+	
+	public CurrentRelativeHumidityCharacteristic(HumiditySensor sensor) {
+		super("00000010-0000-1000-8000-0026BB765291", false, true, "Current relative humidity", 0, 100,
+				0.1, "%");
+		this.sensor = sensor;
+	}
+	
+	@Override
+	public void subscribe(HomekitCharacteristicChangeCallback callback) {
+		sensor.subscribeCurrentRelativeHumidity(callback);
+	}
+
+	@Override
+	public void unsubscribe() {
+		sensor.unsubscribeCurrentRelativeHumidity();
+	}
+
+	@Override
+	protected void setValue(Double value) throws Exception {
+		//Read Only
+	}
+
+	@Override
+	protected CompletableFuture<Double> getDoubleValue() {
+		return sensor.getCurrentRelativeHumidity();
+	}
+}

src/main/java/com/beowulfe/hap/impl/characteristics/thermostat/AbstractTemperatureCharacteristic.java

@@ -1,15 +1,15 @@
 package com.beowulfe.hap.impl.characteristics.thermostat;
 
-import com.beowulfe.hap.accessories.Thermostat;
+import com.beowulfe.hap.accessories.TemperatureSensor;
 import com.beowulfe.hap.accessories.properties.TemperatureUnit;
 import com.beowulfe.hap.characteristics.EventableCharacteristic;
 import com.beowulfe.hap.characteristics.FloatCharacteristic;
 
 public abstract class AbstractTemperatureCharacteristic extends FloatCharacteristic implements EventableCharacteristic {
 
-	public AbstractTemperatureCharacteristic(String type, boolean isWritable, String description, Thermostat thermostat) {
-		super(type, isWritable, true, description, thermostat.getMinimumTemperature(), thermostat.getMaximumTemperature(),
-				0.1, thermostat.getTemperatureUnit() == TemperatureUnit.CELSIUS ? "celsius" : "fahrenheit");
+	public AbstractTemperatureCharacteristic(String type, boolean isWritable, String description, TemperatureSensor sensor) {
+		super(type, isWritable, true, description, sensor.getMinimumTemperature(), sensor.getMaximumTemperature(),
+				0.1, sensor.getTemperatureUnit() == TemperatureUnit.CELSIUS ? "celsius" : "fahrenheit");
 	}
 
 }

src/main/java/com/beowulfe/hap/impl/characteristics/thermostat/CurrentTemperatureCharacteristic.java

@@ -3,31 +3,31 @@
 import java.util.concurrent.CompletableFuture;
 
 import com.beowulfe.hap.HomekitCharacteristicChangeCallback;
-import com.beowulfe.hap.accessories.Thermostat;
+import com.beowulfe.hap.accessories.TemperatureSensor;
 
 public class CurrentTemperatureCharacteristic extends
 		AbstractTemperatureCharacteristic {
 
-	private final Thermostat thermostat;
+	private final TemperatureSensor sensor;
 
-	public CurrentTemperatureCharacteristic(Thermostat thermostat) {
+	public CurrentTemperatureCharacteristic(TemperatureSensor thermostat) {
 		super("00000011-0000-1000-8000-0026BB765291", false, "Current Temperature", thermostat);
-		this.thermostat = thermostat;
+		this.sensor = thermostat;
 	}
 
 	@Override
 	public void subscribe(HomekitCharacteristicChangeCallback callback) {
-		thermostat.subscribeCurrentTemperature(callback);
+		sensor.subscribeCurrentTemperature(callback);
 	}
 
 	@Override
 	public void unsubscribe() {
-		thermostat.unsubscribeCurrentTemperature();
+		sensor.unsubscribeCurrentTemperature();
 	}
 
 	@Override
 	protected CompletableFuture<Double> getDoubleValue() {
-		return thermostat.getCurrentTemperature();
+		return sensor.getCurrentTemperature();
 	}
 
 	@Override

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

@@ -0,0 +1,15 @@
+package com.beowulfe.hap.impl.services;
+
+import com.beowulfe.hap.accessories.HumiditySensor;
+import com.beowulfe.hap.impl.characteristics.common.Name;
+import com.beowulfe.hap.impl.characteristics.humiditysensor.CurrentRelativeHumidityCharacteristic;
+
+public class HumiditySensorService extends AbstractServiceImpl {
+	
+	public HumiditySensorService(HumiditySensor sensor) {
+		super("00000082-0000-1000-8000-0026BB765291");
+		addCharacteristic(new Name(sensor));
+		addCharacteristic(new CurrentRelativeHumidityCharacteristic(sensor));
+	}
+
+}

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

@@ -0,0 +1,15 @@
+package com.beowulfe.hap.impl.services;
+
+import com.beowulfe.hap.accessories.TemperatureSensor;
+import com.beowulfe.hap.impl.characteristics.common.Name;
+import com.beowulfe.hap.impl.characteristics.thermostat.CurrentTemperatureCharacteristic;
+
+public class TemperatureSensorService extends AbstractServiceImpl {
+	
+	public TemperatureSensorService(TemperatureSensor sensor) {
+		super("0000008A-0000-1000-8000-0026BB765291");
+		addCharacteristic(new Name(sensor));
+		addCharacteristic(new CurrentTemperatureCharacteristic(sensor));
+	}
+
+}