Sonoff S20 Guide 🎉

_static/custom.css

@@ -1,7 +1,7 @@
 .row-odd {
   background-color: #f3f6f6;
 }
-tr.row-even > td {
+table:not(.no-center) tr.row-even > td {
   text-align: center;
 }
 

esphomeyaml/components/binary_sensor/index.rst

@@ -13,11 +13,11 @@ Currently supported binary sensor platforms:
 `GPIO`_                 `Status`_
 ======================  ======================  ======================
 
-.. |GPIO| image:: /esphomeyaml/pin.svg
+.. |GPIO| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO: /esphomeyaml/components/binary_sensor/gpio.html
 
-.. |Status| image:: /esphomeyaml/server-network.svg
+.. |Status| image:: /esphomeyaml/images/server-network.svg
     :class: component-image
 .. _Status: /esphomeyaml/components/binary_sensor/status.html
 

esphomeyaml/components/fan/index.rst

@@ -16,11 +16,11 @@ Currently supported fan platforms:
 `Binary Fan`_             `Speed Fan`_
 ========================  ========================  ========================
 
-.. |Binary Fan| image:: /esphomeyaml/fan.svg
+.. |Binary Fan| image:: /esphomeyaml/images/fan.svg
     :class: component-image
 .. _Binary Fan: /esphomeyaml/components/fan/binary.html
 
-.. |Speed Fan| image:: /esphomeyaml/fan.svg
+.. |Speed Fan| image:: /esphomeyaml/images/fan.svg
     :class: component-image
 .. _Speed Fan: /esphomeyaml/components/fan/speed.html
 

esphomeyaml/components/i2c.rst

@@ -22,47 +22,47 @@ for several other components:
 `TSL2561`_               `SHT3X-D`_
 =======================  =======================  =======================
 
-.. |PCA9685 PWM| image:: /esphomeyaml/pca9685.jpg
+.. |PCA9685 PWM| image:: /esphomeyaml/images/pca9685.jpg
     :class: component-image
 .. _PCA9685 PWM: /esphomeyaml/components/output/pca9685.html
 
-.. |ADS1115| image:: /esphomeyaml/ads1115.jpg
+.. |ADS1115| image:: /esphomeyaml/images/ads1115.jpg
     :class: component-image
 .. _ADS1115: /esphomeyaml/components/sensor/ads1115.html
 
-.. |BMP085| image:: /esphomeyaml/bmp180.jpg
+.. |BMP085| image:: /esphomeyaml/images/bmp180.jpg
     :class: component-image
 .. _BMP085: /esphomeyaml/components/sensor/bmp085.html
 
-.. |HDC1080| image:: /esphomeyaml/HDC1080.jpg
+.. |HDC1080| image:: /esphomeyaml/images/HDC1080.jpg
     :class: component-image
 .. _HDC1080: /esphomeyaml/components/sensor/hdc1080.html
 
-.. |HTU21D| image:: /esphomeyaml/htu21d.jpg
+.. |HTU21D| image:: /esphomeyaml/images/htu21d.jpg
     :class: component-image
 .. _HTU21D: /esphomeyaml/components/sensor/htu21d.html
 
-.. |MPU6050| image:: /esphomeyaml/mpu6050.jpg
+.. |MPU6050| image:: /esphomeyaml/images/mpu6050.jpg
     :class: component-image
 .. _MPU6050: /esphomeyaml/components/sensor/mpu6050.html
 
-.. |BH1750| image:: /esphomeyaml/bh1750.jpg
+.. |BH1750| image:: /esphomeyaml/images/bh1750.jpg
     :class: component-image
 .. _BH1750: /esphomeyaml/components/sensor/bh1750.html
 
-.. |BME280| image:: /esphomeyaml/bme280.jpg
+.. |BME280| image:: /esphomeyaml/images/bme280.jpg
     :class: component-image
 .. _BME280: /esphomeyaml/components/sensor/bme280.html
 
-.. |BME680| image:: /esphomeyaml/bme680.jpg
+.. |BME680| image:: /esphomeyaml/images/bme680.jpg
     :class: component-image
 .. _BME680: /esphomeyaml/components/sensor/bme680.html
 
-.. |TSL2561| image:: /esphomeyaml/tsl2561.jpg
+.. |TSL2561| image:: /esphomeyaml/images/tsl2561.jpg
     :class: component-image
 .. _TSL2561: /esphomeyaml/components/sensor/tsl2561.html
 
-.. |SHT3X-D| image:: /esphomeyaml/sht3xd.jpg
+.. |SHT3X-D| image:: /esphomeyaml/images/sht3xd.jpg
     :class: component-image
 .. _SHT3X-D: /esphomeyaml/components/sensor/sht3xd.html
 

esphomeyaml/components/light/index.rst

@@ -20,19 +20,19 @@ Currently supported light platforms:
 ========================  ========================  ========================
 
 
-.. |Binary Light| image:: /esphomeyaml/lightbulb.svg
+.. |Binary Light| image:: /esphomeyaml/images/lightbulb.svg
     :class: component-image
 .. _Binary Light: /esphomeyaml/components/light/binary.html
 
-.. |Monochromatic Light| image:: /esphomeyaml/brightness-medium.svg
+.. |Monochromatic Light| image:: /esphomeyaml/images/brightness-medium.svg
     :class: component-image
 .. _Monochromatic Light: /esphomeyaml/components/light/monochromatic.html
 
-.. |RGB Light| image:: /esphomeyaml/rgb.png
+.. |RGB Light| image:: /esphomeyaml/images/rgb.png
     :class: component-image
 .. _RGB Light: /esphomeyaml/components/light/rgb.html
 
-.. |RGBW Light| image:: /esphomeyaml/rgbw.png
+.. |RGBW Light| image:: /esphomeyaml/images/rgbw.png
     :class: component-image
 .. _RGBW Light: /esphomeyaml/components/light/rgbw.html
 

esphomeyaml/components/output/index.rst

@@ -16,19 +16,19 @@ any rational value between 0 and 1).
 `PCA9685`_
 ========================  ========================  ========================
 
-.. |ESP8266 Software PWM| image:: /esphomeyaml/pwm.png
+.. |ESP8266 Software PWM| image:: /esphomeyaml/images/pwm.png
     :class: component-image
 .. _ESP8266 Software PWM: /esphomeyaml/components/output/esp8266_pwm.html
 
-.. |GPIO Output| image:: /esphomeyaml/pin.svg
+.. |GPIO Output| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO Output: /esphomeyaml/components/output/gpio.html
 
-.. |ESP32 LEDC| image:: /esphomeyaml/pwm.png
+.. |ESP32 LEDC| image:: /esphomeyaml/images/pwm.png
     :class: component-image
 .. _ESP32 LEDC: /esphomeyaml/components/output/ledc.html
 
-.. |PCA9685| image:: /esphomeyaml/pca9685.jpg
+.. |PCA9685| image:: /esphomeyaml/images/pca9685.jpg
     :class: component-image
 .. _PCA9685: /esphomeyaml/components/output/pca9685.html
 

esphomeyaml/components/sensor/index.rst

@@ -25,43 +25,43 @@ Currently supported sensor platforms:
 `Ultrasonic Sensor`_
 ======================  ======================  ======================
 
-.. |ADC| image:: /esphomeyaml/flash.svg
+.. |ADC| image:: /esphomeyaml/images/flash.svg
     :class: component-image
 .. _ADC: /esphomeyaml/components/sensor/adc.html
 
-.. |ADS1115| image:: /esphomeyaml/ads1115.jpg
+.. |ADS1115| image:: /esphomeyaml/images/ads1115.jpg
     :class: component-image
 .. _ADS1115: /esphomeyaml/components/sensor/ads1115.html
 
-.. |BMP085| image:: /esphomeyaml/bmp180.jpg
+.. |BMP085| image:: /esphomeyaml/images/bmp180.jpg
     :class: component-image
 .. _BMP085: /esphomeyaml/components/sensor/bmp085.html
 
-.. |Dallas| image:: /esphomeyaml/ds18b20.jpg
+.. |Dallas| image:: /esphomeyaml/images/ds18b20.jpg
     :class: component-image
 .. _Dallas: /esphomeyaml/components/sensor/dallas.html
 
-.. |DHT| image:: /esphomeyaml/dht22.jpg
+.. |DHT| image:: /esphomeyaml/images/dht22.jpg
     :class: component-image
 .. _DHT: /esphomeyaml/components/sensor/dht.html
 
-.. |HDC1080| image:: /esphomeyaml/HDC1080.jpg
+.. |HDC1080| image:: /esphomeyaml/images/HDC1080.jpg
     :class: component-image
 .. _HDC1080: /esphomeyaml/components/sensor/hdc1080.html
 
-.. |HTU21D| image:: /esphomeyaml/htu21d.jpg
+.. |HTU21D| image:: /esphomeyaml/images/htu21d.jpg
     :class: component-image
 .. _HTU21D: /esphomeyaml/components/sensor/htu21d.html
 
-.. |MPU6050| image:: /esphomeyaml/mpu6050.jpg
+.. |MPU6050| image:: /esphomeyaml/images/mpu6050.jpg
     :class: component-image
 .. _MPU6050: /esphomeyaml/components/sensor/mpu6050.html
 
-.. |Pulse Counter| image:: /esphomeyaml/pulse.svg
+.. |Pulse Counter| image:: /esphomeyaml/images/pulse.svg
     :class: component-image
 .. _Pulse Counter: /esphomeyaml/components/sensor/pulse_counter.html
 
-.. |Ultrasonic Sensor| image:: /esphomeyaml/hc-sr04.png
+.. |Ultrasonic Sensor| image:: /esphomeyaml/images/hc-sr04.png
     :class: component-image
 .. _Ultrasonic Sensor: /esphomeyaml/components/sensor/ultrasonic.html
 

esphomeyaml/components/switch/index.rst

@@ -16,23 +16,23 @@ Currently supported switch platforms:
 `Shutdown Switch`_        `Output Switch`_
 ========================  ========================  ========================
 
-.. |GPIO Switch| image:: /esphomeyaml/pin.svg
+.. |GPIO Switch| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO Switch: /esphomeyaml/components/switch/gpio.html
 
-.. |IR Transmitter| image:: /esphomeyaml/remote.svg
+.. |IR Transmitter| image:: /esphomeyaml/images/remote.svg
     :class: component-image
 .. _IR Transmitter: /esphomeyaml/components/switch/ir_transmitter.html
 
-.. |Restart Switch| image:: /esphomeyaml/restart.svg
+.. |Restart Switch| image:: /esphomeyaml/images/restart.svg
     :class: component-image
 .. _Restart Switch: /esphomeyaml/components/switch/restart.html
 
-.. |Shutdown Switch| image:: /esphomeyaml/power.svg
+.. |Shutdown Switch| image:: /esphomeyaml/images/power.svg
     :class: component-image
 .. _Shutdown Switch: /esphomeyaml/components/switch/shutdown.html
 
-.. |Output Switch| image:: /esphomeyaml/upload.svg
+.. |Output Switch| image:: /esphomeyaml/images/upload.svg
     :class: component-image
 .. _Output Switch: /esphomeyaml/components/switch/output.html
 

esphomeyaml/index.rst

@@ -36,6 +36,20 @@ Features
  * **It's Open Source 😺**
 
 
+Using With
+~~~~~~~~~~
+
+==================  ==================  ==================
+|Sonoff S20|_
+------------------  ------------------  ------------------
+`Sonoff S20`_
+==================  ==================  ==================
+
+.. |Sonoff S20| image:: /esphomeyaml/images/sonoff-s20.jpg
+    :class: component-image
+.. _Sonoff S20: /esphomeyaml/using-with/sonoff-s20.html
+
+
 Core Components
 ~~~~~~~~~~~~~~~
 
@@ -53,39 +67,39 @@ Core Components
 `Web Server`_       `Power Supply`_     `Deep Sleep`_
 ==================  ==================  ==================
 
-.. |Core| image:: /esphomeyaml/cloud-circle.svg
+.. |Core| image:: /esphomeyaml/images/cloud-circle.svg
     :class: component-image
 .. _Core: /esphomeyaml/components/esphomeyaml.html
 
-.. |WiFi| image:: /esphomeyaml/network-wifi.svg
+.. |WiFi| image:: /esphomeyaml/images/network-wifi.svg
     :class: component-image
 .. _WiFi: /esphomeyaml/components/wifi.html
 
-.. |MQTT| image:: /esphomeyaml/mqtt.png
+.. |MQTT| image:: /esphomeyaml/images/mqtt.png
     :class: component-image
 .. _MQTT: /esphomeyaml/components/mqtt.html
 
-.. |I²C Bus| image:: /esphomeyaml/i2c.svg
+.. |I²C Bus| image:: /esphomeyaml/images/i2c.svg
     :class: component-image
 .. _I²C Bus: /esphomeyaml/components/i2c.html
 
-.. |OTA Updates| image:: /esphomeyaml/system-update.svg
+.. |OTA Updates| image:: /esphomeyaml/images/system-update.svg
     :class: component-image
 .. _OTA Updates: /esphomeyaml/components/ota.html
 
-.. |Logger| image:: /esphomeyaml/file-document-box.svg
+.. |Logger| image:: /esphomeyaml/images/file-document-box.svg
     :class: component-image
 .. _Logger: /esphomeyaml/components/logger.html
 
-.. |Web Server| image:: /esphomeyaml/http.svg
+.. |Web Server| image:: /esphomeyaml/images/http.svg
     :class: component-image
 .. _Web Server: /esphomeyaml/components/web_server.html
 
-.. |Deep Sleep| image:: /esphomeyaml/hotel.svg
+.. |Deep Sleep| image:: /esphomeyaml/images/hotel.svg
     :class: component-image
 .. _Deep Sleep: /esphomeyaml/components/deep_sleep.html
 
-.. |Power Supply| image:: /esphomeyaml/power.svg
+.. |Power Supply| image:: /esphomeyaml/images/power.svg
     :class: component-image
 .. _Power Supply: /esphomeyaml/components/power_supply.html
 
@@ -119,67 +133,67 @@ Sensor Components
 `SHT3X-D`_
 ======================  ======================  ======================
 
-.. |Sensor Core| image:: /esphomeyaml/folder-open.svg
+.. |Sensor Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Sensor Core: /esphomeyaml/components/sensor/index.html
 
-.. |ADC| image:: /esphomeyaml/flash.svg
+.. |ADC| image:: /esphomeyaml/images/flash.svg
     :class: component-image
 .. _ADC: /esphomeyaml/components/sensor/adc.html
 
-.. |ADS1115| image:: /esphomeyaml/ads1115.jpg
+.. |ADS1115| image:: /esphomeyaml/images/ads1115.jpg
     :class: component-image
 .. _ADS1115: /esphomeyaml/components/sensor/ads1115.html
 
-.. |BMP085| image:: /esphomeyaml/bmp180.jpg
+.. |BMP085| image:: /esphomeyaml/images/bmp180.jpg
     :class: component-image
 .. _BMP085: /esphomeyaml/components/sensor/bmp085.html
 
-.. |Dallas| image:: /esphomeyaml/ds18b20.jpg
+.. |Dallas| image:: /esphomeyaml/images/ds18b20.jpg
     :class: component-image
 .. _Dallas: /esphomeyaml/components/sensor/dallas.html
 
-.. |DHT| image:: /esphomeyaml/dht22.jpg
+.. |DHT| image:: /esphomeyaml/images/dht22.jpg
     :class: component-image
 .. _DHT: /esphomeyaml/components/sensor/dht.html
 
-.. |HDC1080| image:: /esphomeyaml/HDC1080.jpg
+.. |HDC1080| image:: /esphomeyaml/images/HDC1080.jpg
     :class: component-image
 .. _HDC1080: /esphomeyaml/components/sensor/hdc1080.html
 
-.. |HTU21D| image:: /esphomeyaml/htu21d.jpg
+.. |HTU21D| image:: /esphomeyaml/images/htu21d.jpg
     :class: component-image
 .. _HTU21D: /esphomeyaml/components/sensor/htu21d.html
 
-.. |MPU6050| image:: /esphomeyaml/mpu6050.jpg
+.. |MPU6050| image:: /esphomeyaml/images/mpu6050.jpg
     :class: component-image
 .. _MPU6050: /esphomeyaml/components/sensor/mpu6050.html
 
-.. |Pulse Counter| image:: /esphomeyaml/pulse.svg
+.. |Pulse Counter| image:: /esphomeyaml/images/pulse.svg
     :class: component-image
 .. _Pulse Counter: /esphomeyaml/components/sensor/pulse_counter.html
 
-.. |Ultrasonic Sensor| image:: /esphomeyaml/hc-sr04.png
+.. |Ultrasonic Sensor| image:: /esphomeyaml/images/hc-sr04.png
     :class: component-image
 .. _Ultrasonic Sensor: /esphomeyaml/components/sensor/ultrasonic.html
 
-.. |BH1750| image:: /esphomeyaml/bh1750.jpg
+.. |BH1750| image:: /esphomeyaml/images/bh1750.jpg
     :class: component-image
 .. _BH1750: /esphomeyaml/components/sensor/bh1750.html
 
-.. |BME280| image:: /esphomeyaml/bme280.jpg
+.. |BME280| image:: /esphomeyaml/images/bme280.jpg
     :class: component-image
 .. _BME280: /esphomeyaml/components/sensor/bme280.html
 
-.. |BME680| image:: /esphomeyaml/bme680.jpg
+.. |BME680| image:: /esphomeyaml/images/bme680.jpg
     :class: component-image
 .. _BME680: /esphomeyaml/components/sensor/bme680.html
 
-.. |TSL2561| image:: /esphomeyaml/tsl2561.jpg
+.. |TSL2561| image:: /esphomeyaml/images/tsl2561.jpg
     :class: component-image
 .. _TSL2561: /esphomeyaml/components/sensor/tsl2561.html
 
-.. |SHT3X-D| image:: /esphomeyaml/sht3xd.jpg
+.. |SHT3X-D| image:: /esphomeyaml/images/sht3xd.jpg
     :class: component-image
 .. _SHT3X-D: /esphomeyaml/components/sensor/sht3xd.html
 
@@ -197,23 +211,23 @@ Binary Sensor Components
 `ESP32 BLE Device`_     `ESP32 Touch Pad`_
 ======================  ======================  ======================
 
-.. |Binary Sensor Core| image:: /esphomeyaml/folder-open.svg
+.. |Binary Sensor Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Binary Sensor Core: /esphomeyaml/components/binary_sensor/index.html
 
-.. |GPIO| image:: /esphomeyaml/pin.svg
+.. |GPIO| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO: /esphomeyaml/components/binary_sensor/gpio.html
 
-.. |Status| image:: /esphomeyaml/server-network.svg
+.. |Status| image:: /esphomeyaml/images/server-network.svg
     :class: component-image
 .. _Status: /esphomeyaml/components/binary_sensor/status.html
 
-.. |ESP32 BLE Device| image:: /esphomeyaml/bluetooth.svg
+.. |ESP32 BLE Device| image:: /esphomeyaml/images/bluetooth.svg
     :class: component-image
 .. _ESP32 BLE Device: /esphomeyaml/components/binary_sensor/esp32_ble.html
 
-.. |ESP32 Touch Pad| image:: /esphomeyaml/touch.svg
+.. |ESP32 Touch Pad| image:: /esphomeyaml/images/touch.svg
     :class: component-image
 .. _ESP32 Touch Pad: /esphomeyaml/components/binary_sensor/esp32_touch.html
 
@@ -230,23 +244,23 @@ Output Components
 `ESP32 LEDC`_             `PCA9685`_
 ========================  ========================  ========================
 
-.. |Output Core| image:: /esphomeyaml/folder-open.svg
+.. |Output Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Output Core: /esphomeyaml/components/output/index.html
 
-.. |ESP8266 Software PWM| image:: /esphomeyaml/pwm.png
+.. |ESP8266 Software PWM| image:: /esphomeyaml/images/pwm.png
     :class: component-image
 .. _ESP8266 Software PWM: /esphomeyaml/components/output/esp8266_pwm.html
 
-.. |GPIO Output| image:: /esphomeyaml/pin.svg
+.. |GPIO Output| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO Output: /esphomeyaml/components/output/gpio.html
 
-.. |ESP32 LEDC| image:: /esphomeyaml/pwm.png
+.. |ESP32 LEDC| image:: /esphomeyaml/images/pwm.png
     :class: component-image
 .. _ESP32 LEDC: /esphomeyaml/components/output/ledc.html
 
-.. |PCA9685| image:: /esphomeyaml/pca9685.jpg
+.. |PCA9685| image:: /esphomeyaml/images/pca9685.jpg
     :class: component-image
 .. _PCA9685: /esphomeyaml/components/output/pca9685.html
 
@@ -269,31 +283,31 @@ Light Components
 ============================  ============================  ============================
 
 
-.. |Light Core| image:: /esphomeyaml/folder-open.svg
+.. |Light Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Light Core: /esphomeyaml/components/light/index.html
 
-.. |Binary Light| image:: /esphomeyaml/lightbulb.svg
+.. |Binary Light| image:: /esphomeyaml/images/lightbulb.svg
     :class: component-image
 .. _Binary Light: /esphomeyaml/components/light/binary.html
 
-.. |Monochromatic Light| image:: /esphomeyaml/brightness-medium.svg
+.. |Monochromatic Light| image:: /esphomeyaml/images/brightness-medium.svg
     :class: component-image
 .. _Monochromatic Light: /esphomeyaml/components/light/monochromatic.html
 
-.. |RGB Light| image:: /esphomeyaml/rgb.png
+.. |RGB Light| image:: /esphomeyaml/images/rgb.png
     :class: component-image
 .. _RGB Light: /esphomeyaml/components/light/rgb.html
 
-.. |RGBW Light| image:: /esphomeyaml/rgbw.png
+.. |RGBW Light| image:: /esphomeyaml/images/rgbw.png
     :class: component-image
 .. _RGBW Light: /esphomeyaml/components/light/rgbw.html
 
-.. |FastLED Clockless Light| image:: /esphomeyaml/color_lens.svg
+.. |FastLED Clockless Light| image:: /esphomeyaml/images/color_lens.svg
     :class: component-image
 .. _FastLED Clockless Light: /esphomeyaml/components/light/fastled_clockless.html
 
-.. |FastLED SPI Light| image:: /esphomeyaml/color_lens.svg
+.. |FastLED SPI Light| image:: /esphomeyaml/images/color_lens.svg
     :class: component-image
 .. _FastLED SPI Light: /esphomeyaml/components/light/fastled_spi.html
 
@@ -311,27 +325,27 @@ Switch Components
 `Restart Switch`_         `Shutdown Switch`_        `Output Switch`_
 ========================  ========================  ========================
 
-.. |Switch Core| image:: /esphomeyaml/folder-open.svg
+.. |Switch Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Switch Core: /esphomeyaml/components/switch/index.html
 
-.. |GPIO Switch| image:: /esphomeyaml/pin.svg
+.. |GPIO Switch| image:: /esphomeyaml/images/pin.svg
     :class: component-image
 .. _GPIO Switch: /esphomeyaml/components/switch/gpio.html
 
-.. |IR Transmitter| image:: /esphomeyaml/remote.svg
+.. |IR Transmitter| image:: /esphomeyaml/images/remote.svg
     :class: component-image
 .. _IR Transmitter: /esphomeyaml/components/switch/ir_transmitter.html
 
-.. |Restart Switch| image:: /esphomeyaml/restart.svg
+.. |Restart Switch| image:: /esphomeyaml/images/restart.svg
     :class: component-image
 .. _Restart Switch: /esphomeyaml/components/switch/restart.html
 
-.. |Shutdown Switch| image:: /esphomeyaml/power_settings.svg
+.. |Shutdown Switch| image:: /esphomeyaml/images/power_settings.svg
     :class: component-image
 .. _Shutdown Switch: /esphomeyaml/components/switch/shutdown.html
 
-.. |Output Switch| image:: /esphomeyaml/upload.svg
+.. |Output Switch| image:: /esphomeyaml/images/upload.svg
     :class: component-image
 .. _Output Switch: /esphomeyaml/components/switch/output.html
 
@@ -345,15 +359,15 @@ Fan Components
 `Fan Core`_               `Binary Fan`_             `Speed Fan`_
 ========================  ========================  ========================
 
-.. |Fan Core| image:: /esphomeyaml/folder-open.svg
+.. |Fan Core| image:: /esphomeyaml/images/folder-open.svg
     :class: component-image
 .. _Fan Core: /esphomeyaml/components/fan/index.html
 
-.. |Binary Fan| image:: /esphomeyaml/fan.svg
+.. |Binary Fan| image:: /esphomeyaml/images/fan.svg
     :class: component-image
 .. _Binary Fan: /esphomeyaml/components/fan/binary.html
 
-.. |Speed Fan| image:: /esphomeyaml/fan.svg
+.. |Speed Fan| image:: /esphomeyaml/images/fan.svg
     :class: component-image
 .. _Speed Fan: /esphomeyaml/components/fan/speed.html
 
@@ -375,35 +389,35 @@ Misc Components
 `ESP32 BLE Hub`_          `ESP32 Touch Hub`_
 ========================  ========================  ========================
 
-.. |Dallas Hub| image:: /esphomeyaml/ds18b20.jpg
+.. |Dallas Hub| image:: /esphomeyaml/images/ds18b20.jpg
     :class: component-image
 .. _Dallas Hub: /esphomeyaml/components/dallas.html
 
-.. |IR Transmitter Hub| image:: /esphomeyaml/remote.svg
+.. |IR Transmitter Hub| image:: /esphomeyaml/images/remote.svg
     :class: component-image
 .. _IR Transmitter Hub: /esphomeyaml/components/ir_transmitter.html
 
-.. |PCA9685 Hub| image:: /esphomeyaml/pca9685.jpg
+.. |PCA9685 Hub| image:: /esphomeyaml/images/pca9685.jpg
     :class: component-image
 .. _PCA9685 Hub: /esphomeyaml/components/pca9685.html
 
-.. |ADS1115 Hub| image:: /esphomeyaml/ads1115.jpg
+.. |ADS1115 Hub| image:: /esphomeyaml/images/ads1115.jpg
     :class: component-image
 .. _ADS1115 Hub: /esphomeyaml/components/ads1115.html
 
-.. |Debug Component| image:: /esphomeyaml/bug-report.svg
+.. |Debug Component| image:: /esphomeyaml/images/bug-report.svg
     :class: component-image
 .. _Debug Component: /esphomeyaml/components/debug.html
 
-.. |PCF8574 I/O Expander| image:: /esphomeyaml/pcf8574.jpg
+.. |PCF8574 I/O Expander| image:: /esphomeyaml/images/pcf8574.jpg
     :class: component-image
 .. _PCF8574 I/O Expander: /esphomeyaml/components/pcf8574.html
 
-.. |ESP32 BLE Hub| image:: /esphomeyaml/bluetooth.svg
+.. |ESP32 BLE Hub| image:: /esphomeyaml/images/bluetooth.svg
     :class: component-image
 .. _ESP32 BLE Hub: /esphomeyaml/components/esp32_ble.html
 
-.. |ESP32 Touch Hub| image:: /esphomeyaml/touch.svg
+.. |ESP32 Touch Hub| image:: /esphomeyaml/images/touch.svg
     :class: component-image
 .. _ESP32 Touch Hub: /esphomeyaml/components/esp32_touch.html
 
@@ -476,3 +490,4 @@ Full Index
     components/sensor/bme680.rst
     components/sensor/tsl2561.rst
     components/sensor/sht3xd.rst
+    components/using-with/sonoff-s20.rst

esphomeyaml/using-with/sonoff-s20.rst

@@ -0,0 +1,269 @@
+Using With Sonoff S20
+=====================
+
+esphomeyaml can also be used with Sonoff S20 smart sockets. These devices are
+basically just an ESP8266 chip with a relay to control the socket, a small button on the
+front and a blue and green LED light.
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-header.jpg
+    :align: center
+    :width: 75.0%
+
+    Sonoff S20 Smart Socket.
+
+This guide will step you through setting up your Sonoff S20 and flashing the first esphomeyaml firmware
+with the serial interface. After that, you will be able to upload all future firmwares with the remote
+Over-The-Air update process.
+
+Since firmware version 1.6.0, iTead (the creator of this device) has removed the ability to upload
+a custom firmware through their own upload process. Unfortunately, that means that the only way to
+flash the initial esphomeyaml firmware is by physically opening the device up and using the UART
+interface.
+
+.. warning::
+
+    Opening up this device can be very dangerous if not done correctly. While the device is open,
+    you will be a single touch away from being electrocuted if the device is plugged in.
+
+    So, during this *entire* guide **never ever** plug the device in. Also, you should only do this
+    if you know what you're doing. If you, at any step, feel something is wrong or are uncomfortable
+    with continuing, it's best to just stop for your own safety.
+
+    It's your own responsibility to make sure everything you do during this setup process is safe.
+
+For this guide you will need:
+
+-  Sonoff S20 😉
+-  An USB to UART Bridge for flashing the device. These can be bought on Amazon for less than 5 dollars.
+   Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your S20.
+-  Computer running esphomeyaml.
+-  Screwdriver to open up the S20.
+-  Soldering iron and a few header pins to connect the UART interface.
+
+Have everything? Great! Then you can start.
+
+
+Step 1: Opening up the Sonoff S20
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The first step is to open up the Sonoff S20. Note that you do not have to run the original firmware
+supplied with the Sonoff S20 before doing this step.
+
+.. warning::
+
+    Just to repeat this: Make **absolutely sure** the device is not connected to any appliance or
+    plugged in before doing this step.
+
+While the device is not plugged in, turn the back side so it's facing you and unscrew the three
+black screws holding the back of the case together with the front.
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-screws.jpg
+    :align: center
+    :width: 60.0%
+
+    There are three screws on the back of the Sonoff S20.
+
+After that, you should be able to remove the front cover and should be greeted by a bunch of parts.
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-parts.jpg
+    :align: center
+    :width: 75.0%
+
+Step 2: Connecting UART
+~~~~~~~~~~~~~~~~~~~~~~~
+
+We're interested in the main part of the S20 with the green PCB. On the bottom of the PCB, you will
+find four unpopulated holes. These pins have the UART interface used to flash firmwares onto the device
+and debug issues.
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-pcb.jpg
+    :align: center
+
+    The UART interface of the Sonoff S20.
+
+So, in order to flash our own custom firmware, we're going to need to somehow connect the UART to USB
+bridge to these pins. The only way to make a good connection here is by using a soldering iron and soldering
+on some pin headers. On older models of the Sonoff S20, you were able to get the whole PCB out. Newer versions,
+however, glue the PCB onto the case to avoid people flashing custom firmwares. If the latter is the case,
+you will need to just solder the pin headers from above - it's a bit difficult, but possible.
+
+When you're done, it should look something like this:
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-uart.jpg
+    :align: center
+
+Now go ahead and connect the pins to your UART bridge, making sure the S20 is not plugged in as before.
+Also beware that some UART to USB bridges supply 5V on the VCC pin if it's not explicitly labeled 3.3V.
+It's best to just use a multimeter and double check if it's unclear.
+
+.. note::
+
+    On some older S20s, the ``RX`` and ``TX`` pins are swapped (sometimes even the written silkscreen is
+    wrong). If your upload fails with a ``error: espcomm_upload_mem failed`` messsage it's most likely due
+    to the pins being swapped. In that case, just swap ``RX`` and ``TX`` and try again - you won't break
+    anything if they're swapped.
+
+Step 3: Creating Firmware
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Sonoff S20 is based on the ``ESP8266`` platform and is a subtype of the ``esp01_1m`` board.
+With this information, you can step through the esphomeyaml wiard (``esphomeyaml sonoff_s20.yaml wizard``),
+or alternatively, you can just take the below configuration file and modify it to your needs.
+
+If you go through the wizard, please make sure you manually set ``board_flash_mode`` to ``dout``
+as seen below. The version of the uploader used by esphomeyaml should automatically detect that
+the Sonoff S20 uses the ``dout`` SPI flash chip mode. But, as some users of other firmwares have
+said that other flash modes can brick the device, it's always good to specify it explicitly.
+
+
+.. code:: yaml
+
+    esphomeyaml:
+      name: <YOUR_NAME>
+      platform: ESP8266
+      board: esp01_1m
+      board_flash_mode: dout
+
+    wifi:
+      ssid: <YOUR_SSID>
+      password: <YOUR_PASSWORD>
+
+    mqtt:
+      broker: <YOUR_MQTT_BROKER>
+      username: <YOUR_USERNAME>
+      password: <YOUR_PASSWORD>
+
+    logger:
+
+    ota:
+
+Now run ``esphomeyaml sonoff_s20.yaml compile`` to validate the configuration and
+pre-compile the firmware.
+
+Step 4: Uploading Firmware
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to upload the firmware, you're first going to need to get the chip into a flash mode, otherwise
+the device will start up without accepting any firmware flash attempts. To do this, while the device is UART
+bridge is not connected to your USB port, start pressing the small push button in the middle of the PCB.
+Then plug in the UART bridge into your computer and just keep holding the button pressed for 2-4 seconds.
+The S20 should now be in a flash mode and should not blink with any LED.
+
+Now you can finally run the upload command:
+
+.. code:: bash
+
+    esphomeyaml sonoff_s20.yaml run
+
+If successful, you should see something like this:
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-upload.png
+    :align: center
+
+Hooray 🎉! You've now successfully uploaded the first esphomeyaml firmware to your Sonoff S20. And in a moment,
+you will be able to use all of esphomeyaml's great features with your Sonoff S20.
+
+If above step does, however, not work, here are some steps that can help:
+
+-  Sometimes the UART bridge cannot supply enough current to the chip to operate, in this
+   case use a 3.3V supply you have lying around. A nice hack is to use the power supply of
+   NodeMCU boards. Simply connect 3.3V to VCC and GND to GND on the pins. **Do not attempt
+   to plug the device into a socket to overcome this problem while troubleshooting.**
+-  In other cases the ``TX`` and ``RX`` pin are reversed. Simple disconnect the device, swap
+   the two pins and put it into flash mode again.
+
+Step 5: Adding the Button, Relay and LEDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Now we would like the S20 to actually do something, not just connect to WiFi and pretty much sit idle.
+
+Below you will find a table of all usable GPIO pins of the S20 and a configuration file that exposes all
+of the basic functions.
+
+.. table::
+    :class: no-center
+
+    ======================================== ========================================
+    ``GPIO0``                                Push Button (HIGH = off, LOW = on)
+    ---------------------------------------- ----------------------------------------
+    ``GPIO12``                               Relay and its status LED
+    ---------------------------------------- ----------------------------------------
+    ``GPIO13``                               Green LED (HIGH = off, LOW = on)
+    ---------------------------------------- ----------------------------------------
+    ``GPIO1``                                ``RX`` pin (for external sensors)
+    ---------------------------------------- ----------------------------------------
+    ``GPIO3``                                ``TX`` pin (for external sensors)
+    ======================================== ========================================
+
+.. code:: yaml
+
+    esphomeyaml:
+      name: <YOUR_NAME>
+      platform: ESP8266
+      board: esp01_1m
+      board_flash_mode: dout
+
+    wifi:
+      ssid: <YOUR_SSID>
+      password: <YOUR_PASSWORD>
+
+    mqtt:
+      broker: <YOUR_MQTT_BROKER>
+      username: <YOUR_USERNAME>
+      password: <YOUR_PASSWORD>
+
+    logger:
+
+    ota:
+
+    binary_sensor:
+      - platform: gpio
+        pin:
+          number: GPIO0
+          mode: INPUT_PULLUP
+          inverted: True
+        name: "Sonoff S20 Button"
+      - platform: status
+        name: "Sonoff S20 Status"
+
+    switch:
+      - platform: gpio
+        name: "Sonoff S20 Relay"
+        pin: GPIO12
+      - platform: gpio
+        name: "Sonoff S20 Green LED"
+        pin:
+          number: GPIO13
+          inverted: True
+      - platform: restart
+        name: "Sonoff S20 Restart"
+
+Upload the firmware again (through OTA or Serial) and you should immediately see
+something like this in Home Assistant because of esphomeyaml's automatic MQTT discovery. (You'll
+of course have to add them to groups if you have a ``default_view`` set):
+
+
+.. figure:: /esphomeyaml/using-with/images/sonoff-s20-result.png
+    :align: center
+    :width: 75.0%
+
+Step 6: Finishing Up
+~~~~~~~~~~~~~~~~~~~~
+
+Now you're pretty much done with setting up the Sonoff S20. The only steps left are to
+remove any cables within the housing and make sure everyhing in there is clean. If, for
+example, you used wires to connect the UART console, you should definitely remove them to avoid
+a short with mains.
+
+Sometimes the soldered-on header pins can also interfere with the button. It's best to remove the
+header pins again, as you will hopefully not need to use them again because of esphomeyaml's Over-The-Air
+Update features (+ the OTA safe mode; if your node reboots more than 10 times in a row, it will automatically
+enter an OTA-only safe mode).
+
+If you're sure everything is done with the S20 and have double checked there's nothing that could cause a short
+in the case, you can put the front cover with the button on the base again and screw everything together.
+
+Now triple or even quadruple check the UART bridge is not connected to the S20, then comes the time when you can
+plug it into the socket.
+
+Happy hacking!