Homepoint

An ESP32 based Smarthome Controller for MQTT & HomeKit

Homepoint is a screen-based interface for MQTT-connected Smarthome devices that runs on the cheaply available ESP32 Chipset.
It can also provide Switches to HomeKit. These can be used inside the Home App on iOS to trigger other HomeKit Devices.

For MQTT this project requires a MQTT-Broker to be running in your smarthome.

Features

• See and trigger scenes (groups of devices) on the front screen.
• Trigger individual devices by diving into scenes (by tapping the indicator or long pressing a button).
• See partially switched on scenes with multiple devices at a glance.
• Support for temperature, humidity and air quality sensors.
• HomeKit Switch Support (Setup Automations in Home App to toggle from Homepoint)
• Supports both Touch Screen or Button based navigation.
• Screen updates automatically when devices are triggered from elsewhere.
• Easy configuration through a JSON files.
• Screensaver saves power by switching off screen after 10 minutes.
• Statusbar shows connectivity for WiFi and MQTT as well as time.

Planned

• Improve HomeKit Support
• Improved documentation

Is there a feature missing? Open an issue, send me an email or fork this project and add it yourself.

Requirements

Homepoint works with any ESP32 device and Touchscreen supported by TFT_eSPI, which are:
ILI9341, ILI9163, ST7735, S6D02A1, ILI9481, ILI9486, ILI9488, HX8357D and ST7789 based TFT displays that support SPI.

It has been tested with

• M5STACK
• ArduiTouch
• Adafruit Huzzah32 + Adafruit IL9341

Installation

In order to build Homepoint, you need the ESP-IDF SDK.

Requirements

HomePoint was built on ESP-IDF master. Unfortunately CMake Support in 3.3 is incomplete and master is currently changing a lot and breaking the dependency to the ESP32-Arduino submodule.
I plan to make HomePoint compatible to v4.0 once it gets a public release, for the time being, please use commit 02f2e63662d0314b689bb4925f5d8efa08cfe033 from the ESP-IDF repo.

Software	Version
ESP-IDF	master (commit 02f2e63662d0314b689bb4925f5d8efa08cfe033)
Toolchain	5.2.0

Installation is fairly straight forward, see Setting up the Toolchain in the Espressif Documentation.

git clone https://www.github.com/sieren/homepoint.git
cd homepoint
git submodule update --init --recursive
mkdir build && cd build
cmake ../
make spiffs_spiffs_bin
make -j 8 flash

For use with a Button-Based interface configure with

cmake -DBUTTONS=ON ../

and for out of box use with M5STACK run

cmake -DM5STACK=ON ../

Otherwise the default configuration will be for touch-screens like ArduiTouch or the widely used ILI9341 like the one offered by Adafruit. GPIOs for the screen as well as M5Stack may have to be configured in main/libraries/TFT_ESPI/User_Setup.h.

Other Homepoint specific configuration settings like the time it takes before the Screensaver kicks in can be configured in main/config/Config.h.

Configuration

See the data/config.json file as a reference.
Each Scene consists of one or several devices. The scene can either be a Switch, Light or a Sensor.
Do not put Switch devices into a Sensor scene.
If Sensors transmit their information via JSON, set jsonData to true, and specify the key under which the data is sent (ie. temperature).
Sensor can have up to two devices, in which case a combined view is shown (ie. for temperature and humidity).
Wifi & MQTT credentials go in the top level.
Homepoint gets its time from an NTP Server. In order to set the correct timezone, copy & paste your NTP TZ Setting from here.

Example

{
  "wifi": "MyWifiSSID",
  "password": "My Wifi Password",
  "mqttbroker": "mqtt://192.168.1.2",
  "mqttusername": "mqttusername",
  "mqttpasswd": "mymqttpassword",
  "timezone": "CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00",
  "scenes": [{
    "name": "Living Room",
    "type": "Light",
    "icon": "livingroom",
    "devices": [{
      "name": "Side Light",
      "setTopic": "lights/hue/00:17:88:01:02:3c:2a:6d-0b/set/on",
      "getTopic": "hue/status/lights/Hue color lamp 1",
      "onValue": "true",
      "offValue": "false"
    }]
  },
  {
    "name": "Bedroom",
    "type": "Sensor",
    "icon": "door",
    "devices": [{
      "name": "Temperature DHT Sensor",
      "type": "temperature",
      "jsondata": true,
      "temperatureKey": "temperature",
      "getTopic": "bedroom/esptemp"
    },
    {
      "name": "Humidity DHT Sensor",
      "type": "humidity",
      "jsondata": true,
      "humidityKey": "humidity",
      "getTopic": "bedroom/esphumi"
    }]
  }]
}

Switches can have custom icons, the icons of sensors are currently fixed and not customizable. See the data folder for available icons or add your own following the naming scheme visible there.

HomeKit

To active HomeKit, simply set a PIN in the configuration file.
Beware that the PIN has to follow the scheme of xxx-xx-xxx.
A single HomeKit Switch is of type: "HomeKitSwitch".
It may not contain any devices.

{
  "wifi": "MyWifiSSID",
  "password": "My Wifi Password",
  "mqttbroker": "mqtt://192.168.1.2",
  "mqttusername": "mqttusername",
  "mqttpasswd": "mymqttpassword",
  "homekitpin": "111-11-111",
  "timezone": "CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00",
  "scenes": [
  {
    "name": "Living Room",
    "type": "HomeKitSwitch",
    "icon": "livingroom"
  }]
}