homekit2mqtt

[![License][mit-badge]][mit-url]

HomeKit to MQTT bridge 🏡📱

Depends on HAP-NodeJS by KhaosT, all credits belong to him.

This project follows the mqtt-smarthome architecture. I'm using this to control a multitude of MQTT-connected "Things" in my home automation through Siri and with HomeKit apps.

Warning: Version 0.9.4 possibly introduces a breaking change. Due to the issue #89 service subtypes where added, please give your Home app a few minutes to get updates, if the accessories don't work at all anymore after an update from <=0.9.3 to >=0.9.4 you have to delete the persistence files and delete and re-add the bridge in iOS...:-(

Installation

Requirements

Debian, Ubuntu, Raspbian or macOS
Node.js 6 or higher
If you want to use the Camera Service FFmpeg has to be installed (on Linux: sudo apt install ffmpeg)

sudo npm install -g homekit2mqtt --unsafe-perm

I suggest to use pm2 to manage the homekit2mqtt process (start on system boot, manage log files, ...)

Command Line Options

<pre> Usage: homekit2mqtt [options] Options: -v, --verbosity possible values: "error", "warn", "info", "debug" [default: "info"] -m, --mapfile JSON file containing HomeKit Services to MQTT mapping definitions. See Readme. [default: "./example-homekit2mqtt.json"] -n, --name instance name. used as prefix for connected topic [default: "homekit"] -u, --url mqtt broker url. [default: "mqtt://127.0.0.1"] -s, --storagedir directory to store homekit data -p, --port port homekit2mqtt is listening on [default: 51826] -w, --web-port port webserver is listening on [default: 51888] -x, --disable-web disable webserver --disable-json-parse disable json parsing of received mqtt payloads [boolean] --insecure allow tls connections with invalid certificates[boolean] --retain if set, ALL MQTT messages sent will have the retain flag set [boolean] -h, --help Show help [boolean] --version Show version number [boolean] -c, --pincode [default: "031-45-154"] -a, --username [default: "CC:22:3D:E3:CE:F6"] -b, --bridgename [default: "MQTT Bridge"] </pre>

Persisted Data

I strongly advice you to set the --storagedir and --mapfile option to a directory outside of the homekit2mqtt folder, otherwise an update of homekit2mqtt could overwrite your config.

MQTT Authentication and TLS

You can put credentials for authentication in the url supplied to the --url option: mqtt://user:password@broker. If you want to use TLS for the connection to the broker use mqtts:// as URL scheme, e.g. mqtts://broker:8883.

MQTT Payload parsing

By default homekit2mqtt parses incoming JSON payloads and tries to use the attribute val (following mqtt-smarthome payload convention). For a future release it is planned that this attribute will be configurable (see https://github.com/hobbyquaker/homekit2mqtt/issues/67).

If you set the --disable-json-parse option there will be no JSON parsing at all and homekit2mqtt just hands the incoming JSON through as string.

Plain (non-JSON) payloads containing the strings true or false are casted to boolean. Strings containing numbers are casted to numbers with parseFloat().

Configuration

homekit2mqtt needs a JSON file that defines devices and mappings from MQTT-topics and payloads to HomeKit-characteristics. You can either create this manually or use the Web UI to configure homekit2mqtt. The Webserver listens on Port 51888 by default, authentication username is homekit and the password is the pincode (031-45-154 by default).

Web UI Web UI

See example-homekit2mqtt.json for an example configuration. Every Accessory is represented like this in the JSON file:

  "TemperatureSensor": {                                    // Unique name - used to generate the accessory UUID
    "name": "TemperatureSensor LivingRoom",                 // Accessory name
    "services": [
        {
            "service": "TemperatureSensor",                 // HomeKit service type (see available service types below)
            "name": "Temperature LivingRoom",               // Service name
            "topic": {                                              
                // ... MQTT topic configuration ...
            },
            "payload": {
                // ... MQTT payload configuration ...
            },
            "props": {
                // ... Optional Characteristic properties
            },
            "config": {
                // ... Optional Service configuration
            }       
        },
        // ... more services
    ],
    "manufacturer": "DIY Home Brew",                        // Additional accessory infos (optional)
    "model": "TemperatureSensor"                            // Additional accessory infos (optional)
  }

Available Service Types

AirPurifier

topic

statusActive
setActive
statusCurrentAirPurifierState
0 = INACTIVE, 1 = IDLE, 2 = PURIFYING_AIR
statusTargetAirPurifierState
0 = MANUAL, 1 = AUTO
setTargetAirPurifierState
0 = MANUAL, 1 = AUTO
statusLockPhysicalControls (optional)
0 = CONTROL_LOCK_DISABLED, 1 = CONTROL_LOCK_ENABLED
setLockPhysicalControls (optional)
0 = CONTROL_LOCK_DISABLED, 1 = CONTROL_LOCK_ENABLED
statusSwingMode (optional)
0 = SWING_DISABLED, 1 = SWING_ENABLED
setLockSwingMode (optional)
0 = SWING_DISABLED, 1 = SWING_ENABLED
statusRotationSpeed (optional)
Percentage 0-100
setRotationSpeed (optional)
Percentage 0-100

payload

activeTrue (optional, default: true)
invertActive (optional, default: false)
rotationSpeedFactor (optional, default: 1)

AirQualitySensor

topic

statusAirQuality
0 = UNKNOWN, 1 = EXCELLENT, 2 = GOOD, 3 = FAIR, 4 = INFERIOR, 5 = POOR
statusOzoneDensity (optional)
statusNitrogenDioxideDensity (optional)
statusSulphurDioxideDensity (optional)
statusPM2_5Density (optional)
statusPM10Density (optional)
statusVOCDensity (optional)
statusCarbonMonoxideLevel (optional)
statusCarbonDioxideLevel (optional)
onLowBattery (optional)
onTampered (optional)
onActive (optional)
onFault (optional)

payload

onLowBattery (optional)
invertLowBattery (optional, default: false)
onTampered (optional)
invertTampered (optional, default: false)
onActive (optional)
invertActive (optional, default: false)
onFault (optional)
invertFault (optional, default: false)

BatteryService

topic

statusBatteryLevel
Percentage 0-100
statusChargingState
0 = NOT_CHARGING, 1 = CHARGING, 2 = NOT_CHARGEABLE
statusLowBattery
0 = BATTERY_LEVEL_NORMAL, 1 = BATTERY_LEVEL_LOW

payload

onLowBattery
invertLowBattery (optional, default: false)
minBatteryLevel (optional, default: 0)
maxBatteryLevel (optional, default: 100)

CameraRTSPStreamManagement

topic

payload

config

source (default: -re -i rtsp://myfancy_rtsp_stream)
stillImageSource (default: -i http://faster_still_image_grab_url/this_is_optional.jpg)
maxStreams (default: 2)
the maximum number of streams that will be generated for this camera
maxWidth (default: 1280)
maxHeight (default: 720)
maxFPS (default: 10)
the maximum frame rate of the stream
maxBitrate (default: 300)
the maximum bit rate of the stream in kbit/s
vcodec (default: libx264)
If you're running on a RPi with the omx version of ffmpeg installed, you can change to "h264_omx" for hardware accelerated video codec
audio
can be set to true to enable audio streaming from camera. To use audio ffmpeg must be compiled with --enable-libfdk-aac, see https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki
packetSize (default: 1316)
If audio or video is choppy try a smaller value, set to a multiple of 188
debug
Show the output of ffmpeg in the log
videoProcessor (default: ffmpeg)

CarbonDioxideSensor

topic

statusCarbonDioxideDetected
statusCarbonDioxideLevel (optional)
statusCarbonDioxidePeakLevel (optional)
statusTampered (optional)
statusActive (optional)
statusFault (optional)

payload

onCarbonDioxideDetected
o

Homekit2mqtt

Install / Use

README

homekit2mqtt

Installation

Command Line Options

Persisted Data

MQTT Authentication and TLS

MQTT Payload parsing

Configuration

Available Service Types

AirPurifier

AirQualitySensor

BatteryService

CameraRTSPStreamManagement

CarbonDioxideSensor