diff --git a/esphomeyaml/guides/automations.rst b/esphomeyaml/guides/automations.rst index 9ac543d42..51df07406 100644 --- a/esphomeyaml/guides/automations.rst +++ b/esphomeyaml/guides/automations.rst @@ -249,6 +249,21 @@ we're retrieving the current state of the end stop using ``.value`` and using it ESP_LOGD("main", "I am at execution number %d", num_executions); num_executions += 1; +.. tip:: + + In some occasions, it can be useful to manually trigger an update for a component. You can do so like this: + + .. code:: yaml + + sensor: + - platform: ... + # ... + id: my_sensor + + # ... + on_...: + lambda: 'id(my_sensor).update();' + .. _config-templatable: Bonus: Templating Actions diff --git a/esphomeyaml/guides/changelog.rst b/esphomeyaml/guides/changelog.rst index e7694e620..8b1ab08c4 100644 --- a/esphomeyaml/guides/changelog.rst +++ b/esphomeyaml/guides/changelog.rst @@ -5,21 +5,21 @@ Version 1.8.0 ------------- ================================================== ================================================== ================================================== -|SPI Bus|_ |UART Bus|_ |Time|_ --------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -`SPI Bus`_ `UART Bus`_ `Time`_ --------------------------------------------------- -------------------------------------------------- -------------------------------------------------- |Waveshare E-Paper|_ |Nextion|_ |SSD1306|_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- `Waveshare E-Paper`_ `Nextion`_ `SSD1306`_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -|MAX7219|_ |LCD Display|_ |Uptime Sensor|_ +|MAX7219|_ |LCD Display|_ |RCSwitch Integration|_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -`MAX7219`_ `LCD Display`_ `Uptime Sensor`_ +`MAX7219`_ `LCD Display`_ `RCSwitch Integration`_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -|RCSwitch Integration|_ |PN532|_ |RDM6300|_ +|SPI Bus|_ |UART Bus|_ |RTC Time|_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -`RCSwitch Integration`_ `PN532`_ `RDM6300`_ +`SPI Bus`_ `UART Bus`_ `RTC Time`_ +-------------------------------------------------- -------------------------------------------------- -------------------------------------------------- +|Uptime Sensor|_ |PN532|_ |RDM6300|_ +-------------------------------------------------- -------------------------------------------------- -------------------------------------------------- +`Uptime Sensor`_ `PN532`_ `RDM6300`_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- |BLE RSSI|_ |Xiaomi MiFlora|_ |Xiaomi MiJia|_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- @@ -37,20 +37,11 @@ Version 1.8.0 -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- `MH-Z19`_ `MS5611`_ `TCS34725`_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -|RGBWW Light|_ |Cold+Warm White Light|_ |Light Effect|_ +|RGBWW Light|_ |Cold+Warm White Light|_ |Light Effects|_ -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -`RGBWW Light`_ `Cold+Warm White Light`_ `Light Effect`_ +`RGBWW Light`_ `Cold+Warm White Light`_ `Light Effects`_ ================================================== ================================================== ================================================== -.. |SPI Bus| image:: /esphomeyaml/images/spi.svg - :class: component-image -.. _SPI Bus: /esphomeyaml/components/spi.html -.. |UART Bus| image:: /esphomeyaml/images/uart.svg - :class: component-image -.. _UART Bus: /esphomeyaml/components/uart.html -.. |Time| image:: /esphomeyaml/images/clock-outline.svg - :class: component-image -.. _Time: /esphomeyaml/components/time.html .. |Waveshare E-Paper| image:: /esphomeyaml/images/waveshare_epaper.jpg :class: component-image .. _Waveshare E-Paper: /esphomeyaml/components/display/waveshare_epaper.html @@ -66,12 +57,21 @@ Version 1.8.0 .. |LCD Display| image:: /esphomeyaml/images/lcd.jpg :class: component-image .. _LCD Display: /esphomeyaml/components/display/lcd_gpio.html +.. |RCSwitch Integration| image:: /esphomeyaml/images/remote.svg + :class: component-image +.. _RCSwitch Integration: /esphomeyaml/components/switch/remote_transmitter.html#rcswitch-remote-codes.html +.. |SPI Bus| image:: /esphomeyaml/images/spi.svg + :class: component-image +.. _SPI Bus: /esphomeyaml/components/spi.html +.. |UART Bus| image:: /esphomeyaml/images/uart.svg + :class: component-image +.. _UART Bus: /esphomeyaml/components/uart.html +.. |RTC Time| image:: /esphomeyaml/images/clock-outline.svg + :class: component-image +.. _RTC Time: /esphomeyaml/components/time.html .. |Uptime Sensor| image:: /esphomeyaml/images/timer.svg :class: component-image .. _Uptime Sensor: /esphomeyaml/components/sensor/uptime.html -.. |RCSwitch Integration| image:: /esphomeyaml/images/remote.svg - :class: component-image -.. _RCSwitch Integration: /esphomeyaml/components/remote_transmitter.html .. |PN532| image:: /esphomeyaml/images/pn532.jpg :class: component-image .. _PN532: /esphomeyaml/components/pn532.html @@ -120,9 +120,90 @@ Version 1.8.0 .. |Cold+Warm White Light| image:: /esphomeyaml/images/brightness-medium.svg :class: component-image .. _Cold+Warm White Light: /esphomeyaml/components/light/cwww.html -.. |Light Effect| image:: /esphomeyaml/images/creation.svg +.. |Light Effects| image:: /esphomeyaml/images/creation.svg :class: component-image -.. _Light Effect: /esphomeyaml/components/light/index.html +.. _Light Effects: /esphomeyaml/components/light/index#light-effects.html + +Hi everyone, + +Today I have a new version of esphomelib with lots of new features and tons of time put in to present to you and +I hope you're as excited as I am to try these new things out :) + +This release mainly focuses on these new features: + +- Lots of Bug Fixes - Now that most of the hardware has arrived from china, I was able to fix a bunch + of bugs with a lot of integrations. +- :doc:`Displays! ` +- NFC/RFID Readers (:doc:`PN532 ` and :doc:`RDM6300 `) +- New :doc:`ESP32 BLE integrations ` like :doc:`Xiaomi MiFlora ` +- Core Changes like the addition of the :ref:`SPI bus ` and :ref:`UART bus ` +- Lots of new ::ref:`light effects ` and support for cold-white/warm-white lights. + +And if you find esphomelib great and have some of your projects using it, please do spread the word online +(like `Christoph Dahlen did `__) +and/or create :ref:`cookbook ` entries so that others can learn from your work. Of course the main objective +of this website is to document esphomelib's features, but my vision is that it also inspires others to start +awesome projects ☀️ + +Special thanks to all the contributors for this release: + +- `@exxamalte `__ +- `@per1234 `__ +- `@nunofgs `__ +- `@lobradov `__ +- `@janpieper `__ +- `@aequitas `__ +- And last but not least: `@brandond `__ for his awesome work on the new + time component + +And in more personal news, I'm currently getting ready for my trip to Japan 🇯🇵 to represent Austria +in this years `international olympiad in informatics (IOI) `__ (hence also the relatively +short release notes). If you'll be attending too, come say hi :) + +Other notable changes +********************* + +- Fixed certain occasions where esphomeyaml could run into recursive dependencies +- Fixed i2c scans not showing up via MQTT +- Improved build times by about 60%. Now, the build time should depend on the amount of components you're using, not the total esphomelib code base size. +- Fixed ESP32 Touch setup mode +- Fixed template binary sensors +- Added the option to specify ``never`` for ``update_interval`` to never +- Added ``deep_sleep.prevent`` and ``deep_sleep.enter`` actions +- Fixed ESP32BLETracker surpassing the maximum code size +- Fixed ESP32BLETracker/Beacon throwing an exception when a warning occurs. +- Fixed FastLED effects not taking into account the light brightness +- Fixed compatability with Arduino core versions below 2.0.4 +- Added ``output.turn_on``, ``output.turn_off`` and ``output.set_level`` actions. +- Fixed the remote transmitter/receiver using the heap inefficiently on the ESP8266 (was causing reboots) +- Fixed reliability with reading data from BME280s +- Fixed gas resistance readings from BME680s +- Fixed HTU21D readings only working in very verbose mode +- Sometimes the ESP would create a WiFi hotspot even though it was not configured to do so. That should be fixed now. +- In actions, instead of + + .. code:: yaml + + on_...: + switch.turn_on: + id: my_switch + + You can now write: + + .. code:: yaml + + on_...: + switch.turn_on: my_switch +- You can now also have conditional actions. See !IF_ACTION! +- The esphomeyaml dashboard and HassIO add-on now can be configured with a password. +- Fixed YAML anchors not working (you can now prefix keys with ``.`` to make esphomeyaml ignore them) +- Made Dallas and DHT temperature sensor a bit more reliable by making the code a bit more efficient and thus resolving some timing issues. + +Breaking Changes +**************** + +- Light Effects now need to be manually declared in the config and will no longer show up automatically. Please see :ref:`light-effects` +- MAX6675 has been migrated to use the new SPI bus (and fixed!). Please see the docs for how to use it now. Version 1.7.0 ------------- @@ -175,7 +256,7 @@ be travelling a lot (and enjoying my vacation 😎), so don't expect too many aw .. _Remote Receiver: /esphomeyaml/components/binary_sensor/remote_receiver.html New Components -~~~~~~~~~~~~~~ +************** - New :doc:`WiFi signal strength sensor ` by `@brandond `__. So now you can monitor how strong the WiFi signal is for your node 📶 @@ -203,7 +284,7 @@ New Components :ref:`this guide `, but in the future more protocols will be supported out of the box. New Features -~~~~~~~~~~~~ +************ - While all :ref:`automations ` were previously already performed on the ESP itself, they only triggered when an active WiFi and MQTT connection existed. Large parts of the WiFi and MQTT clients has now @@ -233,7 +314,7 @@ New Features esphomeyaml stores the platformio project files. See :doc:`/esphomeyaml/components/esphomeyaml`. Breaking Changes -~~~~~~~~~~~~~~~~ +**************** - Fixed the :doc:`SHT3x-D ` component and removed the ``accuracy`` parameter. The accuracy now defaults to ``HIGH``. @@ -271,7 +352,7 @@ Breaking Changes :ref:`time ` units. Other Contributions -~~~~~~~~~~~~~~~~~~~ +------------------- (Not in any order and probably missed some, still figuring this changelog stuff out...) diff --git a/esphomeyaml/guides/getting_started_hassio.rst b/esphomeyaml/guides/getting_started_hassio.rst index 5a7059087..1505768d0 100644 --- a/esphomeyaml/guides/getting_started_hassio.rst +++ b/esphomeyaml/guides/getting_started_hassio.rst @@ -88,7 +88,7 @@ upload button. HassIO add-on options ~~~~~~~~~~~~~~~~~~~~~ -Since version 1.7.0, you can optionally specify a password to use for all traffic to esphomeyaml +Since version 1.8.0, you can optionally specify a password to use for all traffic to esphomeyaml using the ``password`` option in the HassIO add-on page. By default, this is an empty string (which means no password), but you can enter any string in there to set your password. diff --git a/esphomeyaml/index.rst b/esphomeyaml/index.rst index db37d051b..317b805f0 100644 --- a/esphomeyaml/index.rst +++ b/esphomeyaml/index.rst @@ -684,6 +684,8 @@ Misc Components :class: component-image .. _Time: /esphomeyaml/components/time.html +.. _cookbook: + Cookbook -------- diff --git a/esphomeyaml/v1.8.0.csv b/esphomeyaml/v1.8.0.csv index 5ca814ead..e75717583 100644 --- a/esphomeyaml/v1.8.0.csv +++ b/esphomeyaml/v1.8.0.csv @@ -1,16 +1,16 @@ -SPI Bus, components/spi, spi.svg -UART Bus, components/uart, uart.svg -RTC Time, components/time, clock-outline.svg - Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg Nextion, components/display/nextion, nextion.jpg SSD1306, components/display/ssd1306_i2c, ssd1306.jpg MAX7219, components/display/max7219, max7219.jpg LCD Display, components/display/lcd_gpio, lcd.jpg -Uptime Sensor, components/sensor/uptime, timer.svg +RCSwitch Integration, components/switch/remote_transmitter.html#rcswitch-remote-codes, remote.svg -RCSwitch Integration, components/remote_transmitter, remote.svg +SPI Bus, components/spi, spi.svg +UART Bus, components/uart, uart.svg +RTC Time, components/time, clock-outline.svg + +Uptime Sensor, components/sensor/uptime, timer.svg PN532, components/pn532, pn532.jpg RDM6300, components/rdm6300, rdm6300.jpg @@ -18,7 +18,6 @@ BLE RSSI, components/sensor/ble_rssi, bluetooth.svg Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg - HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg HX711, components/sensor/hx711, hx711.jpg HLW8012, components/sensor/hlw8012, hlw8012.svg @@ -33,4 +32,4 @@ TCS34725, components/sensor/tcs34725, tcs34725.jpg RGBWW Light, components/light/rgbww, rgbw.png Cold+Warm White Light, components/light/cwww, brightness-medium.svg -Light Effects, components/light/index, creation.svg +Light Effects, components/light/index#light-effects, creation.svg