Merge braanch 'current' into branch 'beta'

This commit is contained in:
Jesse Hills 2021-05-03 23:10:47 +12:00
parent 6a99cb6feb
commit 8edc1bf285
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
16 changed files with 51 additions and 131 deletions

View File

@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
Examples of behavior that contributes to creating a positive environment include: Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language - Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism - Gracefully accepting constructive criticism
* Focusing on what is best for the community - Focusing on what is best for the community
* Showing empathy towards other community members - Showing empathy towards other community members
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances - The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission - Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting - Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities ## Our Responsibilities
@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at contact@otto-winter.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at esphome@nabucasa.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

View File

@ -62,15 +62,18 @@ table.docutils {
z-index: 9999; z-index: 9999;
display: none display: none
} }
#upgrade-footer-changelog { .footer-button-container {
margin: 0 60px 0 10px;
float: right;
}
.footer-button {
background-color: #b3b3b3; background-color: #b3b3b3;
color: #4e4e4e; color: #4e4e4e;
display: inline-block; display: inline-block;
border-radius: 5px; border-radius: 5px;
padding: 0 20px; padding: 0 20px;
margin-left: 10px;
cursor: pointer; cursor: pointer;
float: right;
margin: 0 60px 0 10px;
text-decoration: none; text-decoration: none;
} }
.not-hidden { .not-hidden {

View File

@ -30,15 +30,20 @@
{% block footer %} {% block footer %}
<div id="upgrade-footer"> <div id="upgrade-footer">
A new version has been release since you last visited this page: {{ release }} 🎉 A new version has been release since you last visited this page: {{ release }} 🎉
<a id="upgrade-footer-changelog" href="/changelog/v{{ version }}.0.html">View Changelog</a> <div class="footer-button-container">
<div role="button" id="upgrade-footer-dismiss" class="footer-button">Dismiss</div>
<a id="upgrade-footer-changelog" class="footer-button" href="/changelog/v{{ version }}.0.html">View Changelog</a>
</div>
</div> </div>
<script> <script>
var old = window.localStorage.getItem("version"); var old = window.localStorage.getItem("version");
if (old === null) { window.localStorage.setItem("version", "{{ version }}"); if (old === null) { window.localStorage.setItem("version", "{{ version }}");
} else if (old !== "{{ version }}") { } else if (old !== "{{ version }}") {
document.getElementById("upgrade-footer").classList.add("not-hidden"); const footerEl = document.getElementById("upgrade-footer");
document.getElementById("upgrade-footer-changelog").addEventListener('click', function () { footerEl.classList.add("not-hidden");
footerEl.addEventListener('click', function () {
window.localStorage.setItem("version", "{{ version }}"); window.localStorage.setItem("version", "{{ version }}");
footerEl.classList.remove("not-hidden");
}); });
} }
</script> </script>

View File

@ -92,7 +92,7 @@ This automation will be triggered when a can frame is received. A variable ``x`
.. note:: .. note::
Messeges this node sends to te same ID will not show up as reveived messages. Messages this node sends to the same ID will not show up as received messages.
.. code-block:: yaml .. code-block:: yaml
@ -144,10 +144,10 @@ Configuration variables:
MCP2515 Component MCP2515 Component
----------------- -----------------
The MCP2515 is a spi device and therfore you must first add the configuration for the spi bus to your file. The MCP2515 is a spi device and therefore you must first add the configuration for the spi bus to your file.
You need to have an :ref:`SPI bus <spi>` in your configuration with both the **mosi_pin** and **miso_pin** set. You need to have an :ref:`SPI bus <spi>` in your configuration with both the **mosi_pin** and **miso_pin** set.
For wireing up the MSP2515 please refer to the section below. For wiring up the MSP2515 please refer to the section below.
Configuration variables: Configuration variables:
************************ ************************
@ -157,7 +157,7 @@ Configuration variables:
Sometimes also called ``SS``. Sometimes also called ``SS``.
- **clock** (*Optional*): One of ``8MHZ``, ``16MHZ`` or ``20MHZ``. Clock crystal used on the MCP2515 device. - **clock** (*Optional*): One of ``8MHZ``, ``16MHZ`` or ``20MHZ``. Clock crystal used on the MCP2515 device.
Defaults to ``8MHZ``. Defaults to ``8MHZ``.
- **mode** (*Optional*): Operation mode. Default ot ``NORMAL`` - **mode** (*Optional*): Operation mode. Default to ``NORMAL``
- NORMAL: Normal operation - NORMAL: Normal operation
- LOOPBACK: Loopback mode can be used to just test you spi connections to the device - LOOPBACK: Loopback mode can be used to just test you spi connections to the device
@ -205,7 +205,7 @@ Standard IDs and Extended IDs can coexist on the same segment.
.. note:: .. note::
It is important to know that for example Standard 0x123 and Extended 0x123 are different addesses. It is important to know that for example Standard 0x123 and Extended 0x123 are different addresses.
This example shows how the different ID types are used in the configuration for transmission and receiving. This example shows how the different ID types are used in the configuration for transmission and receiving.
For the IDs decimal or hexadecimal notation is possible: For the IDs decimal or hexadecimal notation is possible:
0x000 - 0x7ff / 0-2047 for Standard IDs only. 0x000 - 0x7ff / 0-2047 for Standard IDs only.

View File

@ -65,7 +65,7 @@ Configuration examples
To utilize the color capabilities of this display module, you'll likely want to add a ``color:`` section to your To utilize the color capabilities of this display module, you'll likely want to add a ``color:`` section to your
YAML configuration; please see :ref:`color <config-color>` for more detail on this configuration section. YAML configuration; please see :ref:`color <config-color>` for more detail on this configuration section.
To use colors in your lambada: To use colors in your lambda:
.. code-block:: yaml .. code-block:: yaml

View File

@ -374,10 +374,10 @@ Configuration variables:
- ``BINARY``: Two colors, suitable for 1 color displays or 2 color image in color displays. Uses 1 bit - ``BINARY``: Two colors, suitable for 1 color displays or 2 color image in color displays. Uses 1 bit
per pixel, 8 pixels per byte. per pixel, 8 pixels per byte.
- ``GREYSCALE``: Full scale grey. Uses 8 bits per pixel, 1 pixel per byte. - ``GRAYSCALE``: Full scale grey. Uses 8 bits per pixel, 1 pixel per byte.
- ``RGB24``: Full RGB color stored. Uses 3 bytes per pixel. - ``RGB24``: Full RGB color stored. Uses 3 bytes per pixel.
- **dither** (*Optional*): Specifies which dither method used to process the image, only used in GREYSCALE and BINARY type image. Defaults to ``NONE``. You can read more about it `here <https://pillow.readthedocs.io/en/stable/reference/Image.html?highlight=Dither#PIL.Image.Image.convert>`__ and `here <https://en.wikipedia.org/wiki/Dither>`__. - **dither** (*Optional*): Specifies which dither method used to process the image, only used in GRAYSCALE and BINARY type image. Defaults to ``NONE``. You can read more about it `here <https://pillow.readthedocs.io/en/stable/reference/Image.html?highlight=Dither#PIL.Image.Image.convert>`__ and `here <https://en.wikipedia.org/wiki/Dither>`__.
- ``NONE``: Every pixel convert to its nearest color. - ``NONE``: Every pixel convert to its nearest color.
- ``FLOYDSTEINBERG``: Uses Floyd-Steinberg dither to approximate the original image luminosity levels. - ``FLOYDSTEINBERG``: Uses Floyd-Steinberg dither to approximate the original image luminosity levels.

View File

@ -71,7 +71,7 @@ To utilize the grayscale capabilities of this display module, add a ``color:`` s
please see :ref:`color <config-color>` for more details. As this is a grayscale display, it only uses the white color please see :ref:`color <config-color>` for more details. As this is a grayscale display, it only uses the white color
element as shown below. element as shown below.
To use grayscale in your lambada: To use grayscale in your lambda:
.. code-block:: yaml .. code-block:: yaml

View File

@ -128,7 +128,7 @@ To utilize the grayscale capabilities of this display module, add a ``color:`` s
please see :ref:`color <config-color>` for more details. As this is a grayscale display, it only uses the white color please see :ref:`color <config-color>` for more details. As this is a grayscale display, it only uses the white color
element as shown below. element as shown below.
To use grayscale in your lambada: To use grayscale in your lambda:
.. code-block:: yaml .. code-block:: yaml

View File

@ -70,7 +70,7 @@ As of version 1.15, ESPHome supports color displays. To utilize the color capabi
module, you'll likely want to add a ``color:`` section to your YAML configuration; please see module, you'll likely want to add a ``color:`` section to your YAML configuration; please see
:ref:`color <config-color>` for more detail on this configuration section. :ref:`color <config-color>` for more detail on this configuration section.
To use colors in your lambada: To use colors in your lambda:
.. code-block:: yaml .. code-block:: yaml

View File

@ -12,7 +12,7 @@ This component sets up the I²C bus for your ESP32 or ESP8266. In order for thes
to work correctly, you need to define the I²C bus in your configuration. Please note the ESP 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 will enable its internal 10kΩ pullup resistors for these pins, so you usually don't need to
put on external ones. You can use multiple devices on one I²C bus as each device is given a put on external ones. You can use multiple devices on one I²C bus as each device is given a
unique address for communicating between between it and the ESP. You can do this by hopping unique address for communicating between it and the ESP. You can do this by hopping
wires from the two lines (SDA and SCL) from each device board to the next device board or by wires from the two lines (SDA and SCL) from each device board to the next device board or by
connecting the wires from each device back to the two I²C pins on the ESP. connecting the wires from each device back to the two I²C pins on the ESP.

View File

@ -31,9 +31,9 @@ rarely be necessary, as the SPI bus can be shared by the devices).
# Example configuration entry # Example configuration entry
spi: spi:
clk_pin: GPIO21 clk_pin: GPIO14
mosi_pin: GPIO22 mosi_pin: GPIO13
miso_pin: GPIO23 miso_pin: GPIO12
Configuration variables: Configuration variables:
------------------------ ------------------------

View File

@ -13,15 +13,15 @@ page describes them.
ID ID
-- --
Quite an important aspect of ESPHome are “ids”. They are used to Quite an important aspect of ESPHome are “IDs”. They are used to
connect components from different domains. For example, you define an connect components from different domains. For example, you define an
output component together with an id and then later specify that same id output component together with an ID and then later specify that same ID
in the light component. IDs should always be unique within a in the light component. IDs should always be unique within a
configuration and ESPHome will warn you if you try to use the same configuration and ESPHome will warn you if you try to use the same
ID twice. ID twice.
Because ESPHome converts your configuration into C++ code and the Because ESPHome converts your configuration into C++ code and the
ids are in reality just C++ variable names, they must also adhere to IDs are in reality just C++ variable names, they must also adhere to
C++s naming conventions. `C++ Variable C++s naming conventions. `C++ Variable
names <https://venus.cs.qc.cuny.edu/~krishna/cs111/lectures/D3_C++_Variables.pdf>`__ names <https://venus.cs.qc.cuny.edu/~krishna/cs111/lectures/D3_C++_Variables.pdf>`__
@ -205,7 +205,7 @@ of nodes inherit:
To hide these base files from the dashboard, you can To hide these base files from the dashboard, you can
- Place them in a subdirectory (dashboard only shows files in top-level dir) - Place them in a subdirectory (dashboard only shows files in top-level directory)
- Prepend a dot to the filename, like ``.base.yaml`` - Prepend a dot to the filename, like ``.base.yaml``
.. _command-line-substitutions: .. _command-line-substitutions:
@ -271,8 +271,8 @@ config in the main yaml file. All definitions from packages will be merged with
config in non-destructive way so you could always override some bits and pieces of package config in non-destructive way so you could always override some bits and pieces of package
configuration. configuration.
Consider the following example where author put common pieces of configuration like WiFi, Consider the following example where the author put common pieces of configuration like WiFi and
I²C into base files and extends it with some devices specific configurations in the main config. I²C into base files and extends it with some device specific configurations in the main config.
Note how the piece of configuration describing ``api`` component in ``device_base.yaml`` gets Note how the piece of configuration describing ``api`` component in ``device_base.yaml`` gets
merged with the services definitions from main config file. merged with the services definitions from main config file.

View File

@ -47,6 +47,7 @@ Blog Posts & Videos
- `4$ Xiaomi mijia thermometer LYWSD03MMC + ESP32 + ESPhome <https://omarghader.github.io/how-to-monitor-your-home-temperature-with-esp32-and-xiaomi-mijia-using-esphome/>`__ by `Omar GHADER <https://omarghader.github.io/post>`__ - `4$ Xiaomi mijia thermometer LYWSD03MMC + ESP32 + ESPhome <https://omarghader.github.io/how-to-monitor-your-home-temperature-with-esp32-and-xiaomi-mijia-using-esphome/>`__ by `Omar GHADER <https://omarghader.github.io/post>`__
- `Baseboard (Line Voltage) Thermostat from Smart Switch <https://github.com/rjmurph2241/baseboard-heating-thermostat>`__ by :ghuser:`rjmurph2241` - `Baseboard (Line Voltage) Thermostat from Smart Switch <https://github.com/rjmurph2241/baseboard-heating-thermostat>`__ by :ghuser:`rjmurph2241`
- `Office Doorbell <https://github.com/shish/esphome-projects/blob/master/office-doorbell.md>`__ by :ghuser:`shish` - `Office Doorbell <https://github.com/shish/esphome-projects/blob/master/office-doorbell.md>`__ by :ghuser:`shish`
- `Display TM1637 with ESPHome and MQTT showing Youtube subscribers count and other info <https://youtu.be/27JZEky0h1Q>`__ by :ghuser:`electrofun-smart`
Custom Components & Code Custom Components & Code
------------------------ ------------------------

View File

@ -1,100 +1,13 @@
Supporters & Contributors
=========================
**Hi! I'm Otto Winter, the author and main developer of ESPHome.**
Developing ESPHome takes a lot of time. There's a lot of things that go
into developing and maintaining an open-source project: from developing new features, fixing bugs,
answering questions to maintaining servers, preparing releases and moderating discussions.
And of course all of the hardware for new features has to be bought too. I'm a student
so I really appreciate donations :)
**You can support ESPHome's development** by becoming a Patron or a one-time contribution
with PayPal.
.. raw:: html
<div class="supporters-row">
<div class="supporters-column">
<h3>Support Regularly 💫</h3>
<a href="https://www.patreon.com/ottowinter" target="_blank"><img src="/_images/donate-patreon.png" alt="Become A Patron"></a>
<p>
<strong>Become a patron for this project.</strong>
</p>
</div>
<div class="supporters-column">
<h3>One-Time Donation</h3>
<a href="https://www.paypal.me/ottowinter" target="_blank"><img src="/_images/donate-paypal.png" alt="Donate with PayPal"></a>
<p>
<strong>Make a one-time donation via PayPal.</strong>
</p>
</div>
</div>
Patrons
-------
People that support ESPHome's development over `Patreon <https://www.patreon.com/ottowinter>`__.
You guys are awesome!
- Alexander Leisentritt
- Anders
- Andrea Donno
- Andrew Tierney
- Book of the Future
- Christer Frostmo
- Christoph
- Clayton
- Daan Damhuis
- Dattas Moonchaser
- David Padbury
- Dennis Münchgesang
- Dmitriy Khazansky
- DrZzs
- fabi
- Franck Nijhof
- Gaiar Baimuratov
- Intermittent Technology
- Jung Ervin
- Kenvase
- Lazar Obradovic
- Magnus Overli
- minsuke
- Nick Rout
- Nigel Michki
- Paul Krischer
- Paul Morley
- Paweł Kawa
- Philippe Penochet
- Radu Tizu
- Roman Priesol
- LMR
- Ryan Bahm
- Ryan Nazaretian
- Sam Absalom
- Sasha Mikhnov
- Saulo Onze
- Starwolf73
- Thibault Maekelbergh
- Thomas Hermine
- Vincèn PUJOL
- Wojciech Bederski
- Yonatan Adest
- Zoltán Jáki
Contributors Contributors
------------ ============
ESPHome is an open-source project, and everybody can contribute to it to make this ESPHome is an open-source project, and everybody can contribute to it to make this
project awesome. This list contains a list of people who have submitted patches project awesome. This list contains a list of people who have submitted patches
that have made it into the `ESPHome organization's <https://github.com/esphome>`__ repositories. that have made it into the `ESPHome organization's <https://github.com/esphome>`__ repositories.
Author & Main Developer ESPHome is lead by `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__, who is funded to work on ESPHome full-time by `Nabu Casa <https://www.nabucasa.com>`__. To help fund development of ESPHome, subscribe to `Home Assistant Cloud by Nabu Casa <https://www.nabucasa.com>`__.
***********************
- `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__ - 2361 contributions ESPHome was originally founded by `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__.
Contributors Contributors
************ ************
@ -300,7 +213,6 @@ Contributors
- `Joshua Dadswell (@jdads1) <https://github.com/jdads1>`__ - 1 contribution - `Joshua Dadswell (@jdads1) <https://github.com/jdads1>`__ - 1 contribution
- `jeff-h (@jeff-h) <https://github.com/jeff-h>`__ - 2 contributions - `jeff-h (@jeff-h) <https://github.com/jeff-h>`__ - 2 contributions
- `Jeff Rescignano (@JeffResc) <https://github.com/JeffResc>`__ - 11 contributions - `Jeff Rescignano (@JeffResc) <https://github.com/JeffResc>`__ - 11 contributions
- `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__ - 133 contributions
- `Jérémy JOURDIN (@JJK801) <https://github.com/JJK801>`__ - 1 contribution - `Jérémy JOURDIN (@JJK801) <https://github.com/JJK801>`__ - 1 contribution
- `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__ - 1 contribution - `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__ - 1 contribution
- `Justin Maxwell (@jkmaxwell) <https://github.com/jkmaxwell>`__ - 1 contribution - `Justin Maxwell (@jkmaxwell) <https://github.com/jkmaxwell>`__ - 1 contribution

View File

@ -19,7 +19,6 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
<a href="https://github.com/esphome/esphome"><img src="/_images/shield-github.svg" alt="GitHub" class="index-shield"></a> <a href="https://github.com/esphome/esphome"><img src="/_images/shield-github.svg" alt="GitHub" class="index-shield"></a>
<a href="https://discord.gg/KhAMKrd"><img src="/_images/shield-discord.svg" alt="Discord" class="index-shield"></a> <a href="https://discord.gg/KhAMKrd"><img src="/_images/shield-discord.svg" alt="Discord" class="index-shield"></a>
<a href="https://twitter.com/esphome_"><img src="/_images/shield-twitter.svg" alt="Twitter" class="index-shield"></a> <a href="https://twitter.com/esphome_"><img src="/_images/shield-twitter.svg" alt="Twitter" class="index-shield"></a>
<a href="/guides/supporters.html"><img src="/_images/shield-donate.svg" alt="Donate" class="index-shield"></a>
.. _guides: .. _guides:

View File

@ -126,4 +126,4 @@ when they are posted on this page.
Contact Us Contact Us
---------- ----------
If you have any questions about this Privacy Policy, please contact us by email: contact@otto-winter.com If you have any questions about this Privacy Policy, please contact us by email: esphome@nabucasa.com