Skip to content

Latest commit

 

History

History
82 lines (72 loc) · 3.91 KB

README.md

File metadata and controls

82 lines (72 loc) · 3.91 KB

node-shellies

NPM Version Build Status

Handles communication with the first generation Shelly devices, using both CoAP and HTTP.

For the next generation devices, see node-shellies-ng.

Features

  • Automatically detects Shelly devices (on the same network and subnet).
  • Automatically detects when the status of a device changes, such as when a relay is turned on or off.
  • Keeps track of devices and if they go offline (because no status update has been received in a given amount of time).

Supported devices

The following Shelly devices are supported:

Notes

1 Requires setting the Internet & Security -> CoIoT -> Remote address option on the Shelly device to the IP address of your device running node-shellies.

Basic usage example

const shellies = require('shellies')

shellies.on('discover', device => {
  // a new device has been discovered
  console.log('Discovered device with ID', device.id, 'and type', device.type)

  device.on('change', (prop, newValue, oldValue) => {
    // a property on the device has changed
    console.log(prop, 'changed from', oldValue, 'to', newValue)
  })

  device.on('offline', () => {
    // the device went offline
    console.log('Device with ID', device.id, 'went offline')
  })
})

// start discovering devices and listening for status updates
shellies.start()