Add missing pages
This commit is contained in:
Otto Winter
parent
6a83179656
commit
95c042744b
|
|
@ -14,6 +14,8 @@ Changelog - Version 1.12.0
|
|||
SDS011, components/sensor/sds011, sds011.jpg
|
||||
ESP32 Camera, components/esp32_camera, camera.svg
|
||||
Servo, components/servo, servo.svg
|
||||
MCP23017, components/mcp23017, mcp23017.svg
|
||||
WiFi Info, components/text_sensor/wifi_info, network-wifi.svg
|
||||
|
||||
TODO
|
||||
|
||||
|
|
@ -21,14 +23,29 @@ TODO
|
|||
Breaking Changes
|
||||
----------------
|
||||
|
||||
TODO - No major ones though (+ all handled through validation error messages)
|
||||
- The ``timeout_meter`` and ``timeout_time`` options of the ultrasonic sensor
|
||||
have been merged into ``timeout``. (:doc:`/components/sensor/ultrasonic`)
|
||||
- Ultrasonic Sensor no longer works with GPIO16 as echo pin on ESP8266s because
|
||||
the implementation switched to an asynchronous interrupt mode.
|
||||
|
||||
Other notable changes:
|
||||
----------------------
|
||||
|
||||
- Added ``calibrate_linear`` sensor filter for easier calibration of sensors
|
||||
(:ref:`sensor-filter-calibrate_linear`)
|
||||
- Added ``for`` parameter :ref:`binary_sensor.is_on <binary_sensor-is_on_condition>` condition.
|
||||
- Added ``for`` parameter to :ref:`binary_sensor.is_on <binary_sensor-is_on_condition>` condition.
|
||||
- Added ``streamer_mode``, ``status_use_ping`` and ``relative_url`` options to the Hass.io addon
|
||||
(see addon description).
|
||||
- Improved validation. For small typos for config variables similar keys are automatically
|
||||
suggested.
|
||||
- Added ``esp8266_restore_from_flash`` to :doc:`esphome section </components/esphome>` which
|
||||
enables restoring state from flash instead of RTC memory - this allows recovering relay state
|
||||
even after a power cycle.
|
||||
- ``!secret`` values are now hidden for config validation.
|
||||
- Rotary Encoders have a new ``min_value`` and ``max_value`` option. (:doc:`/components/sensor/rotary_encoder`)
|
||||
- Fixed OTA not working for ESP32 when BLE enabled.
|
||||
- Allowed the use of newest Arduino Core version for ESP8266: ``2.5.0`` (not default yet,
|
||||
please try it out on non-critical devices and report if there are no wifi issues)
|
||||
|
||||
All changes
|
||||
-----------
|
||||
|
|
|
|||
|
|
@ -162,12 +162,15 @@ option you can tell ESPHome which arduino framework to use for compiling.
|
|||
For the ESP8266, you currently can manually pin the arduino version to these values (see the full
|
||||
list of arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):
|
||||
|
||||
* `2.4.2 <https://github.com/esp8266/Arduino/releases/tag/2.4.2>`__ (the latest version)
|
||||
* `2.5.0 <https://github.com/esp8266/Arduino/releases/tag/2.5.0>`__
|
||||
* `2.4.2 <https://github.com/esp8266/Arduino/releases/tag/2.4.2>`__ (default)
|
||||
* `2.4.1 <https://github.com/esp8266/Arduino/releases/tag/2.4.1>`__
|
||||
* `2.4.0 <https://github.com/esp8266/Arduino/releases/tag/2.4.0>`__
|
||||
|
||||
For the ESP32, there's currently only one arduino framework version:
|
||||
`1.0.0 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.0>`__.
|
||||
For the ESP32, there are two arduino framework versions:
|
||||
|
||||
- `1.0.1 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.1>`__ (default).
|
||||
- `1.0.0 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.0>`__.
|
||||
|
||||
.. _esphome-on_boot:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
MCP23017 I/O Expander
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MCP23017 digital port expanders in ESPHome.
|
||||
:image: mcp23017.png
|
||||
|
||||
The MCP23017 component allows you to use MCP23017 I/O expanders
|
||||
(`datasheet <http://ww1.microchip.com/downloads/en/devicedoc/20001952c.pdf>`__,
|
||||
`Adafruit <https://www.adafruit.com/product/732>`__) in ESPHome.
|
||||
It uses the :ref:`I²C Bus <i2c>` for communication.
|
||||
|
||||
Once configured, you can use any of the 16 pins as
|
||||
pins for your projects. Within ESPHome they emulate a real internal GPIO pin
|
||||
and can therefore be used with many of ESPHome's components such as the GPIO
|
||||
binary sensor or GPIO switch.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
mcp23017:
|
||||
- id: 'mcp23017_hub'
|
||||
address: 0x20
|
||||
|
||||
# Individual outputs
|
||||
switch:
|
||||
- platform: gpio
|
||||
name: "MCP23017 Pin #0"
|
||||
pin:
|
||||
mcp23017: mcp23017_hub
|
||||
# Use pin number 0
|
||||
number: 0
|
||||
# One of INPUT, INPUT_PULLUP or OUTPUT
|
||||
mode: OUTPUT
|
||||
inverted: False
|
||||
|
||||
Configuration variables:
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- **id** (**Required**, :ref:`config-id`): The id to use for this MCP23017 component.
|
||||
- **address** (*Optional*, int): The I²C address of the driver.
|
||||
Defaults to ``0x21``.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :ref:`i2c`
|
||||
- :doc:`switch/gpio`
|
||||
- :doc:`binary_sensor/gpio`
|
||||
- :apiref:`io/mcp23017.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
.. disqus::
|
||||
|
|
@ -4,7 +4,6 @@ PCF8574 I/O Expander
|
|||
.. seo::
|
||||
:description: Instructions for setting up PCF8574 digital port expanders in ESPHome.
|
||||
:image: pcf8574.jpg
|
||||
:keywords: Xiaomi, Mi Flora, BLE, Bluetooth
|
||||
|
||||
The PCF8574 component allows you to use PCF8574 or PCF8575 I/O expanders
|
||||
(`datasheet <http://www.ti.com/lit/ds/symlink/pcf8574.pdf>`__,
|
||||
|
|
|
|||
|
|
@ -55,29 +55,12 @@ Configuration variables:
|
|||
- 4
|
||||
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- **min_value** (*Optional*, int): The minimum value this rotary encoder will go to, turning
|
||||
the knob further will not decrease the number. Defaults to no minimum.
|
||||
- **max_value** (*Optional*, int): The maximum value this rotary encoder will go to, turning
|
||||
the knob further will not increase the number. Defaults to no maximum.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
Debouncing Output
|
||||
-----------------
|
||||
|
||||
This sensor can output a lot of values in a short period of time when turning the knob.
|
||||
In order to not put too much stress on your network connection, you can leverage ESPHome's
|
||||
sensor filters. The following will only send out values if the last input value is at least
|
||||
0.1s seconds old *or* if the new rotary encoder value has changed by 10 from the previous value.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
sensor:
|
||||
- platform: rotary_encoder
|
||||
name: "Rotary Encoder"
|
||||
pin_a: D1
|
||||
pin_b: D2
|
||||
filters:
|
||||
- or:
|
||||
- debounce: 0.1s
|
||||
- delta: 10
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
|
|
|||
|
|
@ -18,9 +18,7 @@ This sensor platform expects a sensor that can be sent a **trigger
|
|||
pulse** on a specific pin and will send out a **echo pulse** once a
|
||||
measurement has been taken. Because sometimes (for example if no object
|
||||
is detected) the echo pulse is never returned, this sensor also has a
|
||||
timeout option which specifies how long to wait for values. During this
|
||||
timeout period the whole core will be blocked and therefore shouldn't be
|
||||
set too high.
|
||||
timeout option which specifies how long to wait for values.
|
||||
|
||||
.. figure:: images/ultrasonic-full.jpg
|
||||
:align: center
|
||||
|
|
@ -49,37 +47,13 @@ Configuration variables:
|
|||
- **echo_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The input pin on which to
|
||||
wait for the echo.
|
||||
- **name** (**Required**, string): The name of the sensor.
|
||||
- **timeout_meter** (*Optional*, float): The number of meters for the
|
||||
timeout. Use either this or ``timeout_time``. Defaults to 2 meters.
|
||||
- **timeout_time** (*Optional*, int): The number of microseconds for
|
||||
the timeout. Use either this or ``timeout_meter``. Defaults to
|
||||
11662µs.
|
||||
- **timeout** (*Optional*, float): The number of meters for the
|
||||
timeout. Most sensors can only sense up to 2 meters. Defaults to 10 meters.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||
sensor. Defaults to ``60s``.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- All other options from :ref:`Sensor <config-sensor>`.
|
||||
|
||||
Ultrasonic Timeouts
|
||||
-------------------
|
||||
|
||||
The ultrasonic sensor works by sending a small ultrasonic pulse out and then waiting until
|
||||
the pulse arrives back. However, there are cases where no such signal arrives back. This is most commonly caused
|
||||
by either having the sensor pointed at a soft surface that muffles the incoming signal. The other case where this
|
||||
can happen is when the the object is too far away and the timeout set by the ``timeout_meter`` or ``timeout_time``
|
||||
option kicks in.
|
||||
|
||||
To remove ``NAN`` values from the sensor stream, use the ``filter_nan`` :ref:`sensor filter <sensor-filters>`:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
sensor:
|
||||
- platform: ultrasonic
|
||||
trigger_pin: D1
|
||||
echo_pin: D2
|
||||
name: "Ultrasonic Sensor"
|
||||
filters:
|
||||
- filter_nan:
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
WiFi Info Text Sensor
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up wifi info text sensors.
|
||||
:image: network-wifi.png
|
||||
|
||||
The ``wifi_info`` text sensor platform exposes different wifi information
|
||||
via text sensors.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
text_sensor:
|
||||
- platform: wifi_info
|
||||
ip_address:
|
||||
name: ESP IP Address
|
||||
ssid:
|
||||
name: ESP Connected SSID
|
||||
bssid:
|
||||
name: ESP Connected BSSID
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **ip_address** (*Optional*): Expose the IP Address of the ESP as a text sensor. All options from
|
||||
:ref:`Text Sensor <config-text_sensor>`.
|
||||
- **ssid** (*Optional*): Expose the SSID of the currently connected WiFi network as a text sensor. All options from
|
||||
:ref:`Text Sensor <config-text_sensor>`.
|
||||
- **bssid** (*Optional*): Expose the BSSID of the currently connected WiFi network as a text sensor. All options from
|
||||
:ref:`Text Sensor <config-text_sensor>`.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :apiref:`text_sensor/wifi_info.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
.. disqus::
|
||||
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" height="61.333" width="301.333"><path d="M19.333.8H282c10.31 0 18.667 8.357 18.667 18.667V40.8c0 10.31-8.358 18.667-18.667 18.667H19.333C9.024 59.467.667 51.109.667 40.8V19.467C.667 9.157 9.024.8 19.333.8z"/><path d="M19.333.8H282c10.31 0 18.667 8.357 18.667 18.667V40.8c0 10.31-8.358 18.667-18.667 18.667H19.333C9.024 59.467.667 51.109.667 40.8V19.467C.667 9.157 9.024.8 19.333.8z" fill="none" stroke="#000" stroke-width="1.3333" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10"/><g aria-label="MCP23017" fill="#fff"><path d="M41.687 46.8l-.094-14.887L34.5 43.86h-4.853l-7.094-11.433V46.8H12.52V14.133h9.053l10.64 17.407 10.36-17.407h9.054L51.72 46.8zM77.933 47.547q-5.18 0-9.333-2.147-4.153-2.193-6.533-6.067-2.334-3.92-2.334-8.866 0-4.947 2.334-8.82 2.38-3.92 6.533-6.067 4.153-2.193 9.333-2.193 4.76 0 8.494 1.68 3.733 1.68 6.16 4.853l-6.954 6.207Q82.6 22.3 78.493 22.3q-3.453 0-5.553 2.24-2.1 2.193-2.1 5.927 0 3.733 2.1 5.973 2.1 2.193 5.553 2.193 4.107 0 7.14-3.826l6.954 6.206q-2.427 3.174-6.16 4.854-3.734 1.68-8.494 1.68zM115.487 14.133q4.526 0 7.886 1.494 3.36 1.493 5.18 4.293 1.82 2.8 1.82 6.533 0 3.734-1.82 6.534t-5.18 4.293q-3.36 1.493-7.886 1.493h-4.714V46.8H99.76V14.133zm-.7 16.147q2.24 0 3.36-.98 1.12-1.027 1.12-2.847t-1.12-2.8q-1.12-1.026-3.36-1.026h-4.014v7.653zM162.98 38.26v8.54H136.8v-6.767l11.807-10.92q1.54-1.446 2.053-2.473.513-1.027.513-2.007 0-1.213-.84-1.866-.793-.7-2.333-.7-1.493 0-2.8.793-1.307.793-2.007 2.24l-8.306-4.153q1.866-3.5 5.46-5.507 3.593-2.053 8.68-2.053 3.873 0 6.86 1.26 2.986 1.26 4.666 3.593 1.68 2.333 1.68 5.367 0 2.706-1.166 5.086-1.12 2.334-4.434 5.32l-4.666 4.247zM187.56 27.06q3.78.933 5.787 3.407 2.053 2.426 2.053 5.88 0 2.94-1.633 5.506-1.587 2.52-4.947 4.107-3.36 1.587-8.353 1.587-3.454 0-6.907-.747-3.407-.747-5.973-2.193l3.733-8.12q2.007 1.166 4.293 1.773 2.334.607 4.48.607 1.914 0 3.08-.654 1.167-.653 1.167-1.866 0-2.24-3.873-2.24h-4.34V27.34l4.806-4.9h-11.666v-8.307h24.36V20.9zM216.713 47.547q-4.34 0-7.7-2.007-3.313-2.053-5.226-5.88-1.867-3.873-1.867-9.193 0-5.32 1.867-9.147 1.913-3.873 5.226-5.88 3.36-2.053 7.7-2.053t7.654 2.053q3.36 2.007 5.226 5.88 1.914 3.827 1.914 9.147t-1.914 9.193q-1.866 3.827-5.226 5.88-3.314 2.007-7.654 2.007zm0-8.82q3.734 0 3.734-8.26t-3.734-8.26q-3.733 0-3.733 8.26t3.733 8.26zM253.24 14.133V46.8h-11.013V22.44h-5.6v-8.307zM288.833 14.133V20.9L277.96 46.8h-12.04l10.36-24.127h-6.3v4.76h-9.1v-13.3z"/></g></svg>
|
||||
|
After Width: | Height: | Size: 2.4 KiB |
|
|
@ -247,6 +247,7 @@ Text Sensor Components
|
|||
Home Assistant, components/text_sensor/homeassistant, home-assistant.svg
|
||||
MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png
|
||||
Version, components/text_sensor/version, new-box.svg
|
||||
WiFi Info, components/text_sensor/wifi_info, network-wifi.svg
|
||||
Template Text Sensor, components/text_sensor/template, description.svg
|
||||
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
|
||||
|
||||
|
|
@ -257,6 +258,7 @@ Misc Components
|
|||
|
||||
Debug Component, components/debug, bug-report.svg
|
||||
PCF8574 I/O Expander, components/pcf8574, pcf8574.jpg
|
||||
MCP23017 I/O Expander, components/mcp23017, mcp23017.svg
|
||||
ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg
|
||||
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
|
||||
Status LED, components/status_led, led-on.svg
|
||||
|
|
|
|||
Loading…
Reference in New Issue