Skip to content

Commit 8aa99f1

Browse files
author
Eugen Freiter
committed
update readme
Signed-off-by: Eugen Freiter <freiter@gmx.de>
1 parent c640cdb commit 8aa99f1

File tree

1 file changed

+55
-3
lines changed

1 file changed

+55
-3
lines changed

README.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ HAP-Java is a Java implementation of the Homekit Accessory Protocol.
44

55
Using this library, you can create your own Homekit Accessory or Homekit Accessory Bridge.
66

7-
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.
8-
97
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.
108

119
Usage
@@ -19,4 +17,58 @@ Include HAP-Java in your project using maven:
1917
</dependency>
2018
```
2119

22-
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).
20+
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).
21+
22+
Supported HomeKit Accessories
23+
=========
24+
25+
Current implementation is based on HAP specification Release R2 (published 2019-07-26)
26+
fully supports 29 out of 48 HomeKit accessories defined there.
27+
28+
| HomeKit Accessory | Supported by Java-HAP |
29+
|--------------------|--------------------|
30+
| Accessory Information | :white_check_mark: yes |
31+
| Air Purifier | :x: no |
32+
| Air Quality Sensor | :x: no |
33+
| Audio Stream Management | :x: no |
34+
| Battery Service | :white_check_mark: yes |
35+
| Camera RTP Stream Management | :x: no |
36+
| Carbon Dioxide Sensor | :white_check_mark: yes |
37+
| Carbon Monoxide Sensor | :white_check_mark: yes |
38+
| Contact Sensor | :white_check_mark: yes |
39+
| Data Stream Transport Management | :x: no |
40+
| Door | :white_check_mark: yes |
41+
| Doorbell | :white_check_mark: yes |
42+
| Fan | :white_check_mark: yes |
43+
| Faucet | :x: no |
44+
| Filter Maintenance | :x: no |
45+
| Garage Door Opener | :white_check_mark: yes |
46+
| HAP Protocol Information | :x: no |
47+
| Heater Cooler | :x: no |
48+
| Humidifier Dehumidifier | :x: no |
49+
| Humidity Sensor | :white_check_mark: yes |
50+
| Irrigation System | :x: no |
51+
| Leak Sensor | :white_check_mark: yes |
52+
| Light Bulb | :white_check_mark: yes |
53+
| Light Sensor | :white_check_mark: yes |
54+
| Lock Management | :x: no |
55+
| Lock Mechanism | :white_check_mark: yes |
56+
| Microphone | :white_check_mark: yes |
57+
| Motion Sensor | :white_check_mark: yes |
58+
| Occupancy Sensor | :white_check_mark: yes |
59+
| Outlet | :white_check_mark: yes |
60+
| Security System | :white_check_mark: yes |
61+
| Service Label | :x: no |
62+
| Siri | :x: no |
63+
| Slat | :white_check_mark: yes |
64+
| Smoke Sensor | :white_check_mark: yes |
65+
| Speaker | :white_check_mark: yes |
66+
| Stateless Programmable Switch | :white_check_mark: yes |
67+
| Switch | :white_check_mark: yes |
68+
| Target Control | :x: no |
69+
| Target Control Management | :x: no |
70+
| Temperature Sensor | :white_check_mark: yes |
71+
| Thermostat | :white_check_mark: yes |
72+
| Valve | :white_check_mark: yes |
73+
| Window | :white_check_mark: yes |
74+
| Window Covering | :white_check_mark: yes |

0 commit comments

Comments
 (0)