homebridge-tplink-smarthome

TPLink Smart Home Plugin for Homebridge. (formerly homebridge-hs100)

Models Supported

Plugs: HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP303, KP400
Bulbs: LB100, LB110, LB120, LB130, LB200, LB230

More models may be supported than listed. If you have another model working please let me know so I can add here.

Homekit

Model	deviceType	Service	Characteristics
HS100, HS103, HS105, HS107, KP303, KP400	plug	Outlet	On OutletInUse (based on On state)
HS110, HS300	plug	Outlet	On OutletInUse (based on energy monitoring) Volts (Custom) Amperes (Custom) Watts (Custom) VoltAmperes (Custom) KilowattHours (Custom) KilowattVoltAmpereHour (Custom)
HS200, HS210	plug	Switch	On
HS220	plug	Lightbulb	On Brightness
LB100, LB110, LB200	bulb	Lightbulb	On Brightness Watts (Custom)
LB120	bulb	Lightbulb	On Brightness ColorTemperature Watts (Custom)
LB130, LB230	bulb	Lightbulb	On Brightness ColorTemperature Hue Saturation Watts (Custom)

Installation

Node v8.3 or greater is required. Check by running: node --version
Install Homebridge using: npm install -g homebridge or sudo npm install -g --unsafe-perm homebridge (more details)
Install this plugin using: npm install -g homebridge-tplink-smarthome
Update your configuration file. See the sample below.

Updating

npm update -g homebridge-tplink-smarthome

Note for Previous Users of homebridge-hs100

If you had homebridge-hs100 installed previously, due to how homebridge works, you may get this error on startup: Error: Cannot add a bridged Accessory with the same UUID as another bridged Accessory:. You'll need to remedy this by deleting the cachedAccessories file, or by manually editing the file to remove the old accessories under homebridge-hs100. On most systems that file will be here: ~/.homebridge/accessories/cachedAccessories.

Configuration

Sample Configuration

Minimal

"platforms": [{
  "platform": "TplinkSmarthome",
  "name": "TplinkSmarthome"
}]

All options with defaults

Note that comments aren't allowed in JSON files. But are included here for readability.

"platforms": [{
  "platform": "TplinkSmarthome",
  "name": "TplinkSmarthome",

  ////////////////////////////////
  // Device Discovery Options
  ////////////////////////////////
  "broadcast": "255.255.255.255", // Broadcast Address. If discovery is not working tweak to match your subnet, eg: 192.168.0.255
  "devices": [],         // Manual list of devices (see "Manually Specifying Devices" section below)
  "deviceTypes": [],     // set to [] or ["plug", "bulb"] to find all TPLink device types or ["plug"] / ["bulb"] for only plugs or bulbs
  "macAddresses": [],    // Whitelist of mac addresses to include. If specified will ignore other devices. Supports glob-style patterns
  "excludeMacAddresses": [],  // Blacklist of mac addresses to exclude. Supports glob-style patterns
  "pollingInterval": 10, // (seconds) How often to check device status in the background

  ////////////////////////////////
  // Device Options
  ////////////////////////////////
  "addCustomCharacteristics": true, // Adds energy monitoring characteristics viewable in Eve app
  "inUseThreshold": 0,       // (Watts) For plugs that support energy monitoring (HS110), min power draw for OutletInUse
  "switchModels": ["HS200", "HS210"], // Matching models are created in homekit as a Switch instead of an Outlet
  "timeout": 15               // (seconds) communication timeout
}]

MAC Addresses

MAC Addresses are normalized, special characters are removed and made uppercase for comparison. So any format should work: AA:BB:CC:00:11:22 or aaBbcc001122 are valid. Glob-style pattern matching is supported: ? will match a single character and * matches zero or more. To specify all MAC addresses that start with AA you could use AA*

Custom Characteristics in Eve

Devices that support energy monitoring (HS110, etc) will have extra characteristics that are viewable in the Eve app. Turn this off by setting addCustomCharacteristics false.

Manually Specifying Devices

If you have a network setup where UDP broadcast is not working, you can manually specify the devices you'd like this plugin to use. This will send the discovery message directly to these devices in addition to the UDP broadcast. Note that your device must have a static IP to work.

"platforms": [{
  "platform": "TplinkSmarthome",
  "name": "TplinkSmarthome",

  "devices": [
    { "host": "192.168.0.100" },
    { "host": "192.168.0.101" },
    { "host": "192.168.0.102", "port": "9999" } // port defaults to "9999" but can be overriden
  ]
}]

Accessory Names

Note the name in Homebridge/HomeKit may be out of sync from the Kasa app. This is a Homebridge/HomeKit limitation. You can rename your accessory through the Home app.

Troubleshooting

UUID Errors

Error: Cannot add a bridged Accessory with the same UUID as another bridged Accessory If you get an error about duplicate UUIDs you'll have to either remove your cached configuration files or manually edit them to remove the offending entry. By default they are stored in ~/.homebridge/accessories. In some cases you may also need to remove ~/.homebridge/persist and re-pair homebridge to your home.

You can remove them by running:

rm -rf ~/.homebridge/accessories
rm -rf ~/.homebridge/persist

Credits

Thanks to George Georgovassilis and Thomas Baust for reverse engineering the HS1XX protocol.

tobyshao/homebridge-tplink-smarthome