@yorick1245/shellies-ds9
v1.1.6
Published
Handles communication with the next generation of Shelly devices
Downloads
46
Readme
node-shellies-ds9
Handles communication with the next generation of Shelly devices. This Package is only to pimp up the existing package https://badgen.net/npm/v/shellies-ng. Because I'm lost if my Minis don't run in the Homebridge. If Alex creates a new version of his package that supports the Mini devices, I will delete this package again. thx@sw-koenig...
For the first generation, see node-shellies.
Supported devices
- Shelly Plus 1 + V3
- Shelly Plus 1 PM + V3
- Shelly Plus 1 Mini + V3
- Shelly Plus 1 PM Mini + V3
- Shelly Plus PM Mini + V3
- Shelly Plus 2 PM
- Shelly Plus I4 +V3
- Shelly Plus Plug US
- Shelly Plus H&T +V3
- Shelly Plus 0-10V Dimmer
- Shelly Dimmer 0/1-10V PM 1
- Shelly Pro 1
- Shelly Pro 1 PM
- Shelly Pro 2
- Shelly Pro 2 PM
- Shelly Pro 3
- Shelly Pro 4 PM
- Shelly Pro Dual Cover PM
- Shelly Pro Dimmer 1PM
- Shelly Pro Dimmer 2PM
1 Support for outbound websockets is a work in progress.
Basic usage example
import {
Device,
DeviceId,
MdnsDeviceDiscoverer,
Shellies,
ShellyPlus1,
} from "shellies-ds9";
const shellies = new Shellies();
// handle discovered devices
shellies.on("add", async (device: Device) => {
console.log(`${device.modelName} discovered`);
console.log(`ID: ${device.id}`);
// use instanceof to determine the device model
if (device instanceof ShellyPlus1) {
const plus1 = device as ShellyPlus1;
// toggle the switch
await plus1.switch0.toggle();
}
});
// handle asynchronous errors
shellies.on("error", (deviceId: DeviceId, error: Error) => {
console.error("An error occured:", error.message);
});
// create an mDNS device discoverer
const discoverer = new MdnsDeviceDiscoverer();
// register it
shellies.registerDiscoverer(discoverer);
// start discovering devices
discoverer.start();
See homebridge-shelly-ng for a real-world example.