Requires node.js 8.0 or higher and Admin v3!
The adapter communicates with Shelly devices by REST api and the CoAP or MQTT protocol.
By the default Shelly firmware (no flashing of firmware needed!). You will find more and detailed information about the device here : Shelly
If you use the CoAP protocol Shelly devices with Firmware 1.8.0 or above works only with the Shelly Adapter 4.0.0 or above. If you use devices with Firmware below 1.8.0 except of the Shelly 4Pro you have have to use Shelly Adapter 3.3.6 or below. The Shelly Adapter 4.0.0 or above would not work in this case!
Attention, new firmware versions above 1.9.4 you have to enter a CoIoT server fot CoAP. You have to enter the IP address of your ioBroker server followed by the port 5683 on your Shelly device. For example, ioBroker runs on the IP address 192.168.1.2. Now you have to enter 192.168.1.2:5683 and activate CoIoT.
This adapter uses Sentry libraries to automatically report exceptions and code errors to me as the developer. More details see below!
You find a detailed installation documentation here: Installation Documentation
| Shelly Device | CoAP | MQTT |
|---|---|---|
| Shelly1 (SHSW-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly2 (SHSW-21/SHSW-22) | supported since v3.3.0 | supported since v3.3.0 |
| ShellyBulb (SHBLB) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly H&T (SHHT-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Smoke (SHSM-01) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly 1 1PM (SHSW-PM) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly 2.5 (SHSW-25) | supported since v3.3.0 | supported since v3.3.0 |
| ShellyRGBW (SHRGBWW-01) | not supported since v3.4.0 | not supported since v3.4.0 |
| ShellyRGBW2 (SHRGBW2) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly2LED (SH2LED) | supported since v3.3.0 | supported since v3.3.0 |
| ShellyPlug (SHPLG-1) | supported since v3.3.0 | supported since v3.3.0 |
| ShellyPlug S (SHPLG-1) | supported since v3.3.0 | supported since v3.3.0 |
| ShellyPlug 2 (SHPLG-2) | supported since v3.3.0 | supported since v3.3.0 |
| ShellySense (SHSEN-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly4Pro (SHSW-44) | supported since v3.3.5 | supported since v3.3.5 |
| Shelly EM (SHEM) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Flood (SHWT-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Dimmer (SHDM-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Door/Window Sensor (SHDW-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Bulb Duo (SHBDUO-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly 3EM (SHEM | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Vintage (SHVIN-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly I3 (SHIX3-1) | supported since v3.3.0 | supported since v3.3.0 |
| Shelly Button (SHBTN-1) | supported since v3.3.3 | supported since v3.3.3 |
| Shelly Gas (SHGS-1) | supported since v3.3.3 | supported since v3.3.3 |
| Shelly Dimmer 2 (SHDM-2) | supported since v3.3.4 | supported since v3.3.4 |
| Shelly Door/Window Sensor 2 (SHDW-2) | supported since v3.3.5 | supported since v3.3.5 |
| Shelly Uni (SHUNI-1) | supported since v4.0.4 | supported since v4.0.4 |
| Shelly 1L (SHSW-L) | supported since v4.0.5 | supported since v4.0.5 |
| Shelly Color Bulb (SHCB-1) | supported since v4.0.5 | supported since v4.0.5 |
| Shelly Button (SHBTN-2) | supported since v4.0.5 | supported since v4.0.5 |
| Shelly Motion (SHMOS-01) | supported since v4.0.6 | supported since v4.0.6 |
Sentry.io is a way for developers to get an overview about errors from their applications. And exactly this is implemented in this adapter.
When the adapter crashes or an other Code error happens, this error message that also appears in the ioBroker log is submitted to our own Sentry server hosted in Germany. When you allowed ioBroker GmbH to collect diagnostic data then also your installation ID (this is just a unique ID without any additional infos about you, email, name or such) is included. This allows Sentry to group errors and show how many unique users are affected by such an error. All of this helps me to provide error free adapters that basically never crashs.
- (Stübi) - Online Status (beta, does not work correct)
- (Stübi) - Temperature greater min/max - Issue #370
- (Stübi) - fixing the wrong identifier name from green to blue - Issue #334
- (Stübi) - renamed Shelly Motion MQTT name
- (Stübi) - Because polling for battery devices is only permieted every 60 sec., the online state will not supported anymore.
- (Stübi) - Polling for all battery devices changed to 60 sec. This can not be changed to any other value, still if you a power supply.
- (Stübi) - Add state for led light control for Shelly Plug S - Issue #344
- (quedrum) - Shelly1 Garage with ADDon and reed switch - Issue #276
- (Stübi) - add min, max to state transiton for Shelly RGBW2
- (Stübi) - if a property in the returned json for a http request does not exist, it will not shown as an error anymore
- (Stübi) - Bugfixing Shelly 1L
- (klein0r) - Added shelly motion (SHMOS-01)
- (Matze2010) - Add Support for Shelly Uni (SHSW-L)
- (Matze2010) - Shelly 2.5 Roller: Support for favorite positions
- (Stübi) - Bugfixing TypeError in Shelly Plug implementation (Issue #281)
- (Stübi) - Support of Shelly Color Bulb (SHCB-1) - Issue #317
- (Stübi) - Support of Shelly Button 1 (SHBTN-2) - Issue #316, #302, #303
- (Stübi) - add state Total_Returned for Shelly EM3 - Issue #299
- (Stübi) - add state transiton and fade_rate to Shelly Dimmer - Issue #260
- (Stübi) - add state transiton for Shelly RGBW2 - Issue #289
- (Apollon77) update dependencies and shelly-iot lib
- (Stübi) - Bugfix EM3, unit of comsumed power Wh instead of kWH
- (Stübi) - optimize the destroy function (Bugfixing)
- (Stübi) - Bugfixing Relay0.Event error for Shelly I3 in MQTT mode (Issue #241)
- (harrym67) - Shelly 2.5 Roller mode. According to Shelly API: changed existing state swap to swap_input and add state swap.(Issue #240)
- (Stübi) - Allow setting of customer MQTT prefix (Issue #244)
- (harrym67) - Add Support for Shelly Uni (SHUNI-1)
- (harrym67) - Bugfix EM3 (Issue #256)
- (foxriver76) - Bugfix MQTT password check (Issue #264)
- (Stübi) - Add a checkbox, to optionally enable updates of objects even if they have not changed (Issue #209)
- (Stübi) - Calculate temperature fahrenheit for Shelly 1PM and Plug S in MQTT mode
- (Stübi) - Fixed longpush time for MQTT (Shelly 1, 1PM, 2 and 2.5)
- (Stübi) - Add State for changing temperature unit for Shelly HT and DW2
- (Stübi) - Delete external temperature 4 and external humidity 4 states for Shelly 1 and 1PM because they do not exist
- (Stübi) - Renamed state temperature to temperatureC for Shelly 1, 1PM, 2, 2.5, Plug S
- (Stübi) - Add tmperature in Celsius and Fahrenheit for Shelly HT and DW2
- (Stübi) - Bugfixing. Add missing states to MQTT, which exist for CoAP (Shelly 2, 2.5)
- (Stübi) - Polltime for http optimized.
- (Stübi) - removed min and max values for temperature states (Issue #236)
- (Stübi) - Bugfixing. Add timer to Shelly 1, 1PM for CoAP and removed it for MQTT (Shelly 1, 1PM, 2, 2.5) because it is not supported by MQTT
- (Stübi) - Add overpower value to Shelly 1, 1PM, 2, 2.5 and Plug, Plug S
- (Stübi) - Removed channel name from Shelly 4 Pro (Issue #238)
- (Stübi) - Bugfixing Shelly DW2 (Issue #220)
- (Stübi) - Bugfixing manually set object name is overwritten (Issue #224)
- (Stübi) Major Change!! If you use the CoAP protocol only Shelly devices with Firmware 1.8.x or above supported! All devices with Firmware below 1.8.x except Shelly 4Pro will not working with this release!
- Official release to npm/latest
- (Stübi) - Major Change!! If you use the CoAP protocol only Shelly devices with Firmware 1.8.x or above supported! All devices with Firmware below 1.8.x except Shelly 4Pro will not working with this release!
- (@harrym67) - Changing device files
- (Stübi) - Since Firmware 1.8. the Shelly device names like shelly.0.SHBTN-1#A4CF12F454A3#2 ends with #2. It will be changed back to #1 like shelly.0.SHBTN-1#A4CF12F454A3#1.
- (@harrym67) - Add state factoryResetFromSwitch for Shelly 1, 1pm, 2, 2.5, Dimmer, Dimmer 2 and RGBW2
- (@harrym67) - Add states longpushDurationMsMin, longpushDurationMsMax and multipushTimeBetweenPushesMsMax for Shelly IX3
- (@harrym67) - Add state ChannelName for Shelly 1, 1pm, 2, 2.5, Dimmer, Dimmer 2, 4Pro, EM and 3EM
- (@harrym67) - Add state StopReason for Shelly 2 and 2.5 in Shuttermode
- (@harrym67) - Add state name to all Devices (Device Name)
- (Stübi) - Bugfixing temperature for Shelly Dimmer (Issue #201)
- (Stübi) - Tried to fix high CPU load by replacing ping with tpcping (Issue #196, #202)
- (Stübi) - correct spelling mistake for Shelly DW2 (Issue #205)
- (Stübi) - Add Shelly 4 Pro
- (Stübi) - Bugfixing Shelly RGBW2, sate lights.switch color mode
- (Stübi) - Add Shelly DW2
- (Stübi) - Add states longpush and input to Shelly Dimmer 1 (CoAP and MQTT)
- (Stübi) - Add states longpush and input to Shelly Dimmer 2 (CoAP and MQTT)
- (Stübi) - Add states longpush and input to Shelly 1, 1 PM, 2, 2.5 (CoAP)
- (Stübi) - Add state input to Shelly RGBW2 (CoAP)
- (Stübi) - Add state deviceid (Issue #193)
- (Stübi) - Add Shelly Dimmer 2
- (Stübi) - Add states longpush and input to Shelly Dimmer 1 (MQTT)
- (Stübi) - Add states power and energy to Shelly Duo
- (Stübi) - Get power and energy by CoAP instead of http for Shelly 1 PM
- (Stübi) - Bugfixing Shelly Button
- (Stübi) - Bugfixing Shelly 1 humidity MQTT
- (Stübi) - Fixed typo error (external temperature) / Shelly 1, 1 PM
- (Stübi) - Fixed role for external temperature / Shelly 1, 1 PM
- (Stübi) - Changed CoAP concept, because Shelly will change the CoAP payload in one of the future firmware versions. This makes the adjustments later easier.
- (Stübi) - Shelly 4 Pro not supported anymore. If you need it please create an GitHub issue.
- (Stübi) - Shelly RGBW not supported anymore. If you need it please create an GitHub issue .
- (Stübi) - Add Shelly Button
- (Stübi) - Add Shelly Gas
- (Stübi) - Bugfixing Shelly RGBW2
- (Stübi) - Change readme
- (Stübi) - Add state external humidity to Shelly 1 (Bug in 3.3.0)
- (Stübi) - Renamed state color to lights for Shelly RGBW2 - Issue #169
- (Stübi) - Renamed state light to lights for Shelly Dimmer
- (Stübi) - Bugfixng Shelly RGBW, RGBW and Bulb. State ligths.rgbw did not work - Issue #169
- (Stübi) - Use only version with Shelly firmware greater equal v1.7.0 . Shelly firmware less v1.7.0 will not be supported by this Shelly adapter version anymore
- (Stübi) - Add state vibration and tilt to Shelly DW
- (Stübi) - Add polltime to index_m.html
- (Stübi) - Fix RGBW2 with FW 1.7 - Issue #161
- (Stübi) - Add state Button Type for Shelly 1, 1PM, 2, 2.5 - Issue #157
- (Stübi) - Add state Button Reverse for Shelly 1, 1PM, 2, 2.5
- (Stübi) - Add firmware update button
- (Stübi) - Fix auto firmware update
- (Stübi) - Add state external humidity to Shelly 1 / 1PM - Issue #160
- (Stübi) - Add helper library and cleanup source code
- (Stübi) - Add Shelly I3
- (c7j3X) - Add device Shelly Vintage
- (Stübi) - Add state vibration and tilt to Shelly DW
- (Stübi) - User can enable/disable sentry logging
- (Apollon77) - Update Dependencies incl shelly-lib to prevent exceptions
- (Apollon77) - Add Sentry for error/crash reporting (active with js-controller 3.0)
- (Stübi - Add for hue two new datapoints for Shelly Bulb and RGBW2
- (@SamLowrie) - Add option to set a specific multicast interface for CoAP server
- (Stübi) - Bugfixing MQTT ext_temperature for Shelly 1
- (Stübi) - Bugfixing Shelly 3EMfor MQTT support (fixed datapoints for total and total_returned)
- (Stübi) - Bugfixing MQTT support for door and windows sensor (issue #135)
- (Stübi) - Bugfixing, if Shelly sends a string instead of number and boolean (issue #131)
- (Stübi) - Bugfixing Shelly 3EMfor MQTT support
- (Simon W.) - Add device Shelly 3EM
- (Stübi) - Add device Shelly Door/Windows sensor
- (Stübi) - Add external temperature sensor for Shelly 1, 1PM and 2.5 (only CoAP)
- (Stübi) - Bugfixing, auto update new firmware
- (Stübi) - Add state energy to Shelly dimmer
- (Stübi) - Add device Shelly Door/Windows sensor
- (Stübi) - Bugfixing, auto update new firmware
- (Stübi) - Add device Shelly Plug S2. It will be shown as Shelly Plug S (SHPLG-1) in MQTT
- (Stübi) - Bugfixing, auto update new firmware
- (Stübi) - Bugfixing. Add power state to Shelly dimmer in MQTT mode
- (Stübi) - Bugfixing. Error message will not only be shown in debug modus
- (Stübi) - Add device Shelly Dimmer
- (Stübi) - Add device Shelly flood
- (Stübi) - Bugfixing, with the new firmware, Shelly HT sends the humidity by CoAP as it should. Division by 2 removed!
- (Stübi) - Add status Duration in roller (shutter) mode for CoAP (not working with MQTT)
- (Stübi) - Changed role from level to level.brightness for state Gain
- (Stübi) - Add device Shelly EM
- (Stübi) - Add state energy for Shelly Plug S, Shelly PM and Shelly 2.5 in CoAP mode
- (Stübi) - Add state temperature for Shelly Plug S, Shelly PM and Shelly 2.5 in CoAP mode
- (Stübi) - Add state overtemperature for Shelly Plug S, Shelly PM and Shelly 2.5 in CoAP and MQTT mode
- (Stübi) - Bugfixing, the Shelly HT sends by CoAP the humidity multiply with 2. The fix divides the value by 2.
- (Stübi) - correct spelling error
- (Stübi) - Adjust IP address after IP change in CoAP Modus (Issue 70)
- (Stübi) - Bugfixing for datapoint power (rounding method was wrong)
- (Stübi) - Fixed Buffer() is deprecated due to security and usability issues for Node >= 10
- (Stübi) - State reboot and uptime added
- (Stübi) - Bugfixing
- (Stübi) - Add Blacklist
- (Stübi) - Bugfixing (Issue #60)
- (Stübi) - Support of MQTT QoS 1 and 2. Add auto firmware update to the menu
- (Stübi) - Bugfixing and longpush and input states for Shelly 1, 2, 1pm, 2.5 and Shelly RGBWW2 added. Add state temperature to Shelly 1pm, 2.5 and Plug S.
- (Stübi) - Redesign of the adapter. You can choose now between CoAP and MQTT protocol. The Shellys use this protocolls to send there state changes to ioBroker in realtime. Out of the Box the Shelly works with the CoAP protocol. You do not have to configure anything. The Shelly will be found by the Shelly Adapter itself. If you want to use MQTT, you have configure all your Shelly devices. You find a detailed installing documentation here: Installation Documentation. If you have problems with the version 3.0.1 please change back to 2.2.0 and leave an Issue (bug report) here: GitHub Issues.
- Add devices Shelly 2.5 and Shelly 1 PM
- Add status 'firmware update' for Shelly RGBW, RGBW2 and Bulb
- Consider roller (shutter) position in CoAP message
- Support of Shelly Sensor
- Changing all RGBWW2 colors at the same time
- new RGBWW2 State color.rgbw with the format #RRGGBBWW
- Shelly RGBWW2 bug fixing (whit did not work in color mode)
- Shelly Smoke Support
- Bugfixing of Shelly RGBW2 Support. If you have installed version 2.1.3, please delete all RGBW2 objects first, because the objects will be renamed from lights to color and white in version 2.1.4.
- Support of Shelly RGBW2
- New Status 'new firmware available' for Shely1, Shelly2, Shelly4Pro and ShellyPlug
- Bugfixing, polling new Shelly status must be at least 1 sec ago
- Bugfixing for objects AutoTimerOn and AutoTimeroff
- Getting faster online status for Shelly devices, excluded H&T. Fix of power status for Shelly Plug.
- Fixing an error if Shelly device is not reachable (offline)
- Support of js-controller compact mode and performance optimizing. Relay status changes will be shown much faster in ioBroker for Shelly 1, 2 and 4Pro
- Shows RSSI Status for Shelly 1 & 2. You need Firmware 1.4.4
The MIT License (MIT)
Copyright (c) 2018-2020 Thorsten Stueben thorsten@stueben.de, Apollon77 iobroker@fischer-ka.de
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.