Refactoring for optional

CHANGES.md

@@ -1,3 +1,13 @@
+# HAP-Java 2.0.0
+* major refactoring to support optional characteristics
+* structure and names adapted to HAP spec structure and naming.
+* structure is following
+    * `accessory` package include basis accessory as the listed in HAP spec, plus interfaces for optional characteristics. clients should extend the accessory classes. e.g. `WindowCoveringAccessory` or `AccessoryWithBrightness`
+    * `characteristics` package consists of all characteristics, optional and mandatory. e.g. `TargetHorizontalTiltAngleCharacteristic`. The naming is done in accordance to HAP spec.
+    * `services` package consists of services, which grouping characteristics. e.g. `WindowCoveringService` defines mandatory and optional characteristics for a window covering service as it is defined in HAP spec.
+    * `server` package consists classes to run HomeKit server and handle communication
+* the process is following: client, e.g. openHAB bindings, extends accessory classes, e.g. `WindowCoveringAccessory` and implements all required methods. WindowCoveringAccessory is linked already to WindowCoveringService, that in turn is link to single characteristics. 
+
 # HAP-Java 1.1.5
 
 ## Fixes

README.md

@@ -1,22 +1,74 @@
 HAP-Java
 =========
-HAP-Java is a Java implementation of the Homekit Accessory Protocol.
+HAP-Java is a Java implementation of the HomeKit Accessory Protocol.
 
-Using this library, you can create your own Homekit Accessory or Homekit Accessory Bridge.
-
-Because the MFi Specification is closed to individual developers, and this implementation was made without access to that specification, it may not be complete. iOS devices do recognize and are able to interact with accessories exposed via this library however.
+Using this library, you can create your own HomeKit Accessory or HomeKit Accessory Bridge.
 
 This library would not have been possible without [Tian Zhang](https://github.com/KhaosT) who did a lot of the hard work of figuring out how the protocol works in his NodeJS implementation.
 
 Usage
 =========
 Include HAP-Java in your project using maven:
+
 ```
 <dependency>
 	<groupId>io.github.hap-java</groupId>
 	<artifactId>hap</artifactId>
-	<version>1.2.0-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 </dependency>
 ```
 
-After that, read the [Javadoc](http://beowulfe.github.io/HAP-Java/apidocs/) and check out the [Sample](https://github.com/beowulfe/HAP-Java/tree/sample).
+After that, check out the [Sample](https://github.com/hap-java/HAP-Java/tree/sample).
+
+Supported HomeKit Accessories
+=========
+
+Current implementation fully supports 37 HomeKit accessory/services.
+
+| HomeKit Accessory & Service type | Supported by Java-HAP |
+|--------------------|--------------------|
+|  Accessory Information            |     :white_check_mark:    |
+|  Air Purifier                     |     :white_check_mark:    |
+|  Air Quality Sensor               |     :white_check_mark:    |
+|  Audio Stream Management          |     :x:                   |
+|  Battery Service                  |     :white_check_mark:    |
+|  Camera RTP Stream Management     |     :x:                   |
+|  Carbon Dioxide Sensor            |     :white_check_mark:    |
+|  Carbon Monoxide Sensor           |     :white_check_mark:    |
+|  Contact Sensor                   |     :white_check_mark:    |
+|  Data Stream Transport Management |     :x:                   |
+|  Door                             |     :white_check_mark:    |
+|  Doorbell                         |     :white_check_mark:    |
+|  Fan                              |     :white_check_mark:    |
+|  Faucet                           |     :white_check_mark:    |
+|  Filter Maintenance               |     :x:                   |
+|  Garage Door Opener               |     :white_check_mark:    |
+|  HAP Protocol Information         |     :white_check_mark:    |
+|  Heater Cooler                    |     :white_check_mark:    |
+|  Humidifier Dehumidifier          |     :white_check_mark:    |
+|  Humidity Sensor                  |     :white_check_mark:    |
+|  Irrigation System                |     :white_check_mark:    |
+|  Leak Sensor                      |     :white_check_mark:    |
+|  Light Bulb                       |     :white_check_mark:    |
+|  Light Sensor                     |     :white_check_mark:    |
+|  Lock Management                  |     :x:                   |
+|  Lock Mechanism                   |     :white_check_mark:    |
+|  Microphone                       |     :white_check_mark:    |
+|  Motion Sensor                    |     :white_check_mark:    |
+|  Occupancy Sensor                 |     :white_check_mark:    |
+|  Outlet                           |     :white_check_mark:    |
+|  Security System                  |     :white_check_mark:    |
+|  Service Label                    |     :white_check_mark:    |
+|  Siri                             |     :x:                   |
+|  Slat                             |     :white_check_mark:    |
+|  Smoke Sensor                     |     :white_check_mark:    |
+|  Speaker                          |     :white_check_mark:    |
+|  Stateless Programmable Switch    |     :white_check_mark:    |
+|  Switch                           |     :white_check_mark:    |
+|  Target Control                   |     :x:                   |   
+|  Target Control Management        |     :x:                   |
+|  Temperature Sensor               |     :white_check_mark:    |
+|  Thermostat                       |     :white_check_mark:    |
+|  Valve                            |     :white_check_mark:   |
+|  Window                           |     :white_check_mark:   |
+|  Window Covering                  |     :white_check_mark:   |

pom.xml

@@ -5,13 +5,15 @@
 	<artifactId>hap</artifactId>
 	<name>hap-java</name>
 	<description>Homekit Accessory Protocol for Java</description>
-	<version>1.2.0-snapshot</version>
+	<version>2.0.0-snapshot</version>
 	<packaging>jar</packaging>
 	<url>https://github.com/hap-java/HAP-Java</url>
 
 	<properties>
     	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-  	</properties>
+		<netty.version>4.1.42.Final</netty.version>
+
+	</properties>
 
 	<licenses>
 		<license>
@@ -56,8 +58,44 @@
 
 		<dependency>
 			<groupId>io.netty</groupId>
-			<artifactId>netty-all</artifactId>
-			<version>4.0.32.Final</version>
+			<artifactId>netty-common</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-buffer</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-transport</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-handler</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-codec</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-codec-http</artifactId>
+			<version>${netty.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.netty</groupId>
+			<artifactId>netty-resolver</artifactId>
+			<version>${netty.version}</version>
 		</dependency>
 
 		<dependency>
@@ -102,12 +140,6 @@
 			<version>3.4.1</version>
 		</dependency>
 
-		<dependency>
-			<groupId>commons-io</groupId>
-			<artifactId>commons-io</artifactId>
-			<version>2.4</version>
-		</dependency>
-
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
@@ -163,9 +195,10 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>3.0.1</version>
+				<version>3.2.0</version>
 				<configuration>
-					<excludePackageNames>io.github.hapjava.impl</excludePackageNames>
+					<excludePackageNames>io.github.hapjava.server.impl</excludePackageNames>
+					<source>8</source>
 				</configuration>
 				<executions>
 					<execution>
@@ -178,7 +211,7 @@
 			</plugin>
 			<plugin>
 				<artifactId>maven-assembly-plugin</artifactId>
-				<version>3.1.0</version>
+				<version>3.1.1</version>
 				<configuration>
 					<descriptors>
 						<descriptor>deploy/distribution.xml</descriptor>
@@ -272,7 +305,7 @@
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>3.0.1</version>
 				<configuration>
-					<excludePackageNames>io.github.hapjava.impl</excludePackageNames>
+					<excludePackageNames>io.github.hapjava.server.impl</excludePackageNames>
 				</configuration>
 				<reportSets>
 					<reportSet>

src/main/java/io/github/hapjava/accessories/AirPurifierAccessory.java

@@ -0,0 +1,86 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.airpurifier.CurrentAirPurifierStateEnum;
+import io.github.hapjava.characteristics.impl.airpurifier.TargetAirPurifierStateEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.AirPurifierService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** An air purifier. */
+public interface AirPurifierAccessory extends HomekitAccessory {
+  /**
+   * Mandatory: Retrieves the current active state of the fan'.
+   *
+   * @return a future that will contain the binary state
+   */
+  CompletableFuture<Boolean> isActive();
+
+  /**
+   * Sets the active state of the fan
+   *
+   * @param state the binary state to set
+   * @return a future that completes when the change is made
+   * @throws Exception when the change cannot be made
+   */
+  CompletableFuture<Void> setActive(boolean state) throws Exception;
+
+  /**
+   * Subscribes to changes in the active state of the fan.
+   *
+   * @param callback the function to call when the direction changes.
+   */
+  void subscribeActive(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the active state of the fan. */
+  void unsubscribeActive();
+
+  /**
+   * Retrieves the current state of the air purifier
+   *
+   * @return a future that will contain the state
+   */
+  CompletableFuture<CurrentAirPurifierStateEnum> getCurrentState();
+
+  /**
+   * Subscribes to changes in the state of the air purifier.
+   *
+   * @param callback the function to call when the state changes.
+   */
+  void subscribeCurrentState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the state of the air purifier. */
+  void unsubscribeCurrentState();
+
+  /**
+   * Retrieves the air purifier target state.
+   *
+   * @return a future that will contain the air purifier target state .
+   */
+  CompletableFuture<TargetAirPurifierStateEnum> getTargetState();
+
+  /**
+   * set target state the air purifier target state.
+   *
+   * @param state air purifier target state
+   * @return a future that completes when the change is made
+   */
+  CompletableFuture<Void> setTargetState(TargetAirPurifierStateEnum state);
+
+  /**
+   * Subscribes to changes in the target state of the air purifier.
+   *
+   * @param callback the function to call when the target state changes.
+   */
+  void subscribeTargetState(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the target state of the air purifier. */
+  void unsubscribeTargetState();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new AirPurifierService(this));
+  }
+}

src/main/java/io/github/hapjava/accessories/AirQualityAccessory.java

@@ -0,0 +1,35 @@
+package io.github.hapjava.accessories;
+
+import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
+import io.github.hapjava.characteristics.impl.airquality.AirQualityEnum;
+import io.github.hapjava.services.Service;
+import io.github.hapjava.services.impl.AirQualityService;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
+
+/** An air quality accessory which can include several sensors. */
+public interface AirQualityAccessory extends HomekitAccessory {
+
+  /**
+   * Retrieves the state of the air quality
+   *
+   * @return a future that will contain the state
+   */
+  CompletableFuture<AirQualityEnum> getAirQuality();
+
+  /**
+   * Subscribes to changes in the air quality
+   *
+   * @param callback the function to call when the air quality changes.
+   */
+  void subscribeAirQuality(HomekitCharacteristicChangeCallback callback);
+
+  /** Unsubscribes from changes in the air quality. */
+  void unsubscribeAirQuality();
+
+  @Override
+  default Collection<Service> getServices() {
+    return Collections.singleton(new AirQualityService(this));
+  }
+}