sillyfrog/homekit2mqtt

HomeKit to MQTT bridge 🏡📱

homekit2mqtt

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.

See changes history in CHANGELOG.md

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

Prerequisites:

• Debian, Ubuntu, Raspbian or macOS
• Node.js 6 or higher
• If you're running on Linux, you'll need to make sure you have the libavahi-compat-libdnssd-dev package installed: sudo apt-get install libavahi-compat-libdnssd-dev

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

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]
  -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"]
                                                             

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 hobbyquaker#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).

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

AirQualitySensor

topic

• statusAirQuality
• statusOzoneDensity (optional)
• statusNitrogenDioxideDensity (optional)
• statusSulphurDioxideDensity (optional)
• statusPM2_5Density (optional)
• statusPM10Density (optional)
• statusVOCDensity (optional)
• statusCarbonMonoxideLevel (optional)
• statusCarbonDioxideLevel (optional)
• statusLowBattery (optional)
• statusTampered (optional)
• statusActive (optional)
• statusFault (optional)

payload

BatteryService

topic

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

payload

• onLowBattery
• minBatteryLevel (optional, default: 0)
• maxBatteryLevel (optional, default: 100)

CarbonDioxideSensor

topic

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

payload

• onCarbonDioxideDetected
• onLowBattery (optional)
• onTampered (optional)
• onActive (optional)
• onFault (optional)

CarbonMonoxideSensor

topic

• statusCarbonMonoxideDetected
• statusLowBattery (optional)

payload

• onCarbonMonoxideDetected
• onLowBattery (optional)

ContactSensor

topic

• statusContactSensorState
• statusLowBattery (optional)
• statusTampered (optional)
• statusActive (optional)
• statusFault (optional)

payload

• onContactDetected
• onLowBattery (optional)
• onTampered (optional)
• onActive (optional)
• onFault (optional)

Door

topic

• setTargetPosition
• statusTargetPosition (optional)
• statusCurrentPosition (optional)
• statusPositionState (optional)
• statusObstruction (optional)

payload

• targetPositionFactor (optional)
• currentPositionFactor (optional)
• positionStatusDecreasing (optional)
• positionStatusIncreasing (optional)
• onObstructionDetected (optional)

Doorbell

topic

• statusEvent

payload

Fan

topic

• setOn
• statusOn (optional)
• setRotationDirection (optional)
• statusRotationDirection (optional)
• setRotationSpeed (optional)
• statusRotationSpeed (optional)

payload

• onTrue (optional, default: true)
• onFalse (optional, default: false)
• rotationDirectionCounterClockwise (optional, default: 1)
• rotationDirectionClockwise (optional, default: 0)
• rotationSpeedFactor (optional, default: 1)

Faucet

topic

• setActive
• statusActive (optional)
• statusFault (optional)

payload

• activeTrue (optional, default: true)
• activeFalse (optional, default: false)
• faultTrue (optional, default: true)

GarageDoorOpener

topic

• setDoor
• statusDoor (optional)
• statusObstruction (optional)
• setLock (optional)
• statusLock (optional)

payload

• doorOpen
• doorClosed
• doorOpening (optional)
• doorClosing (optional)
• doorStopped (optional)
• onObstructionDetected (optional)
• lockUnsecured (optional)
• lockSecured (optional)

HumiditySensor

topic

• statusHumidity
• statusLowBattery (optional)

payload

• onLowBattery (optional)

IrrigationSystem

topic

• setActive
• statusActive
• statusFault (optional)
• statusInUse
• statusRemainingDuration
• statusProgramMode

payload

• activeTrue (optional, default: true)
• activeFalse (optional, default: false)
• faultTrue (optional, default: true)
• inUseTrue (optional, default: true)

LeakSensor

topic

• statusLeakDetected
• statusLowBattery (optional)

payload

• onLeakDetected
• onLowBattery (optional)

Lightbulb

topic

• setOn
• statusOn (optional)
• setBrightness (optional)
• statusBrightness (optional)
• setHue (optional)
• statusHue (optional)
• setSaturation (optional)
• statusSaturation (optional)
• setColorTemperature (optional)
• statusColorTemperature (optional)
• statusRGB (optional)
• setRGB (optional)

payload

• onTrue
• onFalse
• brightnessFactor (optional, default: 1)
• hueFactor (optional, default: 1)
• saturationFactor (optional, default: 1)

LightSensor

topic

• statusAmbientLightLevel
• statusLowBattery (optional)

payload

• ambientLightLevelFactor (optional, default: 1)
• onLowBattery (optional)

LockMechanism

topic

• setLock
• statusLock (optional)

payload

• lockSecured

Microphone

topic

• setMute
• statusMute (optional)
• setVolume (optional)
• statusVolume (optional)

payload

• muteTrue
• muteFalse
• volumeFactor (optional, default: 1)

MotionSensor

topic

• statusMotionDetected
• statusLowBattery (optional)

payload

• onMotionDetected
• onLowBattery (optional)

OccupancySensor

topic

• statusOccupancyDetected
• statusLowBattery (optional)

payload

• onOccupancyDetected
• onLowBattery (optional)

Outlet

topic

• setOn
• statusOn (optional)
• statusOutletInUse

payload

• onFalse
• onTrue
• onOutletInUse

SecuritySystem

topic

• setSecuritySystemTargetState
• statusSecuritySystemCurrentState (optional)

payload

Slat

topic

• statusCurrentSlatState
  0 = FIXED, 1 = JAMMED, 2 = SWINGING
• statusCurrentTiltAngle (optional)
• statusTargetTiltAngle (optional)
• setTargetTiltAngle (optional)
• statusSwingMode (optional)
  0 = SWING_DISABLED, 1 = SWING_ENABLED
• setSwingMode (optional)
  0 = SWING_DISABLED, 1 = SWING_ENABLED

payload

config

• SlatType
  0 = HORIZONTAL, 1 = VERTICAL

SmokeSensor

topic

• statusSmokeDetected
• statusLowBattery (optional)

payload

• onSmokeDetected
• onLowBattery (optional)

Speaker

topic

• setMute
• statusMute (optional)
• setVolume (optional)
• statusVolume (optional)

payload

• muteTrue
• muteFalse
• volumeFactor, default: 1)

StatelessProgrammableSwitch

topic

• statusEvent

payload

Switch

topic

• setOn
• statusOn (optional)

payload

• onFalse
• onTrue

TemperatureSensor

topic

• statusTemperature
• statusLowBattery (optional)

payload

• fahrenheit, default: false)
  Set to true if your sensor publishes values in degree fahrenheit
• onLowBattery (optional)

Thermostat

topic

• setTargetTemperature
• statusTargetTemperature (optional)
• statusCurrentTemperature
• setTargetHeatingCoolingState (optional)
  0 = off, 1 = heat, 2 = cool
• statusTargetHeatingCoolingState (optional)
  0 = off, 1 = heat, 2 = cool
• statusCurrentHeatingCoolingState (optional)
  0 = off, 1 = heat, 2 = cool
• setTargetRelativeHumidity (optional)
• statusTargetRelativeHumidity (optional)
• statusCurrentRelativeHumidity (optional)
• setCoolingThresholdTemperature (optional)
• statusCoolingThresholdTemperature (optional)
• setHeatingThresholdTemperature (optional)
• statusHeatingThresholdTemperature (optional)

payload

config

• TemperatureDisplayUnits
  0 = CELSIUS, 1 = FAHRENHEIT

Valve

topic

• setActive
• statusActive
• statusFault (optional)
• statusInUse
• statusRemainingDuration (optional)
• setDuration (optional)

payload

• activeTrue (optional, default: true)
• activeFalse (optional, default: false)
• faultTrue (optional, default: true)
• inUseTrue (optional, default: true)

config

• ValveType (optional, default: 0)
  0 = GENERIC_VALVE, 1 = IRRIGATION, 2 = SHOWER_HEAD, 3 = WATER_FAUCET

Window

topic

• setTargetPosition
• statusTargetPosition (optional)
• statusCurrentPosition (optional)
• statusPositionState (optional)
• statusObstruction (optional)

payload

• targetPositionFactor (optional, default: 1)
• currentPositionFactor (optional, default: 1)
• positionStatusDecreasing (optional)
• positionStatusIncreasing (optional)
• onObstructionDetected (optional)

WindowCovering

topic

• setTargetPosition
• statusTargetPosition (optional)
• statusCurrentPosition (optional)
• statusPositionState (optional)

payload

• targetPositionFactor (optional, default: 1)
• currentPositionFactor (optional, default: 1)
• positionStatusDecreasing (optional)
• positionStatusIncreasing (optional)

License

MIT © Sebastian Raff and homekit2mqtt contributors