Skip to content

Commit 51dc262

Browse files
committed
Update README
1 parent 3a13006 commit 51dc262

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
Homepoint
22
=============
3-
#### An ESP32 based Smarthome Controller for MQTT
3+
#### An ESP32 based Smarthome Controller for MQTT & HomeKit
44

55
![Travis CI](https://travis-ci.org/sieren/Homepoint.svg?branch=master "Travis CI
66
Status")
77
[![Issues](https://img.shields.io/github/issues/sieren/Homepoint.svg
88
"Issues")](https://github.com/sieren/Homepoint/issues)
99

1010
Homepoint is a screen-based interface for MQTT-connected Smarthome devices that runs
11-
on the cheaply available ESP32 Chipset.
12-
This project requires a MQTT-Broker to be running in your smarthome.
11+
on the cheaply available ESP32 Chipset.
12+
It can also provide *Switches* to *HomeKit*. These can be used inside the Home App on iOS
13+
to trigger other HomeKit Devices.
14+
15+
For MQTT this project requires a MQTT-Broker to be running in your smarthome.
1316

1417
<img src="https://raw.githubusercontent.com/sieren/Homepoint/master/media/img1.jpg" width="400"><img src="https://raw.githubusercontent.com/sieren/Homepoint/master/media/img2.gif" width="400">
1518
[![HomePoint Youtube demo](https://raw.githubusercontent.com/sieren/Homepoint/master/media/youtube.png)](https://www.youtube.com/watch?v=bqzpkvtQSvY "HomePoint Youtube demo")
@@ -20,14 +23,17 @@ This project requires a MQTT-Broker to be running in your smarthome.
2023
+ See and trigger scenes (groups of devices) on the front screen.
2124
+ Trigger individual devices by diving into scenes (long press).
2225
+ Support for temperature, humidity and air quality sensors.
26+
+ HomeKit Switch Support (Setup Automations in Home App to toggle from Homepoint)
2327
+ Supports both Touch Screen or Button based navigation.
2428
+ Screen updates automatically when devices are triggered from elsewhere.
2529
+ Easy configuration through a JSON files.
2630
+ Screensaver saves power by switching off screen after 10 minutes.
2731
+ Statusbar shows connectivity for WiFi and MQTT as well as time.
2832

33+
2934
#### Planned
30-
+ HomeKit Button/Switch Support (for users without MQTT to setup Automations they can toggle from Homepoint)
35+
36+
+ Improve HomeKit Support
3137
+ Improved documentation
3238

3339
Is there a feature missing? Open an issue, send me an [email](mailto:[email protected]) or fork this project and add it yourself.
@@ -117,3 +123,28 @@ Homepoint gets its time from an NTP Server. In order to set the correct timezone
117123
```
118124
Switches can have custom icons, the icons of sensors are currently fixed and not customizable.
119125
See the `data` folder for available icons or add your own following the naming scheme visible there.
126+
127+
### HomeKit
128+
To active *HomeKit*, simply set a PIN in the configuration file.
129+
Beware that the PIN has to follow the scheme of `xxx-xx-xxx`.
130+
A single HomeKit Switch is of `type: "HomeKitSwitch"`.
131+
It may not contain any devices.
132+
133+
```
134+
{
135+
"wifi": "MyWifiSSID",
136+
"password": "My Wifi Password",
137+
"mqttbroker": "mqtt://192.168.1.2",
138+
"mqttusername": "mqttusername",
139+
"mqttpasswd": "mymqttpassword",
140+
"homekitpin": "111-11-111",
141+
"timezone": "CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00",
142+
"scenes": [
143+
{
144+
"name": "Living Room",
145+
"type": "HomeKitSwitch",
146+
"icon": "livingroom"
147+
}]
148+
}
149+
```
150+

0 commit comments

Comments
 (0)