homekitrelay

Homekit relay is a Homekit interface to GCE Elecronics IPX800V4. It is insprired from homebridge but desinged to excusively work for IPX800.

The main benefit is being API friendly with the IPX. HTTP Request are sent peacefully to avoid IPX internal resources issues.

Binding of HAP Services into IPX devices is made obvious and simple by the avoidance of generic drivers.

This projet includes a shell script to set up dependencies and start/stop in batch mode.

Homekit devices :

• GarageDoorOpener
• Lightbulb
• LightSensor
• Switch
• Outlet
• TemperatureSensor
• WindowCovering
• OccupancySensor
• MotionSensor
• ContactSensor

The project is tested on a Synology, and is designed to run on tiny computer.

Requires at least python3.8. But python 3.9 is preferred.

Installation

Download the installation package named : package.tar Create a sub dir and extract the package :

mkdir homekitrelay
cd homekitrelay
tar xf ../package.tar
# install python packages.
./homekitrelay.sh setup

Then create the configuration file.

cd config
cp sample-config.json config.json

See below for the configuration settings.

Version 3.5.1, HAP-python no longer supports python older than 3.6, this code have been tested on python 3.9.

Synology installation

Create a user to host the package. Apply defaut parameters.

Open the task scheduler.

create a setup task

Planning

• Run on the following date
• choose today
• do not repeat.

Task setting

• the command to launch is : /volume1/homes/ipxrelay/homekitrelay/homekitrelay.sh setup

Then run the task mannually.

created a start/stop task.

Its purpose is to daily launch/restart the gateway at a specified hour.

Task settings is : /volume1/homes/ipxrelay/homekitrelay/homekitrelay.sh restart

configuration file

Configuration is based on a JSON file. It's name must be config.json and stored in the config directory. Use sample_config.json for your first config file. config.json is devided in three sections : "homekit", "ipx", "devices".

the homekit section.

key	default value	definition
"pincode"	none	the Homekit accessory pin code. mandatory. ex : "pincode" : "511-37-112"
"bridge_name"	none	accessory name for Homekit applications. mandatory. ex : "bridge_name": "ipx800"
"port"	none	The IP TCP port the bridge is listening on. mandatory ex : "port" : 51133

Example :

 "komekit: {
 "pincode" : "511-37-112",
    "bridge_name" : "ipx800",
    "port" : 51133
}

the ipx section.

key	default value	definition
"host"	none	the IPX800V4 IP address or hostname. mandatory ex : "host" : "192.168.7.99"
"port"	80	The IPX800V4 API TCP port. ex :"port" : "80"
"interval"	250	the interval in msec between two HTTP request sent to the IPX. HTTP request are used to Get the devices status. The bridge send ONE HTTP request per device category. For example all "R" devices are read in one request. There is no need to high frequency updates. ex : "interval" : 250
"apikey"	none	The API declared on your IPX. ex : "apikey" : "XXXXXXXXX"

Example :

 "ipx800: {
  "host" : "192.168.7.99",
    "port" : "80",
    "interval" : 250,
    "apikey" : "XXXXXXXXX"
}

## TBC