From a1861ff6def2c0c0fae8acd5a98a7f653d24de95 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Fri, 24 Nov 2023 08:10:39 +1300 Subject: [PATCH 1/4] Add documentation for images using URL (#3409) --- components/display/index.rst | 32 ++++++++++++++++++++------------ lint.py | 1 + 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/components/display/index.rst b/components/display/index.rst index 5e8bfd2b6..2388f7233 100644 --- a/components/display/index.rst +++ b/components/display/index.rst @@ -184,7 +184,7 @@ Next, create a ``font:`` section in your configuration: - file: "fonts/tom-thumb.bdf" id: tomthumb - + - file: 'gfonts://Material+Symbols+Outlined' id: icon_font_50 size: 50 @@ -202,7 +202,7 @@ Configuration variables: **Google Fonts**: - Each Google Font will be downloaded once and cached for future use. This can also be used to download Material + Each Google Font will be downloaded once and cached for future use. This can also be used to download Material Symbols or Icons as in the example above. - **family** (**Required**, string): The name of the Google Font family. @@ -407,10 +407,10 @@ You can display current time using a time component. Please see the example :ref Screen Clipping *************** -Screen clipping is a new set of methods since version 2023.2.0 of esphome. It could be useful when you just want to show +Screen clipping is a new set of methods since version 2023.2.0 of esphome. It could be useful when you just want to show a part of an image or make sure that what you draw on the screen does not go outside a specific region on the screen. -With ``start_clipping(left, top, right, bottom);`` start you the clipping process and when you are done drawing in that region +With ``start_clipping(left, top, right, bottom);`` start you the clipping process and when you are done drawing in that region you can stop the clipping process with ``end_clipping();`` . You can nest as many ``start_clipping();`` as you want as long you end them as many times as well. @@ -420,7 +420,7 @@ you end them as many times as well. - platform: ... # ... id: my_binary_sensor - + color: - name: my_red red: 100% @@ -439,12 +439,12 @@ you end them as many times as well. it.printf(0, 0, id(my_font), id(my_red), "State: %s", id(my_binary_sensor).state ? "ON" : "OFF"); it.end_clipping(); -After you started clipping you can manipulate the region with ``extend_clipping(left, top, right, bottom);`` +After you started clipping you can manipulate the region with ``extend_clipping(left, top, right, bottom);`` and ``shrink_clipping(left, top, right, bottom);`` within previous set clipping region. With ``get_clipping();`` you get a ``Rect`` object back with the latest set clipping region. -.. code-block:: cpp +.. code-block:: cpp class Rect { int16_t x; ///< X/Left coordinate @@ -678,6 +678,13 @@ Use this component to store graphical images on the device, you can then draw th id: alert resize: 80x80 +.. code-block:: yaml + + image: + - file: https://esphome.io/_images/logo.png + id: esphome_logo + resize: 200x162 + Configuration variables: - **file** (**Required**, string): @@ -685,7 +692,8 @@ Configuration variables: - **Local files**: The path (relative to where the .yaml file is) of the image file. - **Material Design Icons**: Specify the `Material Design Icon `_ id in the format ``mdi:icon-name``, and that icon will automatically be downloaded and added to the configuration. - + - **Remote files**: The URL of the image file. + - **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the image later in your display code. - **resize** (*Optional*, string): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT`` @@ -971,7 +979,7 @@ Color Test Pattern ****************** If you're experiencing issues with your color display, the script below can help you to identify what might be wrong. -It will show 3 color bars in **RED**, **GREEN** and **BLUE**. To help the graphics display team determine +It will show 3 color bars in **RED**, **GREEN** and **BLUE**. To help the graphics display team determine the best way to help you, **a picture of the result of this script is very helpful.** Should you `create an issue `__ in GitHub regarding your display, please @@ -988,15 +996,15 @@ be sure to **include a link to where you purchased it** so that we can validate for(auto i = 0; i<256; i++) { it.horizontal_line(shift_x+ 0,i+shift_y,50, my_red.fade_to_white(i)); it.horizontal_line(shift_x+ 50,i+shift_y,50, my_red.fade_to_black(i)); - + it.horizontal_line(shift_x+105,i+shift_y,50, my_green.fade_to_white(i)); it.horizontal_line(shift_x+155,i+shift_y,50, my_green.fade_to_black(i)); - + it.horizontal_line(shift_x+210,i+shift_y,50, my_blue.fade_to_white(i)); it.horizontal_line(shift_x+260,i+shift_y,50, my_blue.fade_to_black(i)); } it.rectangle(shift_x+ 0, 0+shift_y, shift_x+ 310, 256+shift_y, my_yellow); - + color: - id: my_blue blue: 100% diff --git a/lint.py b/lint.py index a4b3276a1..7240ee97e 100644 --- a/lint.py +++ b/lint.py @@ -395,6 +395,7 @@ def lint_directive_formatting(fname, content): include=["*.rst"], exclude=[ "components/web_server.rst", + "components/display/index.rst", ], ) def lint_esphome_io_link(fname, match): From c6a6f784eee92d8f5a9f6f19e757a32864da1a6f Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Fri, 24 Nov 2023 10:24:28 +1300 Subject: [PATCH 2/4] Bump version to 2023.11.4 --- Doxygen | 2 +- Makefile | 2 +- _static/version | 2 +- conf.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doxygen b/Doxygen index 0941c31f8..0d52c2650 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 = 2023.11.3 +PROJECT_NUMBER = 2023.11.4 # 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 679714f86..0ca26dacc 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ ESPHOME_PATH = ../esphome -ESPHOME_REF = 2023.11.3 +ESPHOME_REF = 2023.11.4 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify diff --git a/_static/version b/_static/version index 110ab1ada..d20d18ca7 100644 --- a/_static/version +++ b/_static/version @@ -1 +1 @@ -2023.11.3 \ No newline at end of file +2023.11.4 \ No newline at end of file diff --git a/conf.py b/conf.py index d4da1817c..cce74f3ef 100644 --- a/conf.py +++ b/conf.py @@ -69,7 +69,7 @@ author = "ESPHome" # The short X.Y version. version = "2023.11" # The full version, including alpha/beta/rc tags. -release = "2023.11.3" +release = "2023.11.4" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. From 36d355074093c38fa52e2d0109bc8811623de661 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Fri, 24 Nov 2023 10:24:54 +1300 Subject: [PATCH 3/4] Update changelog for 2023.11.4 --- changelog/2023.11.0.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/changelog/2023.11.0.rst b/changelog/2023.11.0.rst index 1643c3425..d86a78bd8 100644 --- a/changelog/2023.11.0.rst +++ b/changelog/2023.11.0.rst @@ -91,6 +91,13 @@ Release 2023.11.3 - November 22 - Early return when there are no wifi scan results :esphomepr:`5797` by :ghuser:`jesserockz` - Add some additional VA triggers, part 2 :esphomepr:`5811` by :ghuser:`kbx81` + +Release 2023.11.4 - November 24 +------------------------------- + +- Allow images to be downloaded from URLs :esphomepr:`5214` by :ghuser:`landonr` + + Full list of changes -------------------- From 0dba93dc06994b5c2bf2c9daa685f2abf7859ec5 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Fri, 24 Nov 2023 10:25:24 +1300 Subject: [PATCH 4/4] Update supporters for 2023.11.4 --- guides/supporters.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/guides/supporters.rst b/guides/supporters.rst index 46e944b83..f6271ce3d 100644 --- a/guides/supporters.rst +++ b/guides/supporters.rst @@ -45,6 +45,7 @@ Contributors - `Adrian Fretwell (@AdrianFretwell) `__ - `Adrien Brault (@adrienbrault) `__ - `Ian Blais (@aeonsablaze) `__ +- `Attila Farago (@afarago) `__ - `Kjell Braden (@afflux) `__ - `Alejandro Galfrascoli (@AGalfra) `__ - `Stefan Agner (@agners) `__ @@ -1256,4 +1257,4 @@ Contributors - `Zsolt Zsiros (@ZsZs73) `__ - `Christian Zufferey (@zuzu59) `__ -*This page was last updated November 22, 2023.* +*This page was last updated November 24, 2023.*