https://github.com/dhleong/wemore
A more awesome library for Belkin WeMo interactions
https://github.com/dhleong/wemore
Last synced: about 1 year ago
JSON representation
A more awesome library for Belkin WeMo interactions
- Host: GitHub
- URL: https://github.com/dhleong/wemore
- Owner: dhleong
- Created: 2014-07-19T20:27:33.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T17:49:53.000Z (over 3 years ago)
- Last Synced: 2024-04-14T19:24:24.344Z (about 2 years ago)
- Language: JavaScript
- Size: 64.5 KB
- Stars: 37
- Watchers: 4
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-iot - wemore ★ 26 ⧗ 10 - A more awesome library for Belkin WeMo interactions. (Protocol Library / WeMo)
- awesome_iot - wemore ★ 26 ⧗ 10 - A more awesome library for Belkin WeMo interactions. (Protocol Library / WeMo)
README
wemore
======
A more awesome library for Belkin WeMo interactions. With acknowledgements to
[wemo.js](https://github.com/thatguydan/wemo.js.git) for protocol reference.
### Usage
[](https://nodei.co/npm/wemore/)
Toggle the first device found:
```javascript
var wemore = require('wemore')
// with no args, a Discovery object is returned
// that emits device events as they're discovered
var discovery = wemore.Discover()
.on('device', function(device) {
device.toggleBinaryState();
discovery.close(); // stop discovering
});
```
Toggling a device by its friendly name:
```javascript
var wemore = require('wemore')
// when the friendly name is provided, a Promise is returned
wemore.Discover('Lights')
.then(function(device) {
return device.toggleBinaryState();
})
.then(function() {
console.log("Success!");
})
.fail(function(err) {
console.error("Couldn't find device", err);
});
```
#### Emulate Devices
Wemore also provides a facility for emulating devices, allowing you to
transparently respond to toggle events from another device on the network,
like perhaps the Amazon Echo.
```javascript
var wemore = require('wemore');
// note that each device needs a separate port:
var tv = wemore.Emulate({friendlyName: "TV", port: 9001}); // choose a port
var stereo = wemore.Emulate({friendlyName: "Stereo"}); // automatically assigned
stereo.on('listening', function() {
// if you want it, you can get it:
console.log("Stereo listening on", this.port);
});
tv.on('state', function(binaryState, self, sender) {
console.log("TV set to=", binaryState);
tv.close(); // stop advertising the device
});
// also, 'on' and 'off' events corresponding to binary state
stereo.on('on', function(self, sender) {
console.log("Stereo turned on");
});
stereo.on('off', function(self, sender) {
console.log("Stereo turned off");
});
```
If you need information about who requested the event, it is provided as a
"Sender object" that looks something like this:
```javascript
{
address: '::ffff:192.168.1.23',
port: 12345
}
```
See [Socket.remoteAddress](https://nodejs.org/api/net.html#net_socket_remoteaddress)
for more information about these values.
### Binary
Installing with `-g` provides the `wemore-toggle` executable:
```
usage: wemore-toggle
```
It's simply a wrapper around the "toggle by friendly name" example above.