https://github.com/netbeast/react-native-tplink
Wrapper that lets you use hs100-api module in react-native
https://github.com/netbeast/react-native-tplink
Last synced: 10 months ago
JSON representation
Wrapper that lets you use hs100-api module in react-native
- Host: GitHub
- URL: https://github.com/netbeast/react-native-tplink
- Owner: netbeast
- License: mit
- Created: 2017-03-29T07:58:46.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T15:01:34.000Z (over 8 years ago)
- Last Synced: 2025-07-28T03:49:07.596Z (11 months ago)
- Language: JavaScript
- Size: 31.3 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hs100-api
[](https://www.npmjs.com/package/hs100-api)
[](https://github.com/Flet/semistandard)
TPLink HS100/HS110 WiFi Smart Plug API
## Example
```javascript
const Hs100Api = require('hs100-api');
const client = new Hs100Api.Client();
const plug = client.getPlug({host: '10.0.1.2'});
plug.getInfo().then(console.log);
plug.setPowerState(true);
// Look for plugs, log to console, and turn them on
client.startDiscovery().on('plug-new', (plug) => {
plug.getInfo().then(console.log);
plug.setPowerState(true);
});
```
## API
The API is currently not stable and there may be breaking changes.
### Client
#### new Client(options)
Returns a Client object.
```javascript
options: {
[address]
[, port]
[, broadcast = '255.255.255.255']
[, discoveryInterval = 30000]
[, offlineTolerance = 3]
[, debug = false]
}
```
#### startDiscovery([plugs])
Sends a discovery packet to the broadcast address every `discoveryInterval`. An array of addresses can be specified to query directly. Emits `plug-new` when a response from a new plug is received and `plug-online` for known plugs. If a known plug has not been heard from after `offlineTolerance` number of discovery attempts then emits `plug-offline`.
#### stopDiscovery
Stops discovery process.
#### getPlug(options)
Returns a Plug object.
```javascript
options: { host [, port = 9999] [, timeout = 0] }
```
### Plug
#### getInfo _(promise)_
Get all plug info. Same as calling all of getSysInfo, getCloudInfo, getConsumption, getScheduleNextAction.
#### getSysInfo _(promise)_
Get general plug info.
#### getCloudInfo _(promise)_
Get TP-Link Cloud information.
#### getConsumption _(promise)_
Get power consumption data for HS110 plugs.
#### getPowerState _(promise)_
Returns true if plug is on.
#### setPowerState(value) _(promise)_
Turns the plug on or off.
#### setName(value) _(promise)_
Change plug's alias.
#### getScheduleNextAction _(promise)_
#### getScheduleRules _(promise)_
#### getAwayRules _(promise)_
#### getTimerRules _(promise)_
#### getTime _(promise)_
#### getTimeZone _(promise)_
#### getScanInfo([refresh = false] [, timeout = 17]) _(promise)_
Get list of networks.
#### getModel _(promise)_
## Credits
Thanks to George Georgovassilis and Thomas Baust for figuring out the HS1XX encryption.
https://georgovassilis.blogspot.com/2016/05/controlling-tp-link-hs100-wi-fi-smart.html
Some design cues for Client were based on https://github.com/MariusRumpf/node-lifx/