Merge branch 'next' into rc

Author: OttoWinter

api/misc/stepper.rst

@@ -0,0 +1,35 @@
+Stepper Component
+=================
+
+.. cpp:namespace:: nullptr
+
+API Reference
+-------------
+
+.. cpp:namespace:: nullptr
+
+Stepper
+*******
+
+.. doxygenclass:: stepper::Stepper
+    :members:
+    :protected-members:
+    :undoc-members:
+
+.. doxygenclass:: stepper::SetTargetAction
+    :members:
+    :protected-members:
+    :undoc-members:
+
+.. doxygenclass:: stepper::ReportPositionAction
+    :members:
+    :protected-members:
+    :undoc-members:
+
+A4988
+*****
+
+.. doxygenclass:: stepper::A4988
+    :members:
+    :protected-members:
+    :undoc-members:

esphomeyaml/components/display/index.rst

@@ -297,6 +297,11 @@ use any string you pass it, like ``"ON"`` or ``"OFF"``.
           // Shorthand:
           it.printf(0, 0, id(my_font), "State: %s", id(my_binary_sensor).state ? "ON" : "OFF");
 
+.. note::
+
+    For displaying external data on the display, for example data from your Home Assistant instance,
+    you can use the :doc:`/esphomeyaml/components/text_sensor/mqtt` (see the example there for more information).
+
 .. _display-strftime:
 
 Displaying Time

esphomeyaml/components/esp32_ble_beacon.rst

@@ -67,19 +67,6 @@ know when I'm home or away.
     :align: center
     :width: 75.0%
 
-.. note::
-
-    The latest arduino ESP32 framework has a bug with the bluetooth module. Please set
-    :ref:`esphomeyaml-arduino_version` to ``espressif32@1.0.2`` like so:
-
-    .. code:: yaml
-
-        esphomeyaml:
-          # ...
-          arduino_version: espressif32@1.0.2
-
-    See https://github.com/OttoWinter/esphomeyaml/issues/78#issuecomment-425746566
-
 See Also
 --------
 

esphomeyaml/components/esp32_ble_tracker.rst

@@ -43,20 +43,6 @@ for information on how you can find out the MAC address of a device and track it
         battery_level:
           name: "Xiaomi MiJia Battery Level"
 
-.. note::
-
-    The latest arduino ESP32 framework has a bug with the bluetooth module. Please set
-    :ref:`esphomeyaml-arduino_version` to ``espressif32@1.0.2`` like so:
-
-    .. code:: yaml
-
-        esphomeyaml:
-          # ...
-          arduino_version: espressif32@1.0.2
-
-    See https://github.com/OttoWinter/esphomeyaml/issues/78#issuecomment-425746566
-
-
 .. note::
 
     The first time this component is enabled for an ESP32, the code partition needs to be

esphomeyaml/components/mqtt.rst

@@ -313,6 +313,16 @@ Configuration variables:
                then:
                  - # ...
 
+.. note::
+
+    This action can also be used in :ref:`lambdas <config-lambda>`:
+
+    .. code:: cpp
+
+        App.get_mqtt_client()->subscribe("the/topic", [=](const std::string &payload) {
+            // do something with payload
+        });
+
 .. _mqtt-on_json_message:
 
 ``on_json_message`` Trigger
@@ -366,6 +376,16 @@ Configuration variables:
     Due to the way this trigger works internally it is incompatible with certain actions and will
     trigger a compile failure. For example with the ``delay`` action.
 
+.. note::
+
+    This action can also be used in :ref:`lambdas <config-lambda>`:
+
+    .. code:: cpp
+
+        App.get_mqtt_client()->subscribe_json("the/topic", [=](JsonObject &root) {
+            // do something with JSON-decoded value root
+        });
+
 .. _mqtt-publish_action:
 
 ``mqtt.publish`` Action
@@ -413,8 +433,7 @@ Configuration options:
 
     .. code:: cpp
 
-        // in lambda, parameters: <TOPIC>,    <PAYLOAD>,  <QoS>, <retain>
-        id(mqtt_client).publish("the/topic", "The Payload", 0, false);
+        id(mqtt_client).publish("the/topic", "The Payload");
 
 .. _mqtt-publish_json_action:
 
@@ -452,6 +471,24 @@ Configuration options:
 -  **retain** (*Optional*, boolean): If the published message should
    have a retain flag on or not. Defaults to ``False``.
 
+
+.. note::
+
+    This action can also be written in :ref:`lambdas <config-lambda>`:
+
+    .. code:: yaml
+
+        mqtt:
+          # Give the mqtt component an ID
+          id: mqtt_client
+
+    .. code:: cpp
+
+        id(mqtt_client).publish_json("the/topic", [=](JsonObject &root) {
+          root["something"] = id(my_sensor).value;
+        });
+
+
 See Also
 --------
 

esphomeyaml/components/sensor/cse7766.rst

@@ -12,7 +12,7 @@ esphomelib. This sensor is commonly found in Sonoff POW R2.
 
 As the communication with the CSE7766 done using UART, you need
 to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the CSE7766.
-Additionally, you need to set the baud rate to 9600.
+Additionally, you need to set the baud rate to 4800.
 
 .. code:: yaml
 
@@ -23,7 +23,7 @@ Additionally, you need to set the baud rate to 9600.
 
     uart:
       rx_pin: RX
-      baud_rate: 9600
+      baud_rate: 4800
 
     sensor:
       - platform: cse7766

esphomeyaml/components/sensor/index.rst

@@ -126,6 +126,9 @@ every filter there is currently:
    -  **send_every**: How often a sensor value should be pushed out. For
       example, in above configuration the weighted average is only
       pushed out on every 15th received sensor value.
+   -  **send_first_at**: By default, the very first raw value on boot is immediately
+      published. With this parameter you can specify when the very first value is to be sent.
+      Defaults to ``1``.
 
 -  **exponential_moving_average**: A simple `exponential moving
    average <https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average>`__

esphomeyaml/components/stepper/index.rst

@@ -0,0 +1,164 @@
+Stepper Component
+=================
+
+The ``stepper`` component allows you to use stepper motors with esphomelib.
+Currently only the A4988 stepper driver
+(`datasheet <https://www.pololu.com/file/0J450/a4988_DMOS_microstepping_driver_with_translator.pdf>`__)
+is supported.
+
+.. code:: yaml
+
+    # Example configuration entry
+    stepper:
+      - platform: a4988
+        id: my_stepper
+        step_pin: D0
+        dir_pin: D1
+        max_speed: 250 steps/s
+
+        # Optional:
+        sleep_pin: D2
+        acceleration: inf
+        deceleration: inf
+
+
+Configuration variables:
+------------------------
+
+- **id** (**Required**, :ref:`config-id`): Specify the ID of the stepper so that you can control it.
+- **step_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The ``STEP`` pin of the A4988
+  stepper driver.
+- **dir_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The ``DIRECTION`` pin of the A4988
+  stepper driver.
+- **max_speed** (**Required**, float): The maximum speed in ``steps/s`` (steps per seconds) to drive the
+  stepper at. Note most steppers can't step properly with speeds higher than 250 steps/s.
+- **sleep_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Optionally also use the ``SLEEP`` pin
+  of the A4988 stepper driver. If specified, the driver will be put into sleep mode as soon as the stepper
+  reaches the target steps.
+- **acceleration** (*Optional*, float): The acceleration in ``steps/s^2`` (steps per seconds squared)
+  to use when starting to move. The default is ``inf`` which means infinite acceleration, so the
+  stepper will try to drive with the full speed immediately.
+- **deceleration** (*Optional*, float): The same as ``acceleration``, but for when the motor is decelerating
+  shortly before reaching the set position. Defaults to ``inf`` (immediate deceleration).
+
+
+.. note::
+
+    Esphomelib's core loop only runs 60 times per second by default to conserve power. But this also means it's limited
+    to 60 steps per second. To have higher step rater, you have to open up the ``<NODE_NAME>/src/main.cpp`` file,
+    scroll down to the ``void loop()`` section and remove the ``delay(16);`` line.
+
+.. note::
+
+    If the stepper is driving in the wrong direction, you can invert the ``dir_pin``:
+
+    .. code:: yaml
+
+        stepper:
+          - platform: a4988
+            # ...
+            dir_pin:
+              number: D1
+              inverted: True
+
+
+.. _stepper-set_target_action:
+
+``stepper.set_target`` Action
+-----------------------------
+
+To use your stepper motor in :ref:`automations <automation>` or templates, you can use this action to set the target
+position (in steps). The stepper will always run towards the target position and stop once it has reached the target.
+
+.. code:: yaml
+
+    on_...:
+      then:
+      - stepper.set_target:
+          id: my_stepper
+          target: 250
+
+      # Templated
+      - stepper.set_target:
+          id: my_stepper
+          target: !lambda |-
+            if (id(my_binary_sensor).value) {
+              return 1000;
+            } else {
+              return -1000;
+            }
+
+Configuration options:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
+- **target** (*Optional*, int, :ref:`templatable <config-templatable>`): The target position in steps.
+
+.. note::
+
+    This action can also be expressed as a :ref:`lambda <config-lambda>`:
+
+    .. code:: cpp
+
+        id(my_stepper).set_target(250);
+
+        // Get the currently set target position:
+        int target = id(my_stepper).target_position;
+
+.. _stepper-report_position_action:
+
+``stepper.report_position`` Action
+----------------------------------
+
+All steppers start out with a target and current position of ``0`` on boot. However, if you for example want to home
+a stepper motor, it can be useful to **report** the stepper where it is currently at.
+
+With this action, you can set the stepper's internal position counter to a specific value (in steps). Please note
+that reporting the position can create unexpected moves of the stepper. For example, if the stepper's target and
+current position is at 1000 steps and you "report" a position of 0, the stepper will move 1000 steps forward to match
+the target again.
+
+.. code:: yaml
+
+    on_...:
+      then:
+      - stepper.report_position:
+          id: my_stepper
+          position: 250
+      # It's best to call set_target directly after report_position, so that the stepper doesn't move
+      - stepper.set_target:
+          id: my_stepper
+          target: 250
+
+      # Templated
+      - stepper.report_position:
+          id: my_stepper
+          position: !lambda |-
+            if (id(my_binary_sensor).value) {
+              return 0;
+            } else {
+              return -1000;
+            }
+
+Configuration options:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
+- **target** (*Optional*, int, :ref:`templatable <config-templatable>`): The target position in steps.
+
+.. note::
+
+    This action can also be expressed as a :ref:`lambda <config-lambda>`:
+
+    .. code:: cpp
+
+        id(my_stepper).report_position(250);
+
+        // Get the current position:
+        int pos = id(my_stepper).current_position;
+
+See Also
+--------
+
+- :doc:`API Reference </api/misc/stepper>`
+- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/stepper.rst>`__
+
+.. disqus::

esphomeyaml/components/switch/index.rst

@@ -37,8 +37,7 @@ This action toggles a switch with the given ID when executed.
 
     on_...:
       then:
-        - switch.toggle:
-            id: relay_1
+        - switch.toggle: id: relay_1
 
 .. _switch-turn_on_action:
 
@@ -51,8 +50,7 @@ This action turns a switch with the given ID on when executed.
 
     on_...:
       then:
-        - switch.turn_on:
-            id: relay_1
+        - switch.turn_on: relay_1
 
 .. _switch-turn_off_action:
 
@@ -65,8 +63,7 @@ This action turns a switch with the given ID off when executed.
 
     on_...:
       then:
-        - switch.turn_off:
-            id: relay_1
+        - switch.turn_off: relay_1
 
 lambda calls
 ************