diff --git a/Doxygen b/Doxygen index 15d72bf96..7adb10b35 100644 --- a/Doxygen +++ b/Doxygen @@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.11.0 +PROJECT_NUMBER = 1.11.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/Makefile b/Makefile index 05d8bd1d5..580bd47f3 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,10 @@ ESPHOME_CORE_PATH = ../esphome-core -ESPHOME_CORE_TAG = v1.11.0 +ESPHOME_CORE_TAG = v1.11.1 .PHONY: html cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png html: - sphinx-build -M html . _build $(O) + sphinx-build -M html . _build -W $(O) cleanhtml: rm -rf "_build/html/*" diff --git a/_static/version b/_static/version index 169f19b49..b0f61c56d 100644 --- a/_static/version +++ b/_static/version @@ -1 +1 @@ -1.11.0 \ No newline at end of file +1.11.1 \ No newline at end of file diff --git a/_templates/layout.html b/_templates/layout.html index 4aa3ffb0f..6b1bc0373 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -40,12 +40,12 @@ diff --git a/changelog/v1.11.0.rst b/changelog/v1.11.0.rst index 2a42865a4..a6657c5c4 100644 --- a/changelog/v1.11.0.rst +++ b/changelog/v1.11.0.rst @@ -75,6 +75,13 @@ I've made that a top priority for the next release, but I've hit some road block prevented it from working in a stable way for this release (and I needed to finally get this darn release out). +Release 1.11.1 - February 23 +---------------------------- + +- core: Fix addressable not updating light :corepr:`521` +- docs: Add Ethernet pin config for olimex esp32-poe board :docspr:`166` by :ghuser:`setola` +- docs: FAQ: Add description for mDNS support on different subnets :docspr:`169` by :ghuser:`Taigar2015` + Breaking Changes ---------------- @@ -82,7 +89,7 @@ Breaking Changes - Removed heartbeat filter from binary sensors :corepr:`454` - ``optimistic`` mode for template platforms has been split off into ``optimistic`` and ``assumed_state`` options :corepr:`455` -- ``run_cycles`` has been removed from deep_sleep :esphome:`353` +- ``run_cycles`` has been removed from deep_sleep :esphomepr:`353` Other notable changes: ---------------------- diff --git a/components/dallas.rst b/components/dallas.rst deleted file mode 100644 index 77ab14878..000000000 --- a/components/dallas.rst +++ /dev/null @@ -1,48 +0,0 @@ -Dallas Temperature Component -============================ - -.. seo:: - :description: Instructions for setting up dallas temperature sensor hubs that can expose many temperature sensors on a single pin using the one wire protocol. - :image: dallas.jpg - :keywords: Dallas, ds18b20, onewire - -The ``dallas`` component allows you to use your -`DS18b20 `__ -(`datasheet `__) -and similar One-Wire temperature sensors. - -To use your dallas sensor, first define a dallas “hub” with a pin and -id, which you will later use to create the sensors. The 1-Wire bus the -sensors are connected to should have an external pullup resistor of -about 4.7KΩ. For this, connect a resistor of *about* 4.7KΩ (values around that like 1Ω will, if you don't have -massively long wires, work fine in most cases) between ``3.3V`` and the data pin. - -.. code-block:: yaml - - # Example configuration entry - dallas: - - pin: 23 - - # Individual sensors - sensor: - - platform: dallas - address: 0x1c0000031edd2a28 - name: "Livingroom Temperature" - -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 60 seconds. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - -See Also --------- - -- :doc:`sensor/dallas` -- `Arduino DallasTemperature library `__ by `Miles Burton `__ -- :apiref:`sensor/dallas_component.h` -- :ghedit:`Edit` - -.. disqus:: diff --git a/components/i2c.rst b/components/i2c.rst index 8ee657f35..ba67509a7 100644 --- a/components/i2c.rst +++ b/components/i2c.rst @@ -4,12 +4,12 @@ I²C Bus ======= .. seo:: - :description: Instructions for setting up the i2c bus to communicate with 2-wire devices in ESPHome + :description: Instructions for setting up the I²C bus to communicate with 2-wire devices in ESPHome :image: i2c.png :keywords: i2c, iic, bus -This component sets up the i²c bus for your ESP32 or ESP8266. In order for those components -to work correctly, you need to define the i²c bus in your configuration. Please note the ESP +This component sets up the I²C bus for your ESP32 or ESP8266. In order for those components +to work correctly, you need to define the I²C bus in your configuration. Please note the ESP will enable its internal 10kΩ pullup resistors for these pins, so you usually don't need to put on external ones. @@ -24,20 +24,20 @@ put on external ones. Configuration variables: ------------------------ -- **sda** (*Optional*, :ref:`config-pin`): The pin for the data line of the i²c bus. +- **sda** (*Optional*, :ref:`config-pin`): The pin for the data line of the I²C bus. Defaults to the default of your board (usually GPIO21 for ESP32 and GPIO4 for ESP8266). -- **scl** (*Optional*, :ref:`config-pin`): The pin for the clock line of the i²c bus. +- **scl** (*Optional*, :ref:`config-pin`): The pin for the clock line of the I²C bus. Defaults to the default of your board (usually GPIO22 for ESP32 and GPIO5 for ESP8266). -- **scan** (*Optional*, boolean): If ESPHome should do a search of the i2c address space on startup. +- **scan** (*Optional*, boolean): If ESPHome should do a search of the I²C address space on startup. Note that this can slow down startup and is only recommended for when setting up new sensors. Defaults to ``False``. -- **frequency** (*Optional*, float): Set the frequency the i²c bus should operate on. - Defaults to ``50KHz``. Values are ``50KHz``, ``100KHz``, ``200KHz``, ... ``800KHz`` +- **frequency** (*Optional*, float): Set the frequency the I²C bus should operate on. + Defaults to ``50kHz``. Values are ``50kHz``, ``100kHz``, ``200kHz``, ... ``800kHz`` .. note:: - If you're using the ESP32 and i2c frequently is showing errors in the logs, try with the latest + If you're using the ESP32 and I²C frequently is showing errors in the logs, try with the latest version of the Arduino framework. See :ref:`esphome-arduino_version` for information on how to do this. See Also diff --git a/components/sensor/dallas.rst b/components/sensor/dallas.rst index 7873d5fe0..263e36384 100644 --- a/components/sensor/dallas.rst +++ b/components/sensor/dallas.rst @@ -2,12 +2,53 @@ Dallas Temperature Sensor ========================= .. seo:: - :description: Instructions for setting up DS18b20 and similar temperature sensors + :description: Instructions for setting up dallas temperature sensor hubs that can expose many temperature sensors on a single pin using the one wire protocol. :image: dallas.jpg - :keywords: dallas, ds18b20 + :keywords: Dallas, ds18b20, onewire + +.. _dallas-component: + +Component/Hub +------------- + +The ``dallas`` component allows you to use your +`DS18b20 `__ +(`datasheet `__) +and similar One-Wire temperature sensors. + +To use your :ref:`dallas sensor `, first define a dallas “hub” with a pin and +id, which you will later use to create the sensors. The 1-Wire bus the +sensors are connected to should have an external pullup resistor of +about 4.7KΩ. For this, connect a resistor of *about* 4.7KΩ (values around that like 1Ω will, if you don't have +massively long wires, work fine in most cases) between ``3.3V`` and the data pin. + +.. code-block:: yaml + + # Example configuration entry + dallas: + - pin: 23 + + # Individual sensors + sensor: + - platform: dallas + address: 0x1c0000031edd2a28 + name: "Livingroom Temperature" + +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 60 seconds. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. + +.. _dallas-sensor: + +Sensors +------- The ``dallas`` sensor allows you to use ds18b20 and similar sensors. -First, you need to define a :doc:`dallas sensor component `. +First, you need to define a :ref:`dallas sensor component `. The dallas sensor component (or "hub") is an internal model that defines which pins the ds18b20 sensors are connected to. This is because with these sensors you can actually connect multiple sensors to a single pin and use them all at once. @@ -39,7 +80,7 @@ To initialize a sensor, first supply either ``address`` **or** ``index`` to iden name: "Living Room Temperature" Configuration variables: ------------------------- +************************ - **address** (**Required**, int): The address of the sensor. Use either this option or index. @@ -48,7 +89,7 @@ Configuration variables: to use address instead `. - **resolution** (*Optional*, int): An optional resolution from 8 to 12. Higher means more accurate. Defaults to the maximum for most dallas temperature sensors: 12. -- **dallas_id** (*Optional*, :ref:`config-id`): The ID of the :doc:`dallas hub `. +- **dallas_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`dallas hub `. Use this if you have multiple dallas hubs. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. @@ -56,7 +97,7 @@ Configuration variables: .. _dallas-getting-ids: Getting Sensor IDs ------------------- +****************** It is highly recommended to use the ``address`` attribute for creating dallas sensors, because if you have multiple sensors on a bus and the @@ -106,7 +147,6 @@ See Also -------- - :ref:`sensor-filters` -- :doc:`/components/dallas` - :doc:`max6675` - `Arduino DallasTemperature library `__ by `Miles Burton `__ - :apiref:`sensor/dallas_component.h` diff --git a/components/sensor/rotary_encoder.rst b/components/sensor/rotary_encoder.rst index d70f709e8..3eb85b19d 100644 --- a/components/sensor/rotary_encoder.rst +++ b/components/sensor/rotary_encoder.rst @@ -47,6 +47,13 @@ Configuration variables: - **pin_reset** (*Optional*, :ref:`Pin Schema `): An optional pin that resets the step value. This is useful with rotary encoders that have have a third pin. Defaults to no reset pin. +- **resolution** (*Optional*, string): The resolution of the sensor, this controls how many + pulses are generated by one step: + + - 1 (default) + - 2 + - 4 + - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. diff --git a/components/sensor/ultrasonic.rst b/components/sensor/ultrasonic.rst index ef08b361b..6d5f96084 100644 --- a/components/sensor/ultrasonic.rst +++ b/components/sensor/ultrasonic.rst @@ -78,7 +78,7 @@ To remove ``NAN`` values from the sensor stream, use the ``filter_nan`` :ref:`se echo_pin: D2 name: "Ultrasonic Sensor" filters: - - + - filter_nan: See Also diff --git a/conf.py b/conf.py index 4603c7ecc..bec14ad1b 100644 --- a/conf.py +++ b/conf.py @@ -73,7 +73,7 @@ author = 'Otto Winter' # The short X.Y version. version = '1.11' # The full version, including alpha/beta/rc tags. -release = '1.11.0' +release = '1.11.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/devices/sonoff.rst b/devices/sonoff.rst index cf3ea2c6b..ebf3aa160 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -288,7 +288,7 @@ Sonoff S31 GPIO0, Button (inverted), GPIO12, Relay and Red LED, - GPIO13, Green LED (inverteD), + GPIO13, Green LED (inverted), See :doc:`/components/sensor/cse7766` for measuring power @@ -309,7 +309,24 @@ Shelly 2 GPIO5, Relay #2, GPIO12, SW Input #1, GPIO14, SW Input #2, - + +Teckin +------ + +.. pintable:: + + GPIO1, Button (inverted), + GPIO3, Blue LED (inverted), + GPIO13, Red LED (inverted), + GPIO14, Relay, + + GPIO12, HLW8012 SEL Pin (inverted), + GPIO4, HLW8012 CF Pin, + GPIO5, HLW8012 CF1 Pin, + +See :doc:`/components/sensor/hlw8012` for measuring power. +Example config: `teckin.yaml `__ + See Also -------- diff --git a/devices/sonoff_4ch.rst b/devices/sonoff_4ch.rst index f57fd2b40..bb6380145 100644 --- a/devices/sonoff_4ch.rst +++ b/devices/sonoff_4ch.rst @@ -295,7 +295,7 @@ them in one area, and simply pass that ID later on. For example, above you can s output being created with the ID ``blue_led`` for the blue LED. Later on it is then transformed into a :doc:`monochromatic light `. If you additionally want the buttons to control the relays, look at `the complete Sonoff 4CH -with automation example `__. +with automation example `__. .. figure:: images/sonoff_4ch_result.png :align: center diff --git a/devices/teckin.yaml b/devices/teckin.yaml new file mode 100644 index 000000000..7a71625b9 --- /dev/null +++ b/devices/teckin.yaml @@ -0,0 +1,68 @@ +esphome: + name: '' + platform: ESP8266 + board: esp01_1m + +wifi: + ssid: '' + password: '' + +logger: + # Disable UART logging (pins GPIO1/3 are used for button/led) + baud_rate: 0 + +# Enable Home Assistant API +api: + +ota: + +binary_sensor: + - platform: gpio + name: "Teckin Button" + pin: + number: GPIO1 + mode: INPUT_PULLUP + inverted: True + on_press: + - switch.toggle: relay + +switch: +- platform: gpio + id: blue_led + pin: + number: GPIO13 + inverted: True +- platform: gpio + name: "Teckin Relay" + pin: GPIO14 + id: relay + on_turn_on: + - switch.turn_on: blue_led + on_turn_off: + - switch.turn_off: blue_led + +# Use red LED for connectivity status indicator +status_led: + pin: + number: GPIO3 + inverted: True + +sensor: + - platform: hlw8012 + sel_pin: + number: GPIO12 + inverted: True + cf_pin: GPIO04 + cf1_pin: GPIO05 + # Higher value gives lower watt readout + current_resistor: 0.00221 + # Lower value gives lower voltage readout + voltage_divider: 871 + current: + name: "Teckin Current" + accuracy_decimals: 2 + voltage: + name: "Teckin Voltage" + power: + name: "Teckin Power" + update_interval: 15s diff --git a/index.rst b/index.rst index 0ea317f50..8459f5e5c 100644 --- a/index.rst +++ b/index.rst @@ -252,7 +252,6 @@ Misc Components .. imgtable:: - Dallas Hub, components/dallas, dallas.jpg Remote Transmitter Hub, components/remote_transmitter, remote.svg Remote Receiver Hub, components/remote_receiver, remote.svg PCA9685 Hub, components/pca9685, pca9685.jpg