Add update_interval note

OttoWinter · OttoWinter · commit 0bafa4305540 · 2018-06-01T18:44:15.000+02:00
diff --git a/esphomeyaml/components/dallas.rst b/esphomeyaml/components/dallas.rst
@@ -28,7 +28,7 @@ Configuration variables:
 
 - **pin** (**Required**, number): The pin the sensor bus is connected to.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval that the sensors should be checked.
-  Defaults to 15 seconds.
+  Defaults to 15 seconds. See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 
 See Also
diff --git a/esphomeyaml/components/sensor/adc.rst b/esphomeyaml/components/sensor/adc.rst
@@ -27,7 +27,7 @@ Configuration variables:
 - **attenuation** (*Optional*): Only on ESP32. Specify the ADC
   attenuation to use. See :ref:`adc-esp32_attenuation`.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval
-  to check the sensor. Defaults to ``15s``.
+  to check the sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/components/sensor/ads1115.rst b/esphomeyaml/components/sensor/ads1115.rst
@@ -45,6 +45,8 @@ Configuration variables:
 -  **name** (**Required**, string): The name for this sensor.
 -  **ads1115_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
    :doc:`ADS1115 Hub </esphomeyaml/components/ads1115>` you want to use this sensor.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval
+  to check the sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 -  **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 
 Multiplexer And Gain
diff --git a/esphomeyaml/components/sensor/bh1750.rst b/esphomeyaml/components/sensor/bh1750.rst
@@ -34,7 +34,7 @@ Configuration variables:
 - **resolution** (*Optional*, string): The resolution of the sensor in lx. One of ``4.0``,
   ``1.0``, ``0.5``. Defaults to ``0.5`` (the maximum resolution).
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code
   generation.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
diff --git a/esphomeyaml/components/sensor/bme280.rst b/esphomeyaml/components/sensor/bme280.rst
@@ -64,7 +64,7 @@ Configuration variables:
 - **iir_filter** (*Optional*): Set up an Infinite Impulse Response filter to increase accuracy. One of
   ``OFF``, ``2x``, ``4x``, ``16x``. Defaults to ``OFF``.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 
 .. _bme280-oversampling:
 
diff --git a/esphomeyaml/components/sensor/bme680.rst b/esphomeyaml/components/sensor/bme680.rst
@@ -75,7 +75,7 @@ Configuration variables:
 - **iir_filter** (*Optional*): Set up an Infinite Impulse Response filter to increase accuracy. One of
   ``OFF``, ``2x``, ``4x``, ``16x``. Defaults to ``OFF``.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 
 .. _bme680-oversampling:
 
diff --git a/esphomeyaml/components/sensor/bmp085.rst b/esphomeyaml/components/sensor/bmp085.rst
@@ -51,7 +51,7 @@ Configuration variables:
 -  **address** (*Optional*, int): Manually specify the i^2c address of
    the sensor. Defaults to ``0x77``.
 -  **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-   sensor. Defaults to ``15s``.
+   sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 
 See Also
 ^^^^^^^^
diff --git a/esphomeyaml/components/sensor/dht.rst b/esphomeyaml/components/sensor/dht.rst
@@ -57,7 +57,7 @@ Configuration variables:
   one of ``AUTO_DETECT``, ``DHT11``, ``DHT22``, ``AM2303``, ``RHT03``
   and helps with some connection issues. Defaults to ``AUTO_DETECT``.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 
 .. note::
 
diff --git a/esphomeyaml/components/sensor/dht12.rst b/esphomeyaml/components/sensor/dht12.rst
@@ -45,6 +45,7 @@ Configuration variables:
   - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 
 See Also
 ^^^^^^^^
diff --git a/esphomeyaml/components/sensor/hdc1080.rst b/esphomeyaml/components/sensor/hdc1080.rst
@@ -47,6 +47,7 @@ Configuration variables:
   - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 
 Currently, the platform doesn’t support activating the built-in heater,
 as it seems to only be rarely of use. If you need it, please open an
diff --git a/esphomeyaml/components/sensor/htu21d.rst b/esphomeyaml/components/sensor/htu21d.rst
@@ -47,6 +47,7 @@ Configuration variables:
   - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 
 See Also
 ^^^^^^^^
diff --git a/esphomeyaml/components/sensor/index.rst b/esphomeyaml/components/sensor/index.rst
@@ -162,6 +162,23 @@ fahrenheit.
       - lambda: x * (9.0/5.0) + 32.0
     unit_of_measurement: "°F"
 
+.. _sensor-default_filter:
+
+Default Filter
+^^^^^^^^^^^^^^
+
+By default, esphomelib takes an average over the last 15 values before publishing updates.
+This was done in order to automatically decrease sensor noise.
+Therefore if you have an ``update_interval`` of 15 seconds, you will only see the values
+every 3 and a half minutes or so. To disable the default filter and publish all raw values
+directly, put an empty ``filters:`` block in your configuration:
+
+.. code:: yaml
+
+    sensor:
+      - platform: ...
+        filters:
+
 Sensor Automation
 ^^^^^^^^^^^^^^^^^
 
diff --git a/esphomeyaml/components/sensor/max6675.rst b/esphomeyaml/components/sensor/max6675.rst
@@ -39,6 +39,7 @@ Configuration variables:
 - **pin_clock** (**Required**): The Clock pin of the SPI interface.
 - **pin_miso** (**Required**): The Master-In/Slave-Out pin of the SPI interface.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for codegeneration.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/components/sensor/mpu6050.rst b/esphomeyaml/components/sensor/mpu6050.rst
@@ -65,6 +65,7 @@ Configuration variables:
 - **temperature** (*Optional*): Use the internal temperature of the sensor. All options from
   :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 
 See Also
diff --git a/esphomeyaml/components/sensor/pulse_counter.rst b/esphomeyaml/components/sensor/pulse_counter.rst
@@ -43,6 +43,7 @@ Configuration variables:
   Pulses <https://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/pcnt.html#filtering-pulses>`__
   for more information. Defaults to the max value 1023 or about 13 µs.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``15s``.
+  See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/components/sensor/sht3xd.rst b/esphomeyaml/components/sensor/sht3xd.rst
@@ -58,7 +58,7 @@ Configuration variables:
 - **accuracy** (*Optional*, string): The accuracy of the sensor. One of ``low``, ``medium`` and ``high``.
   Defaults to ``high``.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 
 See Also
 ^^^^^^^^
diff --git a/esphomeyaml/components/sensor/template.rst b/esphomeyaml/components/sensor/template.rst
@@ -32,7 +32,7 @@ Configuration variables:
 - **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
   Lambda to be evaluated every update interval to get the new value of the sensor
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 - **id** (*Optional*,:ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/components/sensor/tsl2561.rst b/esphomeyaml/components/sensor/tsl2561.rst
@@ -44,7 +44,7 @@ Configuration variables:
   formula for calculating the illuminance in lx. Set this to ``true`` if you're working with a CS
   package. Defaults to ``false``.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/components/sensor/ultrasonic.rst b/esphomeyaml/components/sensor/ultrasonic.rst
@@ -50,7 +50,7 @@ Configuration variables:
   the timeout. Use either this or ``timeout_meter``. Defaults to
   11662µs.
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
-  sensor. Defaults to ``15s``.
+  sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
 
diff --git a/esphomeyaml/index.rst b/esphomeyaml/index.rst
@@ -490,6 +490,8 @@ Misc Components
 Cookbook
 ^^^^^^^^
 
+This list contains items that are technically already supported by other components.
+
 ================================================== ================================================== ==================================================
 |Garage Door|_                                     |PIR Sensor|_                                      |Relay|_
 -------------------------------------------------- -------------------------------------------------- --------------------------------------------------
