Skip to content

Integrate your Shelly devices into ioBroker via MQTT or CoIoT

License

Notifications You must be signed in to change notification settings

Baleares86/ioBroker.shelly

Β 
Β 

Repository files navigation

Logo

ioBroker.shelly

NPM version Downloads node-lts Libraries.io dependency status for latest release

GitHub GitHub repo size GitHub commit activity GitHub last commit GitHub issues GitHub Workflow Status

Versions

Beta Stable Installed

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

It 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

Generation 1 (Gen 1)

Shelly Device CoAP MQTT Tested firmware version
Shelly 1 (SHSW-1) >= v3.3.0 >= v3.3.0 20230913-112003/v1.14.0-gcb84623
Shelly 1 PM (SHSW-PM) >= v3.3.0 >= v3.3.0 20230913-113709/v1.14.0-gcb84623
Shelly 1L (SHSW-L) >= v4.0.5 >= v4.0.5 n/a
Shelly 2 (SHSW-21/SHSW-22) >= v3.3.0 >= v3.3.0 20230913-112145/v1.14.0-gcb84623
Shelly 2.5 (SHSW-25) >= v3.3.0 >= v3.3.0 20230913-112234/v1.14.0-gcb84623
Shelly 4 Pro (SHSW-44) >= v3.3.5 >= v3.3.5 n/a
Shelly Dimmer (SHDM-1) >= v3.3.0 >= v3.3.0 20230913-113908/v1.14.0-gcb84623
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 20230913-131259/v1.14.0-gcb84623
Shelly i3 (SHIX3-1) >= v3.3.0 >= v3.3.0 20230913-114336/v1.14.0-gcb84623
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 20230503-100134/v1.13.0-g9aed950
Shelly Smoke (SHSM-01) >= v3.3.0 >= v3.3.0 20230503-095905/v1.13.0-g9aed950
Shelly Flood (SHWT-1) >= v3.3.0 >= v3.3.0 20230503-100249/v1.13.0-g9aed950
Shelly Gas (SHGS-1) >= v3.3.3 >= v3.3.3 20230503-102300/v1.13.0-g9aed950
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 20230503-100505/v1.13.0-g9aed950
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 20230913-113421/v1.14.0-gcb84623
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 20230913-111548/v1.14.0-gcb84623
Shelly Vintage (SHVIN-1) >= v3.3.0 >= v3.3.0 n/a
Shelly Uni (SHUNI-1) >= v4.0.4 >= v4.0.4 20230913-114521/v1.14.0-gcb84623
Shelly Button (SHBTN-1) >= v3.3.3 >= v3.3.3 20230913-113105/v1.14.0-gcb84623
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

Generation 2 (Gen 2)

Shelly Device CoAP MQTT Tested firmware version
Shelly Plus 1 (shellyplus1) ❌ >= v5.0.0 20240425-141423/1.3.0-ga3fdd3d
Shelly Plus 1 PM (shellyplus1pm) ❌ >= v5.0.0 20240425-141434/1.3.0-ga3fdd3d
Shelly Plus 2 PM (shellyplus2pm) ❌ >= v5.2.0 20240425-141443/1.3.0-ga3fdd3d
Shelly Plus i4 (shellyplusi4) ❌ >= v5.3.0 20240425-141449/1.3.0-ga3fdd3d
Shelly Plus i4 DC (shellyplusi4) ❌ >= v5.3.0 20240425-141449/1.3.0-ga3fdd3d
Shelly Plus 0-10V (shellyplus010v) ❌ >= v6.9.0 20240425-141429/1.3.0-ga3fdd3d
Shelly Pro 1 (shellypro1) ❌ >= v5.2.0 20231219-133937/1.1.0-g34b5d4f
Shelly Pro 1 PM (shellypro1pm) ❌ >= v5.2.0 20231219-133937/1.1.0-g34b5d4f
Shelly Pro 2 (shellypro2) ❌ >= v5.2.0 20231219-133952/1.1.0-g34b5d4f
Shelly Pro 2 PM (shellypro2pm) ❌ >= v5.2.0 20231219-133937/1.1.0-g34b5d4f
Shelly Pro 3 (shellypro3) ❌ >= v6.2.0 20231219-133956/1.1.0-g34b5d4f
Shelly Pro 4 PM (shellypro4pm) ❌ >= v5.0.0 20231219-133936/1.1.0-g34b5d4f
Shelly Pro 3 EM (shellypro3em) ❌ >= v6.4.0 n/a
Shelly Pro Dimmer 1 PM (shellyprodm1pm) ❌ >= v7.0.0 20240425-141834/1.3.0-ga3fdd3d
Shelly Pro Dimmer 2 PM (shellyprodm2pm) ❌ >= v7.0.0 n/a
Shelly Plus H&T (shellyplusht) ❌ >= v6.2.0 20240105-142929/1.1.1-g68a461a
Shelly Plus Smoke (shellyplussmoke) ❌ >= v6.5.0 20230912-082250/1.0.3-g6176478
Shelly Bluetooth Gateway (shellyblugw) ❌ >= v6.5.0 20230912-081940/1.0.3-g6176478
Shelly Plus Plug S (shellyplusplugs) ❌ >= v6.4.0 n/a
Shelly Plus PM Mini (shellypmmini) ❌ >= v6.4.5 n/a
Shelly Plus 1 Mini (shellyplus1mini) ❌ >= v6.4.5 n/a
Shelly Plus 1 PM Mini (shellyplus1pmmini) ❌ >= v6.4.5 n/a
Shelly Plus Uni (shellyplusuni) ❌ >= v7.1.0 20240425-141514/1.3.0-ga3fdd3d
Shelly Wall Display (shellywalldisplay) ❌ >= v7.0.0 20240402-142908/1.2.11-e287c5c3

Generation 3 (Gen 3)

Shelly Device CoAP MQTT Tested firmware version
Shelly 1 Mini Gen3 (shelly1minig3) ❌ >= v7.0.0 20240425-141412/1.3.0-ga3fdd3d
Shelly 1 PM Mini Gen3 (shelly1pmminig3) ❌ >= v7.0.0 20240425-141355/1.3.0-ga3fdd3d
Shelly PM Mini Gen3 (shellypmminig3) ❌ >= v7.0.0 20240425-141418/1.3.0-ga3fdd3d
Shelly H&T Gen3 (shellyhtg3) ❌ >= v7.1.0 20240425-141355/1.3.0-ga3fdd3d
Shelly 1 PM Gen3 (shelly1pmg3) ❌ >= v7.1.0 20240425-141355/1.3.0-ga3fdd3d
Shelly 1 Gen3 (shelly1g3) ❌ >= v7.1.0 20240425-141355/1.3.0-ga3fdd3d

Bluetooth Low Energy (BLU)

Experimental - see documentation for details (Shelly Scripting required)

Adapter version >= v6.8.0 required!

  • Shelly BLU Button and Button Tough 1
  • Shelly BLU Door Window
  • Shelly BLU Motion
  • Shelly BLU H&T

NOT Supported devices

  • Shelly Plus Wall Dimmer US
  • Shelly Plus Plug US
  • Shelly Pro EM 2x50A
  • USB powered UVC LED strip
  • Shelly Plus RGBW PM (shellyplusrgbwpm)
  • Shelly i4 Gen3 (shellyi4g3)
  • Shelly Dimmer Gen3 (shelly0110dimg3)

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 [email protected]

Changelog

WORK IN PROGRESS

  • (imperial929) Added Shelly 1 PM Gen3
  • (imperial929) Added Shelly 1 Gen3
  • (klein0r) Breaking change: Renamed input states (now digital/analog) of Shelly Plus Addon (Ext)
  • (klein0r) Added Shelly Plus Uni
  • (klein0r) Added Shelly H&T (Gen3)
  • (klein0r) Improved structure of ble events (receivedBy) - see documentation for details

7.0.0 (2024-04-29)

NodeJS >= 18.x and js-controller >= 5 is required

  • (klein0r) Added Shelly 1 Mini (Gen3)
  • (svenbluege) Added Shelly 1 PM Mini (Gen3)
  • (klein0r) Added Shelly PM Mini (Gen3)
  • (klein0r) Added Shelly Pro Dimmer 1 PM and Pro Dimmer 2 PM
  • (klein0r) Fixed Shelly Wall Display integration
  • (klein0r) Added device list of ble events (receivedBy) - removed rssi state
  • (klein0r) Added Switch Addon for Shelly Pro 3 EM

6.9.0 (2024-03-12)

  • (klein0r) Added Shelly Plus 0-10V
  • (klein0r) Admin notification for available firmware updates

6.8.0 (2024-02-17)

  • (klein0r) Updated BLE script to 0.2 (new shelly motion firmware)
  • (klein0r) Updated Shelly i3 number limits
  • (klein0r) Added screenshots to instance configuration

6.7.0 (2023-12-22)

  • (klein0r) Updated handling of ble payloads
  • (D1gitaldad) Added Shelly Wall Display

6.6.1 (2023-10-20)

  • (klein0r) Fixed stop reason for Shelly 2.5 / Shelly 2
  • (klein0r) Added humidity of Shelly Plus Addon
  • (klein0r) Not all devices have external power

License

The MIT License (MIT)

Copyright (c) 2018-2024 Thorsten Stueben [email protected], Apollon77 [email protected] and Matthias Kleine [email protected]

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

Integrate your Shelly devices into ioBroker via MQTT or CoIoT

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%