Skip to content

More updates to Shelly documentation #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Supported-Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
- [Shelly 1PM](devices/Shelly-1PM.md)
- [Shelly 2](devices/Shelly-2.md)
- [Shelly 2.5](devices/Shelly-2.5.md)
- [Shelly RGBW2](devices/Shelly-RGBW2.md)
- [SK03 Outdoor Smart Plug](devices/SK03-Outdoor-Smart-Plug.md)
- [Teckin SP10 Smart Socket](devices/Teckin-sp10.md)
- [Teckin SP22](devices/Teckin-SP22.md)
Expand Down
28 changes: 17 additions & 11 deletions docs/devices/Shelly-1.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
The Shelly 1 is supported in Tasmota from version 6.2.1.7<br>
# [Shelly 1](https://www.shelly.com/en-us/products/shop/shelly-1-ul)

<img src="https://kb.shelly.cloud/__attachments/57049089/Shelly-1-front.jpg" width="250" align="right" />
The Shelly 1 is supported in Tasmota from version 6.2.1.7

* [Allterco Shelly 1 Product Page](https://shelly.cloud/shelly1-open-source/)
* [Allterco Shelly 1 Shop](https://shelly.cloud/product/shelly-1-open-source/)
[Shelly 1 Knowledge Base](https://kb.shelly.cloud/knowledge-base/shelly-1)

[Shelly 1 API Reference](https://shelly-api-docs.shelly.cloud/gen1/#shelly1-shelly1pm)

<img src="https://kb.shelly.cloud/__attachments/60424193/shelly1.png" width="250" align="right" />

# Flashing
There are two options to get tasmota onto your shelly:
1) OTA update with an intermediate firmware (preferred - can be done in an already installed state)
2) The common way using a serial adapter. DO NOT DO THIS WHEN CONNECTED TO AC MAINS!
There are two options to get Tasmota onto your Shelly:

1. OTA update with an intermediate firmware (preferred - can be done in an already installed state)
1. The common way using a serial adapter. DO NOT DO THIS WHEN CONNECTED TO AC MAINS!

## OTA Update
Follow the guide from this repository: <https://github.com/arendst/mgos-to-tasmota>

## ⚠️️Special Shelly Attention⚠️️

**DO NOT CONNECT ANYTHING TO ANY GPIOs OF THESE DEVICES!!! (No sensors, no switches, nothing) <br>
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.

**There is possibility to attach DS18B20 or other sensors BUT only using Digital Voltage Isolator**
For example the company sells [Temperature Sensor AddOn for Shelly 1/1PM](https://shop.shelly.cloud/temperature-sensor-addon-for-shelly-1-1pm-wifi-smart-home-automation#312) with DS18B20. This should not fool you, **never ever attach any sensor directly to the GPIOs** - this expansion board uses TexasInstruments ISO7221 for voltage isolation. More information and Tasmota support for the extension board at <https://github.com/arendst/Tasmota/issues/7469>.
Expand All @@ -32,16 +36,18 @@ An ESP8266 with 2MB flash single relay device 42mm "round" in size.
## Serial Connection
Shelly1 comes with a partially exposed programming/debug header which can be used to flash Tasmota on the device. A serial-to-USB adapter is needed as well as a reliable 3.3V source with at least 350 mA drive capability. The following diagram shows the device pinout.

<img src="https://kb.shelly.cloud/__attachments/57049089/Gen1-addon-interface.png" height="250" />
<img src="https://kb.shelly.cloud/__attachments/237502485/Gen1-addon-interface.png" height="250" />

## Flash mode
To be able to flash the Tasmota firmware you need to get into flash mode. Therefore connect a wire from GPIO0 to ground. For further information have a look at [Hardware Preparation](../Getting-Started#programming-mode).

## **⚠️️WARNING⚠️️**
Please note what version of the Shelly 1 you have (V1, V2 or V3). The V2 user guide is [incorrect](https://gallery.mailchimp.com/0d9bf8d9ddf1b29f33cb71ba5/images/cb16c7b5-5887-4ef2-b6c1-6e90ccaf648a.png?mc_cid=0a274764f3&mc_eid=05c10a130f). The labels on the V2 switches are **WRONG!** The following image shows how to connect the device to mains power.
Please note what version of the Shelly 1 you have (V1, V2 or V3). The V2 user guide is incorrect. The labels on the V2 switches are **WRONG!** The following image shows how to connect the device to mains power.

![Basic Wiring](https://kb.shelly.cloud/__attachments/243531777/1%20AC%20wiring%20diagram.png?inst-v=c5a6a296-4215-467c-94e2-cd19f02ebcf8)

![wrong](https://gallery.mailchimp.com/0d9bf8d9ddf1b29f33cb71ba5/images/cb16c7b5-5887-4ef2-b6c1-6e90ccaf648a.png?mc_cid=0a274764f3&mc_eid=05c10a130f)
## Video tutorial by digiblurDIY
[![](http://img.youtube.com/vi/mSENAY9_AlI/0.jpg)](http://www.youtube.com/watch?v=mSENAY9_AlI "")

### Video tutorial by BurnsHA
[![](http://img.youtube.com/vi/O5MT5t1DT6A/0.jpg)](http://www.youtube.com/watch?v=O5MT5t1DT6A "")
15 changes: 9 additions & 6 deletions docs/devices/Shelly-1PM.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# [Shelly 1PM](https://www.shelly.com/en-us/products/shop/shelly-1pm-ul)

The Shelly 1PM is supported from Tasmota 6.5.0.10 using a template.

<img src="https://shelly.cloud/wp-content/uploads/2019/02/shelly1pm_thumb.png" width="250" align="right" />
[Shelly 1PM Knowledge Base](https://kb.shelly.cloud/knowledge-base/shelly-1pm)

[Shelly 1PM API Reference](https://shelly-api-docs.shelly.cloud/gen1/#shelly1-shelly1pm)

* [Allterco Shelly 1PM Product Page](https://shelly.cloud/shelly-1pm-wifi-smart-relay-home-automation/)
* [Allterco Shelly 1PM Shop](https://shelly.cloud/product/wifi-smart-home-automation-shelly-1pm-switch-relay/)
<img src="https://www.shelly.com/_Resources/Persistent/4/7/8/1/478161c97b76a75a2693da49f2772c01ad2cd4e0/Shelly_1PM_x1-1200x1200.webp" width="250" align="right" />

## ⚠️️Special Shelly Attention⚠️️

**DO NOT CONNECT ANYTHING TO ANY GPIOs OF THESE DEVICES!!! (No sensors, no switches, nothing) <br>
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.

**Do not connect AC power and the serial connection at the same time**
The GND connection of the Shelly is connected to the live AC wire. Connecting serial with your PC will fry your PC.
Expand All @@ -20,7 +23,7 @@ Shelly 1PM comes with a partially exposed programming/debug header which can be

<img src="https://raw.githubusercontent.com/arendst/arendst.github.io/master/media/shelly/shelly1pm-pinout-812x400.png" height="250" />

## Template
## Template
```
{"NAME":"Shelly 1PM","GPIO":[56,0,0,0,82,134,0,0,0,0,0,21,0],"FLAG":2,"BASE":18}
```
Expand All @@ -34,4 +37,4 @@ PowerSet 60.00
VoltageSet 240.0
CurrentSet 250.0
```
Pause a few seconds between executing the commands as the communication between Tasmota and the Energy Monitoring chip is a serial interface which can take over a second to complete.
Pause a few seconds between executing the commands as the communication between Tasmota and the Energy Monitoring chip is a serial interface which can take over a second to complete.
34 changes: 18 additions & 16 deletions docs/devices/Shelly-2.5.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# [Shelly 2.5](https://www.shelly.com/en/products/shop/shelly-2-5-ce-ul-1)


The Shelly 2.5 is supported from Tasmota 6.5.0.8 using a template.

<img src="https://shelly.cloud/wp-content/uploads/2020/06/shelly25.jpg" width="250" align="right" />
[Shelly 2.5 Knowledge Base](https://kb.shelly.cloud/knowledge-base/shelly-2-5)

[Shelly 2.5 API Reference](https://shelly-api-docs.shelly.cloud/gen1/#shelly2-5)

[Shelly 2.5 Initial issue](https://github.com/arendst/Tasmota/issues/5592)

<img src="https://www.shelly.com/_Resources/Persistent/a/d/f/3/adf3a6866d34f9195f7c018cc4d8793c75a59fbd/108%5B72%5D-1250x1250.webp" width="250" align="right" />

* [Allterco Shelly 2.5 Product Page](https://shelly.cloud/shelly-25-wifi-smart-relay-roller-shutter-home-automation/)
* [Allterco Shelly 2.5 Shop](https://shelly.cloud/product/wifi-smart-home-automation-shelly-25-switch-relay-roller-shutter/)
* [Shelly 2.5 Initial issue](https://github.com/arendst/Tasmota/issues/5592)

## ⚠️️Special Shelly Attention⚠️️

**DO NOT CONNECT ANYTHING TO ANY GPIOs OF THESE DEVICES!!! (No sensors, no switches, nothing)
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.
**DO NOT CONNECT ANYTHING TO ANY GPIOs OF THESE DEVICES!!! (No sensors, no switches, nothing)
The GPIOs on the Shelly are connected to AC power!** Only use a Shelly as designed.

**Do not connect AC power and the serial connection at the same time**
The GND connection of the Shelly is connected to the live AC wire. Connecting serial with your PC will fry your PC.

# [Shelly 2.5](https://shelly.cloud/shelly-25-wifi-smart-relay-roller-shutter-home-automation/)
> [!WARNING]**[Warning](https://www.facebook.com/groups/ShellyIoTCommunitySupport/permalink/2029876037111750/) (April 10, 2019):** _This appears to affect a percentage of their entire first run production. **Check your device before powering it on.**_
**[Warning](https://www.facebook.com/groups/ShellyIoTCommunitySupport/permalink/2029876037111750/) (April 10, 2019):** This appears to affect a percentage of their entire first run production. **Check your device before powering it on.**

An ESP8266 with 2MB flash dual relay device with Energy Monitoring. Slightly smaller than the original Shelly 2.

## Serial Connection

The Shelly 2.5 model comes with a partially exposed programming/debug header which can be used to flash Tasmota on the device. A USB-to-UART adapter is needed as well as a reliable 3.3V with at least 350 mA drive capability. The following diagram shows the device pinout and power source voltage selection jumper.

<img src="https://shelly.cloud/wp-content/uploads/2020/06/pin_out.png" height="250" />
<img src="https://kb.shelly.cloud/__attachments/237502485/2.5-addon-interface.png?inst-v=c5a6a296-4215-467c-94e2-cd19f02ebcf8" height="250" />

The onboard connector is 1.27mm raster with 1mm diameter holes. Normal Dupont cables won't fit. To avoid damaging the pcb, use either a stripped 24 AWG Ethernet cable and breadboard as an adapter, or female header socket legs (see image below). The legs of a female header socket fit nicely. Solder them to custom-crimped Dupont wires for use with your USB-to-UART adapter. These often come with Wemos D1 Mini boards in multiple lengths.

Expand All @@ -36,7 +38,7 @@ Otherwise you could simply buy an adapter that converts Dupont to 1.27mm raster
[tindie](https://www.tindie.com/products/21512/)

## Template
Tasmota 6.5.0.8 and higher supports Shelly 2.5
Tasmota 6.5.0.8 and higher supports Shelly 2.5

| GPIO | Component |
| -- | -- |
Expand All @@ -51,11 +53,11 @@ Tasmota 6.5.0.8 and higher supports Shelly 2.5
| 16 | ADE7953 IRQ
| A0 | Internal Temperature

`{"NAME":"Shelly 2.5","GPIO":[56,0,17,0,21,83,0,0,6,82,5,22,156],"FLAG":2,"BASE":18}`
`{"NAME":"Shelly 2.5","GPIO":[56,0,17,0,21,83,0,0,6,82,5,22,156],"FLAG":2,"BASE":18}`

Energy metering is done by an ADE7953 chip connected via I2C and IRQ on GPIO16.

If you connect momentary switches, use the following template:
If you connect momentary switches, use the following template:
`{"NAME":"Shelly 2.5 (buttons)","GPIO":[56,0,19,0,21,127,0,0,6,126,5,22,156],"FLAG":2,"BASE":18}`
`Button1` and `Button2` are assigned to the SW1 and SW2 external inputs. `Button3` is the button on the back of the device next to the pin header and you can optionally assign the behaviour you want using rules.

Expand All @@ -70,7 +72,7 @@ To be able to flash the Tasmota firmware you need to get into flash mode. Theref
## Calibration
Tasmota will disable serial logging after a restart as the communication between Tasmota and the Energy Monitoring chip is using the same serial interface. Make sure not to enable `SerialLog` as it will interfere with the Energy Monitoring functionality.

To calibrate the Energy monitoring feature connect a known load and execute the commands shown below. Assumed an AC voltage of 240V, a resistive load of 60W and a line frequency of 50Hz. With a load of 60W the current should be 60W / 240V = 0.25A.
To calibrate the Energy monitoring feature connect a known load and execute the commands shown below. Assumed an AC voltage of 240V, a resistive load of 60W and a line frequency of 50Hz. With a load of 60W the current should be 60W / 240V = 0.25A.
```
FrequencySet 50.000
PowerSet 60.00
Expand Down Expand Up @@ -107,15 +109,15 @@ Use command `SwitchDebounce 100` to change it to a less sensitive value, which m
Some issues were reported for this topic - [search query](https://github.com/arendst/Tasmota/issues?utf8=%E2%9C%93&q=ghost+shelly)


## Overheating
## Overheating

Due to the built-in temperature sensor, it is possible to switch off the relays when a certain temperature is exceeded. The limit for the original Shelly firmware seems to be around 95 ° C. [Source](https://www.shelly-support.eu/lexikon/index.php?entry/1-shelly-2-5/)

The ambient temperature according to the manufacturer is between - 40 ° C up to 40 ° C

Even at temperatures within this range, a significantly higher temperature can occur when installed behind switches or in walls. There are reports that temperature-related shutdowns occur at high loads.
A standby temperature between 30-60 ° C seems normal.
An overtemperature threshold is implemented in the Tasmota firmware.
An overtemperature threshold is implemented in the Tasmota firmware.
!!! note
It is set to 90 ° C

Expand Down
3 changes: 2 additions & 1 deletion docs/devices/Shelly-RGBW2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<img src="https://kb.shelly.cloud/__attachments/229146742/image-20220920-071244.png?inst-v=37db5b47-02b4-47d2-9c77-9f9b8a60a4f2" width="250" align="right" />

An ESP8266 with 2MB flash LED Controller.

- Supports any 12v or 24v White, RGB, or RGBW led strips and 12/24v led bulbs, with up to 288W combined power
- Supports four-way PWM, applied to control four colors LED(R/G/B/W) for colored lights, color temperature lights, and general lights
- A separate 12V/24V power supply unit is required
Expand Down Expand Up @@ -126,7 +127,7 @@ It may be necessary to calculate the Analog CT Multiplier value. Generally 3282

As described in [AC Frequency Detection Switch](../Buttons-and-Switches.md#ac-frequency-detection-switch) section, the adapter sends pulses (by shorting red wire to GND), when AC voltage is present between the two black wires.

Shelly RGBW2 has an onboard pull-up resistor to 3.3V. To make it work correctly, set **GPIO5** to `Switch_n` mode. Then use the ['SwitchDebounce'](Commands.md#switchdebounce) command to set the number of pulses required for the switch to be recognized as on or off. For example, `SwitchDebounce 69`.
Shelly RGBW2 has an onboard pull-up resistor to 3.3V. To make it work correctly, set **GPIO5** to `Switch_n` mode. Then use the ['SwitchDebounce'](../Commands.md#switchdebounce) command to set the number of pulses required for the switch to be recognized as on or off. For example, `SwitchDebounce 69`.


## Use Rules to Control Both Switches
Expand Down