mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-27 17:37:45 +01:00
commit
2d15fc60fa
2
Doxygen
2
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.2.0b3
|
||||
PROJECT_NUMBER = 2023.2.0b4
|
||||
|
||||
# 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
|
||||
|
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
||||
ESPHOME_PATH = ../esphome
|
||||
ESPHOME_REF = 2023.2.0b3
|
||||
ESPHOME_REF = 2023.2.0b4
|
||||
|
||||
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||
|
||||
|
@ -1 +1 @@
|
||||
2023.2.0b3
|
||||
2023.2.0b4
|
@ -77,6 +77,9 @@ Beta Changes
|
||||
|
||||
- Bump curl version in docker :esphomepr:`4403` by :ghuser:`jesserockz`
|
||||
- Fix release workflow :esphomepr:`4405` by :ghuser:`jesserockz`
|
||||
- Climate PID Autotune Logging fixes :esphomepr:`4136` by :ghuser:`patrickcollins12`
|
||||
- Add Clipping to displaybuffer :esphomepr:`4271` by :ghuser:`nielsnl68`
|
||||
- Fix check for empty clipping array :esphomepr:`4421` by :ghuser:`nielsnl68`
|
||||
|
||||
All changes
|
||||
^^^^^^^^^^^
|
||||
|
@ -391,6 +391,62 @@ Displaying Time
|
||||
|
||||
You can display current time using a time component. Please see the example :ref:`here <strftime>`.
|
||||
|
||||
.. _clipping:
|
||||
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
binary_sensor:
|
||||
- platform: ...
|
||||
# ...
|
||||
id: my_binary_sensor
|
||||
|
||||
color:
|
||||
- name: my_red
|
||||
red: 100%
|
||||
|
||||
display:
|
||||
- platform: ...
|
||||
# ...
|
||||
lambda: |-
|
||||
if (id(my_binary_sensor).state) {
|
||||
it.print(0, 0, id(my_font), "state: ON");
|
||||
} else {
|
||||
it.print(0, 0, id(my_font), "state: OFF");
|
||||
}
|
||||
// Shorthand:
|
||||
it.start_clipping(40,0,140,20);
|
||||
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);``
|
||||
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
|
||||
|
||||
class Rect {
|
||||
int16_t x; ///< X/Left coordinate
|
||||
int16_t y; ///< Y/Top coordinate
|
||||
int16_t w; ///< Width
|
||||
int16_t h; ///< Height
|
||||
int16_t x2(); ///< Right coordinate
|
||||
int16_t y2(); ///< bottom coordinate
|
||||
};
|
||||
|
||||
With ``is_clipping();`` tells you if clipping is activated.
|
||||
|
||||
|
||||
|
||||
.. _config-color:
|
||||
|
||||
|
@ -10,7 +10,7 @@ BP1658CJ LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The BP1658CJ component represents a BP1658CJ LED diver chain in
|
||||
The BP1658CJ component represents a BP1658CJ LED driver chain in
|
||||
ESPHome. Communication is done with two GPIO pins (DATA and CLK).
|
||||
|
||||
To use the channels of this components, you first need to setup the
|
||||
|
@ -10,7 +10,7 @@ BP5758D LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The BP5758D component represents a BP5758D LED diver chain in
|
||||
The BP5758D component represents a BP5758D LED driver chain in
|
||||
ESPHome. Communication is done with two GPIO pins (DATA and CLK).
|
||||
|
||||
To use the channels of this components, you first need to setup the
|
||||
|
@ -11,7 +11,7 @@ MY9231/MY9291 LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The MY9231/MY9291 component represents a MY9231/MY9291 LED diver chain
|
||||
The MY9231/MY9291 component represents a MY9231/MY9291 LED driver chain
|
||||
(`MY9231 description <http://www.my-semi.com.tw/file/MY9231_BF_0.91.pdf>`__,
|
||||
`MY9291 description <http://www.my-semi.com.tw/file/MY9291_BF_0.91.pdf>`__) in
|
||||
ESPHome. Communication is done with two GPIO pins (DI and DCKI) and multiple
|
||||
|
@ -11,7 +11,7 @@ SM16716 LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The SM16716 component represents a SM16716 LED diver chain
|
||||
The SM16716 component represents a SM16716 LED driver chain
|
||||
(`SM16716 description <https://github.com/sowbug/sm16716/blob/master/SM16716%20Datasheet%20%5BChinese%5D.pdf>`__,
|
||||
`SM16716 description <https://github.com/sowbug/sm16716/blob/master/SM16716%20Datasheet%20%5BChinese%5D.pdf>`__) in
|
||||
ESPHome. Communication is done with two GPIO pins (MOSI and SCLK) and multiple
|
||||
|
@ -10,7 +10,7 @@ SM2135 LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The SM2135 component represents a SM2135 LED diver chain
|
||||
The SM2135 component represents a SM2135 LED driver chain
|
||||
(`SM2135 description <https://github.com/arendst/Sonoff-Tasmota/files/3656603/SM2135E_zh-CN_en-US_translated.pdf>`__,
|
||||
`SM2135 description <https://github.com/arendst/Sonoff-Tasmota/files/3656603/SM2135E_zh-CN_en-US_translated.pdf>`__) in
|
||||
ESPHome. Communication is done with two GPIO pins (MOSI and SCLK).
|
||||
|
@ -10,7 +10,7 @@ SM2235 LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The SM2235 component represents a SM2235 LED diver chain in
|
||||
The SM2235 component represents a SM2235 LED driver chain in
|
||||
ESPHome. Communication is done with two GPIO pins (DATA and CLK).
|
||||
|
||||
To use the channels of this components, you first need to setup the
|
||||
|
@ -10,7 +10,7 @@ SM2335 LED driver
|
||||
Component/Hub
|
||||
-------------
|
||||
|
||||
The SM2335 component represents a SM2335 LED diver chain in
|
||||
The SM2335 component represents a SM2335 LED driver chain in
|
||||
ESPHome. Communication is done with two GPIO pins (DATA and CLK).
|
||||
It is used in some smart light bulbs:
|
||||
|
||||
|
2
conf.py
2
conf.py
@ -69,7 +69,7 @@ author = "ESPHome"
|
||||
# The short X.Y version.
|
||||
version = "2023.2"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = "2023.2.0b3"
|
||||
release = "2023.2.0b4"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
@ -60,6 +60,7 @@ Contributors
|
||||
- `Amish Vishwakarma (@amishv) <https://github.com/amishv>`__
|
||||
- `Jason Nader (@ammgws) <https://github.com/ammgws>`__
|
||||
- `Branden Cash (@ammmze) <https://github.com/ammmze>`__
|
||||
- `Alexander Momchilov (@amomchilov) <https://github.com/amomchilov>`__
|
||||
- `anatoly-savchenkov (@anatoly-savchenkov) <https://github.com/anatoly-savchenkov>`__
|
||||
- `andig (@andig) <https://github.com/andig>`__
|
||||
- `András Bíró (@andrasbiro) <https://github.com/andrasbiro>`__
|
||||
@ -908,4 +909,4 @@ Contributors
|
||||
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
|
||||
*This page was last updated February 9, 2023.*
|
||||
*This page was last updated February 13, 2023.*
|
||||
|
Loading…
Reference in New Issue
Block a user