Merge pull request #3 from fabaff/sonoff-basic

Details about Sonoff basic

esphomeyaml/devices/index.rst

@@ -10,3 +10,4 @@ Cookbook
     sonoff
     sonoff_4ch
     sonoff_s20
+    sonoff_basic

esphomeyaml/devices/sonoff.rst

@@ -21,31 +21,6 @@ After that use the following list of pin to function mappings to set up your Son
 This list has been compiled from the Sonoff Tasmota pin source file which can be found here:
 https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/sonoff_template.h ❤️
 
-Sonoff Basic
-^^^^^^^^^^^^
-
-.. table::
-    :class: no-center
-
-    ================================================== ==================================================
-    ``GPIO0``                                          Button (inverted)
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO1``                                          ``RX`` pin (for external sensors)
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO3``                                          ``TX`` pin (for external sensors)
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO4``                                          Optional Sensor
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO12``                                         Relay and Red LED
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO13``                                         Green LED (inverted)
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO14``                                         Optional Sensor
-    -------------------------------------------------- --------------------------------------------------
-    ``GPIO17``                                         Analog Input
-    ================================================== ==================================================
-
-
 Sonoff RF
 ^^^^^^^^^
 
@@ -336,4 +311,5 @@ See Also
 
 - :doc:`sonoff_s20`
 - :doc:`sonoff_4ch`
+- :doc:`sonoff_basic`
 - :doc:`esp8266`

esphomeyaml/devices/sonoff_basic.rst

@@ -0,0 +1,138 @@
+Using With Sonoff Basic
+=======================
+
+esphomeyaml can be used with Sonoff Basic. These devices are basically just
+an ESP8266 chip with a relay to control the connection, a small button on the
+front and a green LED light. 
+
+.. figure:: images/sonoff_basic.jpg
+    :align: center
+    :width: 75.0%
+
+    Sonoff Basic
+
+This guide will not guide you through setting up your Sonoff Basic step-by-step. It just provide
+a sample configuration. For detailed instructions, see :doc:`sonoff_s20`, as those devices are
+pretty similar.
+
+.. note::
+
+    If you've previously installed Sonoff-Tasmota or ESPurna on your Sonoff Basic, you're in luck 😀
+    esphomeyaml can generate a firmware binary which you can then upload via the
+    web 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.
+
+Sample configuration
+~~~~~~~~~~~~~~~~~~~~
+
+The Sonoff Basic is based on the ``ESP8266`` platform and is a subtype of the ``esp01_1m`` board.
+With this information, you can also step through the esphomeyaml wizard (``esphomeyaml sonoff_basic.yaml wizard``)
+if you don't want to use the sample configuration file from below.
+
+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 Basic 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.
+
+Below you will find a table of all usable GPIO pins of the Sonoff Basic and a configuration file that
+exposes all of the basic functions.
+
+.. table::
+    :class: no-center
+
+    ================================================== ==================================================
+    ``GPIO0``                                          Button (inverted)
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO1``                                          ``RX`` pin (for external sensors)
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO3``                                          ``TX`` pin (for external sensors)
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO4``                                          Optional Sensor
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO12``                                         Relay and Red LED
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO13``                                         Green LED (inverted)
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO14``                                         Optional Sensor
+    -------------------------------------------------- --------------------------------------------------
+    ``GPIO17``                                         Analog Input
+    ================================================== ==================================================
+
+.. code:: yaml
+
+    esphomeyaml:
+      name: <NAME_OF_NODE>
+      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 Basic Button"
+      - platform: status
+        name: "Sonoff Basic Status"
+
+    switch:
+      - platform: gpio
+        name: "Sonoff Basic Relay"
+        pin: GPIO12
+
+    output:
+      - platform: esp8266_pwm
+        id: basic_green_led
+        pin: GPIO13
+        inverted: True
+
+    light:
+      - platform: monochromatic
+        name: "Sonoff Basic Green LED"
+        output: basic_green_led
+
+Now run ``esphomeyaml sonoff_basic.yaml compile`` to validate the configuration and
+pre-compile the firmware.
+
+.. note::
+
+    After this step, you will be able to find the compiled binary under
+    ``<NAME_OF_NODE>/.pioenvs/<NAME_OF_NODE>/firmware.bin``. If you're having trouble with
+    uploading, you can also try uploading this file directly with other tools.
+
+Or run the upload command if your device is connected to the serial interface:
+
+.. code:: bash
+
+    esphomeyaml sonoff_basic.yaml run
+
+See Also
+~~~~~~~~
+
+- :doc:`sonoff`
+- :doc:`sonoff_4ch`
+- :doc:`sonoff_s20`

esphomeyaml/index.rst

@@ -92,9 +92,9 @@ These are only the devices for which I've had the time to set up dedicated guide
 -------------------------------------------------- -------------------------------------------------- --------------------------------------------------
 `NodeMCU ESP32`_                                   `Sonoff S20`_                                      `Sonoff 4CH`_
 -------------------------------------------------- -------------------------------------------------- --------------------------------------------------
-|Generic Sonoff|_
+|Generic Sonoff|_                                  |Sonoff Basic|_
 -------------------------------------------------- -------------------------------------------------- --------------------------------------------------
-`Generic Sonoff`_
+`Generic Sonoff`_                                  `Sonoff Basic`_
 ================================================== ================================================== ==================================================
 
 .. |Generic ESP8266| image:: /esphomeyaml/images/esp8266.svg
@@ -112,6 +112,9 @@ These are only the devices for which I've had the time to set up dedicated guide
 .. |Sonoff S20| image:: /esphomeyaml/images/sonoff_s20.jpg
     :class: component-image
 .. _Sonoff S20: /esphomeyaml/devices/sonoff_s20.html
+.. |Sonoff Basic| image:: /esphomeyaml/devices/images/sonoff_basic.jpg
+    :class: component-image
+.. _Sonoff Basic: /esphomeyaml/devices/sonoff_basic.html
 .. |Sonoff 4CH| image:: /esphomeyaml/images/sonoff_4ch.jpg
     :class: component-image
 .. _Sonoff 4CH: /esphomeyaml/devices/sonoff_4ch.html