Skip to content

turbolift/ioBroker.shelly

 
 

Repository files navigation

Logo

ioBroker.shelly

NPM version Downloads Snyk Vulnerabilities for npm package node-lts Libraries.io dependency status for latest release

GitHub GitHub repo size GitHub commit activity GitHub last commit GitHub issues GitHub Workflow Status Snyk Vulnerabilities for GitHub Repo

Versions

Beta Stable Installed

The adapter communicates with Shelly devices by REST API and the CoAP or MQTT protocol.

Uses the default Shelly firmware (no flashing of firmware needed!). You will find more and detailed information about the device here : Shelly

Documentation

🇺🇸 Documentation

🇩🇪 Dokumentation

Supported devices (Gen 1)

Shelly Device CoAP MQTT Tested firmware version
Shelly 1 (SHSW-1) >= v3.3.0 >= v3.3.0 20221027-091427/v1.12.1-ga9117d3
Shelly 1 1PM (SHSW-PM) >= v3.3.0 >= v3.3.0 20221108-153925/v1.12.1-1PM-fix-g2821131
Shelly 1L (SHSW-L) >= v4.0.5 >= v4.0.5 n/a
Shelly 2 (SHSW-21/SHSW-22) >= v3.3.0 >= v3.3.0 20221027-091902/v1.12.1-ga9117d3
Shelly 2.5 (SHSW-25) >= v3.3.0 >= v3.3.0 20221027-092056/v1.12.1-ga9117d3
Shelly 4 Pro (SHSW-44) >= v3.3.5 >= v3.3.5 n/a
Shelly Dimmer (SHDM-1) >= v3.3.0 >= v3.3.0 20221027-103924/v1.12.1-ga9117d3
Shelly Dimmer 2 (SHDM-2) >= v3.3.4 >= v3.3.4 n/a
Shelly RGBW (SHRGBWW-01) < v3.4.0 < v3.4.0 n/a
Shelly RGBW 2 (SHRGBW2) >= v3.3.0 >= v3.3.0 20221027-100516/v1.12.1-ga9117d3
Shelly i3 (SHIX3-1) >= v3.3.0 >= v3.3.0 20220809-125301/v1.12-g99f7e0b
Shelly EM (SHEM) >= v3.3.0 >= v3.3.0 n/a
Shelly 3EM (SHEM-3) >= v3.3.0 >= v3.3.0 n/a
Shelly H&T (SHHT-1) >= v3.3.0 >= v3.3.0 20221027-092707/v1.12.1-ga9117d3
Shelly Smoke (SHSM-01) >= v3.3.0 >= v3.3.0 20221027-092259/v1.12.1-ga9117d3
Shelly Flood (SHWT-1) >= v3.3.0 >= v3.3.0 20221027-092932/v1.12.1-ga9117d3
Shelly Gas (SHGS-1) >= v3.3.3 >= v3.3.3 20221027-111245/v1.12.1-ga9117d3
Shelly Door/Window Sensor (SHDW-1) >= v3.3.0 >= v3.3.0 n/a
Shelly Door/Window Sensor 2 (SHDW-2) >= v3.3.5 >= v3.3.5 20221027-093702/v1.12.1-ga9117d3
Shelly2LED (SH2LED) >= v3.3.0 >= v3.3.0 n/a
Shelly Plug (SHPLG-1) >= v3.3.0 >= v3.3.0 n/a
Shelly Plug S (SHPLG-S) >= v3.3.0 >= v3.3.0 20221027-101131/v1.12.1-ga9117d3
Shelly Plug 2 (SHPLG-2) >= v3.3.0 >= v3.3.0 n/a
Shelly Sense (SHSEN-1) >= v3.3.0 >= v3.3.0 n/a
Shelly Bulb (SHBLB) >= v3.3.0 >= v3.3.0 n/a
Shelly Bulb Duo (SHBDUO-1) >= v3.3.0 >= v3.3.0 20221027-090712/v1.12.1-ga9117d3
Shelly Color Bulb (SHCB-1) >= v4.0.5 >= v4.0.5 20221027-085547/v1.12.1-ga9117d3
Shelly Vintage (SHVIN-1) >= v3.3.0 >= v3.3.0 n/a
Shelly Uni (SHUNI-1) >= v4.0.4 >= v4.0.4 20221027-121732/v1.12.1-ga9117d3
Shelly Button (SHBTN-1) >= v3.3.3 >= v3.3.3 20220809-124206/v1.12-g99f7e0b
Shelly Button (SHBTN-2) >= v4.0.5 >= v4.0.5 n/a
Shelly Motion (SHMOS-01) >= v4.0.6 >= v4.0.6 20220811-152232/v2.1.8@5afc928c
Shelly TRV (SHTRV-01) >= v6.0.0 >= v6.0.0 20220811-152343/v2.1.8@5afc928c
Shelly Motion 2 (SHMOS-02) => v6.2.0 >= v6.2.0 20220811-152232/v2.1.8@5afc928c

NOT Supported:

  • USB powered UVC LED strip

Supported devices (Gen 2)

Shelly Device CoAP MQTT Tested firmware version
Shelly Plus 1 (shellyplus1) >= v5.0.0 20230209-131418/0.13.0-g68ba560
Shelly Plus 1 PM (shellyplus1pm) >= v5.0.0 20230209-131443/0.13.0-g68ba560
Shelly Plus 2 PM (shellyplus2pm) >= v5.2.0 20230209-131443/0.13.0-g68ba560
Shelly Plus i4 (shellyplusi4) >= v5.3.0 20230209-132028/0.13.0-g68ba560
Shelly Plus i4 DC (shellyplusi4) >= v5.3.0 20221206-142532/0.12.0-gafc2404
Shelly Pro 1 (shellypro1) >= v5.2.0 20221206-143405/0.12.0-gafc2404
Shelly Pro 1 PM (shellypro1pm) >= v5.2.0 20221206-143638/0.12.0-gafc2404
Shelly Pro 2 (shellypro2) >= v5.2.0 20221206-143405/0.12.0-gafc2404
Shelly Pro 2 PM (shellypro2pm) >= v5.2.0 20221206-143638/0.12.0-gafc2404
Shelly Pro 3 (shellypro3) >= v6.2.0 20221206-143535/0.12.0-gafc2404
Shelly Pro 4 PM (shellypro4pm) >= v5.0.0 20221206-143814/0.12.0-gafc2404
Shelly Pro 3 EM (shellypro3em) >= v6.4.0 n/a
Shelly Plus H&T (shellyplusht) >= v6.2.0 20221206-142534/0.12.0-gafc2404
Shelly Plus Plug S (shellyplusplugs) >= v6.4.0 n/a

NOT Supported:

  • Shelly Plus Smoke
  • Shelly Plus AddOn
  • Shelly Plus Wall Dimmer US
  • Shelly Plus Plug US

Sentry

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

Troubleshooting after installation

TypeError: xmlserializer.Builder is not a constructor

execute

cd /opt/iobroker/node_modules/iobroker.shelly npm install xml2js@0.4.23

Changelog

6.4.0 (2023-02-09)

  • (klein0r) Added Shelly Plus Plug S
  • (klein0r) Added Shelly Pro 3 EM
  • (klein0r) Reduced checks for firmware updates
  • (klein0r) Shelly TV profile is now changeable

6.3.1 (2023-01-02)

  • (klein0r) Updated MQTT topic prefix handling
  • (klein0r) Added temperature for generation 2 devices in cover mode
  • (klein0r) Added boost start/stop for Shelly TRV
  • (klein0r) Added external power for Shelly H&T

6.3.0 (2022-12-22)

  • (klein0r) Added more TRV features
  • (jlegen) Improved Shelly TRV integration
  • (klein0r) Updated knowledge base urls
  • (klein0r) Added Ukrainian language

6.2.4 (2022-10-23)

  • (klein0r) IP address of CoAP devices is unknown in some cases
  • (klein0r) Optimized destroy process

6.2.3 (2022-10-20)

  • (klein0r) Use unique ID for each command - generation 2 devices
  • (klein0r) Fix: Ack state if value is unchanged

License

The MIT License (MIT)

Copyright (c) 2018-2023 Thorsten Stueben thorsten@stueben.de, Apollon77 iobroker@fischer-ka.de and Matthias Kleine info@haus-automatisierung.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Shelly ioBroker Adapter

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%