3.7.0 • Published 6 years ago

homebridge-hs100 v3.7.0

Weekly downloads
5
License
MIT
Repository
github
Last release
6 years ago

homebridge-hs100

NPM Version js-semistandard-style

TPLink HS100 / HS105 / HS110 / HS200 WiFi Smart Plug plugin for Homebridge.

Installation

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

Updating

  • npm update -g homebridge-hs100

Configuration

Sample Configuration

Minimal:
"platforms": [{
    "platform": "Hs100",
    "name": "TPLink"
}]
All options with defaults:
"platforms": [{
    "platform": "Hs100",
    "name": "TPLink",
    "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
    "pollingInterval": 10,     // (seconds) How often to check device status in the background
    "switchModels": ["HS200"], // Matching models are created in homekit as a switch instead of an outlet
    "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
    "timeout": 5               // (seconds) communication timeout
}]

I only have HS100, HS105 and HS110 (plugs), so I am unable to test Bulb support directly. I'd gladly accept pull requests to add features or equipment donations (amazon wishlist) so I can do my own development!

I have written a TP-Link device simulator for automated testing that includes Bulbs. So while I don't have a physical Bulb to test with, I do have virtual ones!

ModeldeviceTypeCharacteristicsSupport
HS100, HS105, HS110plugOnOutletInUse (based on On state)Good
HS110plugOnOutletInUse (based on energy monitoring)Volts (Custom)Amperes (Custom)Watts (Custom)VoltAmperes (Custom)KilowattHours (Custom)KilowattVoltAmpereHour (Custom)Good
HS200plugOnReported Good Same API as Plug
LB100, LB110bulbOnBrightnessNot tested
LB120bulbOnBrightnessColorTemperatureNot tested
LB130bulbOnBrightnessColorTemperatureHueSaturationNot tested

Custom Characteristics in Eve

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

eveplug

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/persist and ~/.homebridge/accessories.

You can remove them by running: rm -rf ~/.homebridge/persist && rm -rf ~/.homebridge/accessories

You may also need to un-pair and re-pair your bridge to Homekit.

Credits

Thanks to George Georgovassilis and Thomas Baust for reverse engineering the HS1XX protocol. https://blog.georgovassilis.com/2016/05/07/controlling-the-tp-link-hs100-wi-fi-smart-plug/

3.7.0

6 years ago

3.6.0

6 years ago

3.5.0

6 years ago

3.4.0

7 years ago

3.3.1

7 years ago

3.3.0

7 years ago

3.2.0

7 years ago

3.1.0

7 years ago

3.0.0

7 years ago

2.2.0

7 years ago

2.1.0

7 years ago

2.0.1

7 years ago

2.0.0

8 years ago

1.1.1

8 years ago

1.1.0

8 years ago

1.0.0

8 years ago