Skip to content

Commit 8b6c278

Browse files
blakadderblakadder
committed
ch-ch-ch-ch-chaaaanges
1 parent bf1f8a7 commit 8b6c278

37 files changed

+591
-351
lines changed

‎Expanding-Tasmota.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
You can wire peripherals (sensors, displays, switches, LED lights, ...) to available pins of the [ESP8266](https://en.wikipedia.org/wiki/ESP8266) chip that controls these devices.
22

33
> To make a link between the different naming schemes the [Pin Definition overview](https://github.com/esp8266/esp8266-wiki/wiki/Pin-definition) in the ESP8266 wiki is quite helpful.
4+
45
## Examples
56
#### Connect switch
67
If you take a Sonoff Basic and connect a switch between pin4 (GND) and pin5 (GPIO14) of the 5 pin programming header you now have a second switch connected to the device. You can set this through the module config page as option `Switch1 (9)` or from the command line with `gpio14 9`.
@@ -19,18 +20,24 @@ R3 | 4 | 3.3V
1920

2021
You can then plug a sensor into the jack like you would to a [Sonoff TH](Sonoff-TH) and define what sensor you have connected to GPIO14.
2122

22-
# :red_circle: Restrictions
23+
24+
# Restrictions
25+
> [!DANGER]
2326
2427
If you can avoid it, don't use GPIOs: **0, 1, 2, 6-11, 15 and 16**. That leaves **4, 5, 12, 13, 14** as GPIOs without any constraints. **3** being RX is also good to avoid (PWM is not working on this GPIO).
2528

2629
Others ***can*** be used but you have to mind the constraints outlined in [this document](https://tttapa.github.io/ESP8266/Chap04%20-%20Microcontroller.html).
2730

28-
## :red_circle: Voltage and Current
31+
## Voltage and Current
32+
> [!DANGER]
33+
2934
The ESP8266 is a 3.3V microcontroller, so its I/O operates at 3.3V as well. The pins are **not** 5V tolerant, applying more than 3.6V on any pin will release the [magic smoke](https://en.wikipedia.org/wiki/Magic_smoke) (fry the chip).
3035

3136
The maximum current that can be drawn from a single GPIO pin is 12mA.
3237

33-
## :red_circle: Power Supply
38+
## Power Supply
39+
> [!DANGER]
40+
3441
The [power supplied to the device](https://www.letscontrolit.com/wiki/index.php?title=Power) is **one of the most important elements** for stable device operation. Many devices on the market have barely adequate power supplies for normal operation. ***Connected peripherals may strain the ability of the power supply on the device to deliver appropriate power to all the components, both on-board as well as externally connected.***
3542

3643
Voltage regulation issues typically result in fatal exception [fault code](https://github.com/esp8266/Arduino/blob/master/doc/exception_causes.rst) `1`. You must ensure that the device receives sufficient power (current **and** appropriate voltage level). Take into account the current that each wired component (f.e. sensor) will draw from the device itself.
@@ -54,7 +61,8 @@ Shielding or using twisted pair wiring are other ways to reduce the effect of ra
5461
[Example for 10K Resistor](https://user-images.githubusercontent.com/35574450/39960640-8b2735ca-5626-11e8-8128-461b6d9976ad.png)
5562
(issue[#2708](https://github.com/arendst/Tasmota/issues/2708#issuecomment-388574891))
5663

57-
# The ESP8266 [Hardware](https://tttapa.github.io/ESP8266/Chap04%20-%20Microcontroller.html)
64+
# The ESP8266 Hardware
65+
Complete document available from https://tttapa.github.io/ESP8266/Chap04%20-%20Microcontroller.html
5866
## Digital I/O
5967
Just like a normal Arduino, the ESP8266 has digital input/output pins (I/O or GPIO, General Purpose Input/Output pins). As the name implies, they can be used as digital inputs to read a digital voltage, or as digital outputs to output either 0V (sink current) or 3.3V (source current).
6068

‎README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This is the repo for documentation of the Tasmota open source alternative firmwa
33

44
## Editing Files
55

6-
Use strict markdown syntax
6+
Use normal markdown syntax with some enhancements
77

88
## Enhancements
99

@@ -66,3 +66,22 @@ Ciao!
6666
<!-- tabs:end -->
6767
```
6868

69+
## Shields color codes
70+
71+
I2C:
72+
<img src="https://img.shields.io/static/v1?label=&message=i2c&color=blue" style="float:right"> </img>
73+
74+
GPIO:
75+
<img src="https://img.shields.io/static/v1?label=&message=gpio&color=purple" style="float:right"> </img>
76+
77+
ADC:
78+
<img src="https://img.shields.io/static/v1?label=&message=adc&color=orange" style="float:right"> </img>
79+
80+
Serial:
81+
<img src="https://img.shields.io/static/v1?label=&message=serial&color=seagreen" style="float:right"> </img>
82+
83+
Serial:
84+
<img src="https://img.shields.io/static/v1?label=&message=spi&color=slategrey" style="float:right"> </img>
85+
86+
Tuya:
87+
<img src="https://img.shields.io/static/v1?label=&message=tuya&color=orangered" style="float:right"> </img>

‎Sensor-Configuration.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
> Read before continuing:
2-
> &emsp;- [Components](Components)
3-
> &emsp;- [Expanding Tasmota](Expanding-Tasmota)
1+
?> Read before continuing:
2+
&emsp;- [Components](Components)
3+
&emsp;- [Expanding Tasmota](Expanding-Tasmota)
44

5-
_**A peripheral must have correctly wired power, GND and data pins to the device prior to booting in order for Tasmota to detect it and initialize it properly.**_
5+
> [!WARNING]
6+
>A peripheral must have correctly wired power, GND and data pins to the device prior to booting in order for Tasmota to detect it and initialize it properly.
67
7-
## Configuration in Tasmota
8-
Tasmota allows for easy selection of peripherals (sensors, switches, etc) and configuration to GPIO pins.
8+
## Tasmota Settings
9+
<img src="https://user-images.githubusercontent.com/5904370/68432161-2a154700-01b4-11ea-8ba9-adb7b717490d.png" style="float:right;height:15em;margin:10px 0">
10+
Tasmota allows for easy selection of peripherals (sensors, switches, etc) and assignment to GPIO pins.
911

10-
Configuration is possible in the webUI ***Configuration - Configure Module*** page:
11-
![image](https://user-images.githubusercontent.com/5904370/68432161-2a154700-01b4-11ea-8ba9-adb7b717490d.png)
12+
Configuration is possible in the webUI ***Configuration - Configure Module*** page
1213

1314
or by using commands: [`Module`](Commands#module) and [`GPIO`](Commands#gpio), or [`Template`](Commands#template).
1415

15-
#### [`Module`](Commands#module)
16+
**[`Module`](Commands#module)**
1617
First select desired module for the device (Wait for the restart). Depending on the type of [Module](Modules), only certain GPIO pins are user configurable. Module Generic (18) has all the GPIOs configurable.
1718

1819
_[`Modules`](Commands#modules) shows supported modules_
1920

20-
#### [`GPIO`](Commands#gpio)
21+
**[`GPIO`](Commands#gpio)**
2122
Assign a [component](Components) to a GPIO.
2223

2324
- `gpio14 2` configures sensor AM2301 to GPIO14_
@@ -28,7 +29,7 @@ _[`Gpios All`](Commands#gpios) shows list of all available components by name an
2829

2930
**For a peripheral to show up you may need to power cycle your device instead of a soft restart.**
3031

31-
#### [`Template`](Commands#template)
32+
**[`Template`](Commands#template)**
3233
Instead of using `Module` and `GPIO` you can define all using `Template` [Read more...](Templates#template-configuration-with-commands)
3334

3435
## Additional Options

‎Zigbee.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,27 @@ Before using Zigbee to Tasmota, you need to understand a few concepts. Here is a
2020
### Zigbee Adapter
2121
**You cannot use any CC2531 based device with Tasmota!**. CC2531 supports USB communication and not serial communication required by Zigbee2Tasmota.
2222

23-
|Device |Notes|
24-
|---|---|
25-
|**[CC2530 with PCB antenna, DL-20](https://www.aliexpress.com/item/32904763478.html)**<BR>[<img src="https://user-images.githubusercontent.com/34340210/67676080-29301a00-f957-11e9-8799-c819241e0b4c.png" width="240">](https://user-images.githubusercontent.com/34340210/67676080-29301a00-f957-11e9-8799-c819241e0b4c.png "CC2530 DL-20 Pin-outs")|Compact and cheap, but with limited range.|
26-
|**[CC2530 with external antenna](https://www.aliexpress.com/item/33007098493.html)**<BR><img src="https://user-images.githubusercontent.com/49731213/64906209-c0ad1680-d6e3-11e9-8703-71ea36c5be72.jpg" width="240"><BR>or<BR><img src="https://user-images.githubusercontent.com/49731213/64913622-eec24300-d743-11e9-9416-0b19a4cbc3c4.jpg" width="240">|Better range.|
27-
|**[CC2530 with external antenna and CC2591 RF front end](https://www.aliexpress.com/item/4000118023903.html)**<BR><img src="https://user-images.githubusercontent.com/49731213/64906219-f0f4b500-d6e3-11e9-8cd0-e135af531718.jpg" width="240">|Best range.<BR>Please note you need a specific firmware for CC2591 frontend.|
23+
<table style="text-align:center; width: 80%;">
24+
<col style="width:30%">
25+
<col style="width:30%">
26+
<col style="width:30%">
27+
<tr>
28+
<th><a href="https://www.aliexpress.com/item/32904763478.html"> CC2530 with PCB antenna, DL-20</a></th>
29+
<th><a href="https://www.aliexpress.com/item/33007098493.html">CC2530 with external antenna</a></th>
30+
<th><a href="https://www.aliexpress.com/item/4000118023903.html">CC2530 with external antenna and CC2591 RF front end</a></th>
31+
</tr>
32+
<tr>
33+
<td>
34+
<img src="https://user-images.githubusercontent.com/34340210/67676080-29301a00-f957-11e9-8799-c819241e0b4c.png" style="width:10em"></img>
35+
</td>
36+
<td>
37+
<img src="https://user-images.githubusercontent.com/49731213/64906209-c0ad1680-d6e3-11e9-8703-71ea36c5be72.jpg" style="width:10em"></img>
38+
</td>
39+
<td>
40+
<img src="https://user-images.githubusercontent.com/49731213/64906219-f0f4b500-d6e3-11e9-8cd0-e135af531718.jpg" style="width:10em"></img>
41+
</td>
42+
</tr>
43+
</table>
2844

2945
### Wi-Fi Adapter
3046
Using an ESP82xx device such as a Wemos D1 Mini or a NodeMCU to flash the CC2530 (described below) is a lower cost alternative than using a single purpose [CC_DEBUGGER](https://www.aliexpress.com/item/32869263224.html). When in normal operation, this ESP82xx device can then also serve as the Wi-Fi adapter for the Zigbee2Tasmota messaging.

‎_coverpage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
[Documentation](Home)
14-
[Get started!](/installation/)
14+
[Get Started!](/installation/)
1515
[GitHub](https://github.com/arendst/Tasmota)
1616

1717

‎_sidebar.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
* **Features**
22
* [Upgrading](Upgrading)
33
* [MQTT](MQTT)
4-
* [Commands](Commands)
5-
* [Templates](Templates)
6-
* [Modules](Modules)
7-
* [Components](Components)
8-
* [Rules](Rules)
9-
* [Scripting](Scripting-Language)
10-
* [Timers](Timers)
11-
* [Buttons and Switches](Buttons-and-Switches)
12-
* [Lights](Lights)
13-
* [Status LEDs](Status-LED)
14-
* [TuyaMCU](TuyaMCU)
15-
* [Smart Home Integrations](/integrations/)
16-
* [Peripherals](/peripherals/)
4+
* [Commands](Commands)
5+
* [Templates](Templates)
6+
* [Modules](Modules)
7+
* [Components](Components)
8+
* [Rules](Rules)
9+
* [Scripting](Scripting-Language)
10+
* [Timers](Timers)
11+
* [Buttons and Switches](Buttons-and-Switches)
12+
* [Lights](Lights)
13+
* [Status LEDs](Status-LED)
14+
* [TuyaMCU](TuyaMCU)
15+
* [Smart Home Integrations](/integrations/)
16+
* [Peripherals](/peripherals/)
1717
* [Zigbee](Zigbee)
18-
* [Displays](Displays)
19-
* [Blinds and Shutters](Blinds-and-Shutters)
20-
* [Power Monitoring Calibration](Power-Monitoring-Calibration)
21-
* [TLS](TLS)
22-
* [Web UI](WebUI)
23-
* [Supported Modules](/devices/)
24-
* **Useful Topics**
25-
* [Cool Projects](Cool-Projects)
26-
* [Securing Your Setup](Securing-your-IoT-from-hacking)
27-
* [Tutorials](Tutorials)
28-
* [Energy Saving](Energy-Saving)
29-
* [Theo'sTips](Tips)
30-
* [What's New!](What's-New)
31-
* [How to Contribute?](Contributing)
32-
* [For Developers](For-Developers)
18+
* [Displays](Displays)
19+
* [Blinds and Shutters](Blinds-and-Shutters)
20+
* [Power Monitoring Calibration](Power-Monitoring-Calibration)
21+
* [TLS](TLS)
22+
* [Web UI](WebUI)
23+
* [Supported Modules](/devices/)
24+
**Useful Topics**
25+
* [Cool Projects](Cool-Projects)
26+
* [Securing Your Setup](Securing-your-IoT-from-hacking)
27+
* [Tutorials](Tutorials)
28+
* [Energy Saving](Energy-Saving)
29+
* [Theo'sTips](Tips)
30+
* [What's New!](What's-New)
31+
* [How to Contribute?](Contributing)
32+
* [For Developers](For-Developers)

‎devices/_sidebar.md

+57-57
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,57 @@
1-
* **Supported Modules**
2-
* [Sonoff 4CH](devices/Sonoff-4CH)
3-
* [Sonoff 4CH Pro](devices/Sonoff-4CH-Pro)
4-
* [Sonoff 4CH DIY](devices/Sonoff-4CH-DIY)
5-
* [Sonoff B1 / B1 R2](devices/Sonoff-B1)
6-
* [Sonoff Basic](devices/Sonoff-Basic)
7-
* [Sonoff Basic R3](devices/Sonoff-DIY)
8-
* [Sonoff Dual](devices/Sonoff-Dual)
9-
* [Sonoff Dual R2](devices/sonoff-dual-R2)
10-
* [Sonoff iFan02](devices/Sonoff-iFan02)
11-
* [Sonoff iFan03](devices/Sonoff-iFan03)
12-
* [Sonoff Mini](devices/Sonoff-Mini)
13-
* [Sonoff Pow](devices/sonoff-pow)
14-
* [Sonoff Pow R2](devices/sonoff-Pow-R2)
15-
* [Sonoff PSA](devices/Sonoff-PSA)
16-
* [Sonoff RF](devices/sonoff-RF)
17-
* [Sonoff RF R3](devices/Sonoff-RF-R3)
18-
* [Sonoff RF Bridge 433](devices/Sonoff-RF-Bridge-433)
19-
* [Sonoff S20 Smart Socket](devices/sonoff-S20)
20-
* [Sonoff S26 Smart Socket](devices/Sonoff-S26-Smart-Socket)
21-
* [Sonoff S31](devices/sonoff-S31)
22-
* [Sonoff SC](devices/sonoff-SC)
23-
* [Sonoff Slampher](devices/Sonoff-Slampher)
24-
* [Sonoff SV](devices/sonoff-SV)
25-
* [Sonoff T1](devices/Sonoff-T1)
26-
* [Sonoff Touch](devices/Sonoff-Touch)
27-
* [Sonoff TH](devices/sonoff-TH)
28-
* [Arilux LC02](devices/Arilux-LC02)
29-
* [Armtronix Dimmers](devices/Armtronix-Dimmers)
30-
* [Blitzwolf BW-SHP2](devices/blitzwolf-SHP2)
31-
* [Blitzwolf BW-SHP4](devices/BlitzWolf-BW-SHP4-(UK-Version))
32-
* [Blitzwolf BW-SHP6](devices/blitzwolf-SHP6)
33-
* [Digoo DG-SP202](devices/Digoo-DG-SP202)
34-
* [Geekcreit 2CH](devices/Geekcreit-Sonoff-2-Channel-Relay-(AC-85V-250V))
35-
* [Gosund SP1](devices/Gosund-SP1)
36-
* [H801 LED Controller](devices/H801)
37-
* [HuaFan Smart Socket](devices/HuaFan-Smart-Socket)
38-
* [Luminea LED Controller](devices/Luminea-ZX-2844-675-(RGBW-LED-Controller))
39-
* [MagicHome LED Controller (ESP-12S/ESP-2M)](devices/MagicHome-LED-strip-controller)
40-
* [MagicHome LED Controller (ESP8285)](devices/MagicHome-with-ESP8285)
41-
* [Mi Desk Lamp](devices/Xiaomi-Mi-Desk-Lamp)
42-
* [PS-16-DZ Dimmer](devices/PS-16-DZ-Dimmer)
43-
* [OBI Socket](devices/OBI-Wifi-Socket)
44-
* [OBI Socket 2](devices/OBI-Socket-2)
45-
* [OBI Socket IP44 (Black)](devices/OBI-WiFi-Socket-IP44)
46-
* [Shelly 1](devices/shelly-1)
47-
* [Shelly 1PM](devices/shelly-1PM)
48-
* [Shelly 2](devices/shelly-2)
49-
* [Shelly 2.5](devices/shelly-2.5)
50-
* [SK03 Outdoor Smart Plug](devices/SK03-Outdoor-Smart-Plug)
51-
* [Teckin SP10 Smart Socket](devices/Teckin-sp10)
52-
* [Teckin SP22](devices/Teckin-sp22)
53-
* [YTF IR Bridge](devices/ytf-ir-bridge)
54-
* [WT003-EU 4 AC + 4 USB Outlet Tuya Power Strip EU](https://github.com/arendst/Tasmota/pull/4590)
55-
* [Wemos D1 R1 & R2](devices/Wemos-D1-R1-&-R2)
56-
* [Wemos D1 Mini](devices/Wemos-D1-Mini)
57-
* [Other Devices](devices/Other-Devices)
1+
**Supported Modules**
2+
[Sonoff 4CH](devices/Sonoff-4CH)
3+
[Sonoff 4CH Pro](devices/Sonoff-4CH-Pro)
4+
[Sonoff 4CH DIY](devices/Sonoff-4CH-DIY)
5+
[Sonoff B1 / B1 R2](devices/Sonoff-B1)
6+
[Sonoff Basic](devices/Sonoff-Basic)
7+
[Sonoff Basic R3](devices/Sonoff-DIY)
8+
[Sonoff Dual](devices/Sonoff-Dual)
9+
[Sonoff Dual R2](devices/sonoff-dual-R2)
10+
[Sonoff iFan02](devices/Sonoff-iFan02)
11+
[Sonoff iFan03](devices/Sonoff-iFan03)
12+
[Sonoff Mini](devices/Sonoff-Mini)
13+
[Sonoff Pow](devices/sonoff-pow)
14+
[Sonoff Pow R2](devices/sonoff-Pow-R2)
15+
[Sonoff PSA](devices/Sonoff-PSA)
16+
[Sonoff RF](devices/sonoff-RF)
17+
[Sonoff RF R3](devices/Sonoff-RF-R3)
18+
[Sonoff RF Bridge 433](devices/Sonoff-RF-Bridge-433)
19+
[Sonoff S20 Smart Socket](devices/sonoff-S20)
20+
[Sonoff S26 Smart Socket](devices/Sonoff-S26-Smart-Socket)
21+
[Sonoff S31](devices/sonoff-S31)
22+
[Sonoff SC](devices/sonoff-SC)
23+
[Sonoff Slampher](devices/Sonoff-Slampher)
24+
[Sonoff SV](devices/sonoff-SV)
25+
[Sonoff T1](devices/Sonoff-T1)
26+
[Sonoff Touch](devices/Sonoff-Touch)
27+
[Sonoff TH](devices/sonoff-TH)
28+
[Arilux LC02](devices/Arilux-LC02)
29+
[Armtronix Dimmers](devices/Armtronix-Dimmers)
30+
[Blitzwolf BW-SHP2](devices/blitzwolf-SHP2)
31+
[Blitzwolf BW-SHP4](devices/BlitzWolf-BW-SHP4-(UK-Version))
32+
[Blitzwolf BW-SHP6](devices/blitzwolf-SHP6)
33+
[Digoo DG-SP202](devices/Digoo-DG-SP202)
34+
[Geekcreit 2CH](devices/Geekcreit-Sonoff-2-Channel-Relay-(AC-85V-250V))
35+
[Gosund SP1](devices/Gosund-SP1)
36+
[H801 LED Controller](devices/H801)
37+
[HuaFan Smart Socket](devices/HuaFan-Smart-Socket)
38+
[Luminea LED Controller](devices/Luminea-ZX-2844-675-(RGBW-LED-Controller))
39+
[MagicHome LED Controller (ESP-12S/ESP-2M)](devices/MagicHome-LED-strip-controller)
40+
[MagicHome LED Controller (ESP8285)](devices/MagicHome-with-ESP8285)
41+
[Mi Desk Lamp](devices/Xiaomi-Mi-Desk-Lamp)
42+
[PS-16-DZ Dimmer](devices/PS-16-DZ-Dimmer)
43+
[OBI Socket](devices/OBI-Wifi-Socket)
44+
[OBI Socket 2](devices/OBI-Socket-2)
45+
[OBI Socket IP44 (Black)](devices/OBI-WiFi-Socket-IP44)
46+
[Shelly 1](devices/shelly-1)
47+
[Shelly 1PM](devices/shelly-1PM)
48+
[Shelly 2](devices/shelly-2)
49+
[Shelly 2.5](devices/shelly-2.5)
50+
[SK03 Outdoor Smart Plug](devices/SK03-Outdoor-Smart-Plug)
51+
[Teckin SP10 Smart Socket](devices/Teckin-sp10)
52+
[Teckin SP22](devices/Teckin-sp22)
53+
[YTF IR Bridge](devices/ytf-ir-bridge)
54+
[WT003-EU 4 AC + 4 USB Outlet Tuya Power Strip EU](https://github.com/arendst/Tasmota/pull/4590)
55+
[Wemos D1 R1 & R2](devices/Wemos-D1-R1-&-R2)
56+
[Wemos D1 Mini](devices/Wemos-D1-Mini)
57+
[Other Devices](devices/Other-Devices)

‎peripherals/A4988-Stepper-Motor-Controller.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ To use it you must [compile your build](compile-your-build). Add the following t
99
----
1010
This driver is used to control stepper-motors such as [NEMA 17](https://reprap.org/wiki/NEMA_17_Stepper_motor).
1111

12-
## Wiring
12+
## Configuration
13+
#### Wiring
1314
The driverboard has several connectors: powering the controller (3.3-5.0 V), input (+/-) & output (1a/1b/2a/2b), the motor (up to 35V/2A), and to control the circuit (in order at the control side of the board):
1415

1516
Connector | Description
@@ -23,7 +24,7 @@ EN|Enable the power supply for the motor
2324
SLP|Sleep (bridge to RST)
2425
RST|Reset (bridge to SLP)
2526

26-
## Tasmota Configuration
27+
#### Tasmota Settings
2728
There are six GPIO [components](Components) that should be configured to free GPIOs:
2829
```
2930
A4988 DIR (170)

0 commit comments

Comments
 (0)