mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-02-03 23:41:36 +01:00
Merge branch 'current' into next
This commit is contained in:
Jesse Hills
commit
3668887972
BIN
_static/changelog-2022.12.0.png
Normal file
BIN
_static/changelog-2022.12.0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
195
changelog/2022.12.0.rst
Normal file
195
changelog/2022.12.0.rst
Normal file
@ -0,0 +1,195 @@
|
||||
ESPHome 2022.12.0 - 14th December 2022
|
||||
======================================
|
||||
|
||||
.. seo::
|
||||
:description: Changelog for ESPHome 2022.12.0.
|
||||
:image: /_static/changelog-2022.12.0.png
|
||||
:author: Jesse Hills
|
||||
:author_twitter: @jesserockz
|
||||
|
||||
.. imgtable::
|
||||
:columns: 3
|
||||
|
||||
ESP32, components/esp32, esp32.svg
|
||||
Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg
|
||||
SN74HC165 I/O Expander, components/sn74hc165, sn74hc595.jpg
|
||||
|
||||
The festive holidays are coming early and bring you an ESPHome release 1 week earlier than normal.
|
||||
This release does not bring a bunch of new components like most releases, but instead the focus
|
||||
has been on upgrading the core Arduino and ESP-IDF versions used for the ESP32 based devices.
|
||||
|
||||
Ethernet
|
||||
--------
|
||||
|
||||
Because these core upgrade have aligned the version of ESP-IDF under the hood, ``ethernet``
|
||||
is now able to be used when specifying ESP-IDF as your framework of choice.
|
||||
|
||||
Bluetooth Proxy
|
||||
---------------
|
||||
|
||||
The Bluetooth Proxy has also had a whole lot of work done by :ghuser:`bdraco` under the hood to
|
||||
improve the stability, speed and reliability between Home Assistant and the bluetooth devices
|
||||
that get proxied through. Along with some of these bluetooth changes is a change to the
|
||||
underlying flash partition table that ESPHome uses. OTA will work, but to fully take advantage
|
||||
of the performance increases for bluetooth, it is best to at least one serial flash with ESPHome
|
||||
2022.12.0 or later.
|
||||
|
||||
|
||||
Full list of changes
|
||||
--------------------
|
||||
|
||||
New Features
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- PID Climate - deadband and output sampling :esphomepr:`3254` by :ghuser:`patrickcollins12` (new-feature)
|
||||
|
||||
New Components
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
- Add sn74hc165 input shift register :esphomepr:`4151` by :ghuser:`jesserockz` (new-integration)
|
||||
|
||||
Breaking Changes
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
- Update esp32 arduino and platform versions :esphomepr:`3564` by :ghuser:`jesserockz` (notable-change) (breaking-change)
|
||||
|
||||
Beta Changes
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- Fix ble parsing with zero padded advertisements :esphomepr:`4162` by :ghuser:`jesserockz`
|
||||
- Increase watchdog timeout when starting OTA :esphomepr:`4172` by :ghuser:`jesserockz`
|
||||
- Bump esphome-dashboard to 20221213.0 :esphomepr:`4176` by :ghuser:`jesserockz`
|
||||
- Remove internal pin restriction from cd74hc4067 :esphomepr:`4179` by :ghuser:`jesserockz`
|
||||
- Speed up bluetooth proxy connections when using esp-idf :esphomepr:`4171` by :ghuser:`bdraco` (notable-change)
|
||||
- Remove warnings when falling through switch cases on purpose :esphomepr:`4181` by :ghuser:`jesserockz`
|
||||
- Revert camera config change for esp-idf :esphomepr:`4182` by :ghuser:`jesserockz`
|
||||
|
||||
Notable Changes
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
- Update esp32 arduino and platform versions :esphomepr:`3564` by :ghuser:`jesserockz` (notable-change) (breaking-change)
|
||||
- Update ESP-IDF and platform version :esphomepr:`3565` by :ghuser:`jesserockz` (notable-change)
|
||||
- Speed up bluetooth proxy connections when using esp-idf :esphomepr:`4171` by :ghuser:`bdraco` (notable-change)
|
||||
|
||||
All changes
|
||||
^^^^^^^^^^^
|
||||
|
||||
- Bump colorama from 0.4.5 to 0.4.6 :esphomepr:`4010` by :ghuser:`dependabot[bot]`
|
||||
- Bump frenck/action-yamllint from 1.3.0 to 1.3.1 :esphomepr:`4011` by :ghuser:`dependabot[bot]`
|
||||
- add two new icons :esphomepr:`3963` by :ghuser:`nagyrobi`
|
||||
- Move CONF_INTERRUPT_PIN to const.py :esphomepr:`4014` by :ghuser:`jesserockz`
|
||||
- Bump pyupgrade from 3.2.0 to 3.2.2 :esphomepr:`4017` by :ghuser:`dependabot[bot]`
|
||||
- Add reset_reason text sensor to debug component :esphomepr:`3814` by :ghuser:`kuba2k2`
|
||||
- remove unused variable last_save in total_daily_energy :esphomepr:`4039` by :ghuser:`bkaufx`
|
||||
- Bump base image versions to latest :esphomepr:`4016` by :ghuser:`jesserockz`
|
||||
- Add number device class support :esphomepr:`4042` by :ghuser:`frenck`
|
||||
- Update esp32 arduino and platform versions :esphomepr:`3564` by :ghuser:`jesserockz` (notable-change) (breaking-change)
|
||||
- Update esp32 boards list :esphomepr:`4056` by :ghuser:`jesserockz`
|
||||
- Add Lolin S2 Mini board :esphomepr:`3264` by :ghuser:`jhamhader`
|
||||
- Add pin aliases for upesy boards :esphomepr:`3794` by :ghuser:`uPesy`
|
||||
- Bump pylint from 2.15.5 to 2.15.6 :esphomepr:`4058` by :ghuser:`dependabot[bot]`
|
||||
- fix display_menu recursive schema gen :esphomepr:`4045` by :ghuser:`glmnet`
|
||||
- Remove manual handling of ethernet power pin :esphomepr:`4062` by :ghuser:`jesserockz`
|
||||
- Bump aioesphomeapi from 11.4.3 to 12.0.0 :esphomepr:`4070` by :ghuser:`dependabot[bot]`
|
||||
- Update ESP-IDF and platform version :esphomepr:`3565` by :ghuser:`jesserockz` (notable-change)
|
||||
- Always use brackets around single log macros :esphomepr:`4072` by :ghuser:`jesserockz`
|
||||
- Midea ir templatable code :esphomepr:`4053` by :ghuser:`reidprojects`
|
||||
- Boards: Adafruit QT Py ESP32 Pico/C3/S2 :esphomepr:`4064` by :ghuser:`jenscski`
|
||||
- Dont set esp32 pin drive strength unless pin is set for output :esphomepr:`4075` by :ghuser:`jesserockz`
|
||||
- Don't allow debug component if you don't have at least debug logging level :esphomepr:`4076` by :ghuser:`jesserockz`
|
||||
- Remove a bunch of unnecessary pylint disabling :esphomepr:`4079` by :ghuser:`jesserockz`
|
||||
- Update ESP32-audioI2S library :esphomepr:`4073` by :ghuser:`jesserockz`
|
||||
- Add vector includes :esphomepr:`4080` by :ghuser:`jesserockz`
|
||||
- Allow manually specifying binary file to OTA :esphomepr:`4054` by :ghuser:`jesserockz`
|
||||
- Fix regressed 'esphome run' :esphomepr:`4094` by :ghuser:`mmakaay`
|
||||
- Make parse_characteristics and parse_descriptors lazy to reduce memory pressure :esphomepr:`4063` by :ghuser:`bdraco`
|
||||
- Speed up BLE connections :esphomepr:`4093` by :ghuser:`bdraco`
|
||||
- Align BLE service logging :esphomepr:`4095` by :ghuser:`bdraco`
|
||||
- Suppress logging unhandled ESP_BLE_AD_TYPE_INT_RANGE :esphomepr:`4096` by :ghuser:`bdraco`
|
||||
- Make sure all BLE address strings are uppercase :esphomepr:`4097` by :ghuser:`bdraco`
|
||||
- Add logging for BLE connection slots :esphomepr:`4098` by :ghuser:`bdraco`
|
||||
- Fix registering for gatt notify when characteristic only support indicate :esphomepr:`4092` by :ghuser:`bdraco`
|
||||
- Fix descriptors not being deleted :esphomepr:`4104` by :ghuser:`bdraco`
|
||||
- Improve reliability of bluetooth active connections :esphomepr:`4049` by :ghuser:`bdraco`
|
||||
- Always use generated api options from aioesphomeapi :esphomepr:`4116` by :ghuser:`jesserockz`
|
||||
- Fix bluetooth_gatt_write_descriptor never getting a response :esphomepr:`4112` by :ghuser:`bdraco`
|
||||
- Combine the scanner failure check so we only stop the scanner once :esphomepr:`4111` by :ghuser:`bdraco`
|
||||
- Reduce memory needed to send the services list :esphomepr:`4110` by :ghuser:`bdraco`
|
||||
- Avoid parsing characteristics and descriptors to reduce memory pressure :esphomepr:`4109` by :ghuser:`bdraco`
|
||||
- Send device address type alongside ble advertisements :esphomepr:`4115` by :ghuser:`jesserockz`
|
||||
- Remove uuid lookups from BLE read/write/notify characteristics :esphomepr:`4102` by :ghuser:`bdraco`
|
||||
- Active BLE connection v3 :esphomepr:`4113` by :ghuser:`bdraco`
|
||||
- preprocess out proto_enum_to_string if not needed :esphomepr:`4119` by :ghuser:`jesserockz`
|
||||
- Bump aioesphomeapi from 12.0.0 to 12.2.0 :esphomepr:`4120` by :ghuser:`dependabot[bot]`
|
||||
- Avoid parsing services with v3 connections without cache :esphomepr:`4117` by :ghuser:`bdraco`
|
||||
- FIX: Unnecessary flash writes by ModbusSwitch component :esphomepr:`3648` by :ghuser:`jpeletier`
|
||||
- Speed up uuid parsing when fetching the service list :esphomepr:`4121` by :ghuser:`bdraco`
|
||||
- modbus_switch: honor switch:restore_mode :esphomepr:`4122` by :ghuser:`jpeletier`
|
||||
- PID Climate - deadband and output sampling :esphomepr:`3254` by :ghuser:`patrickcollins12` (new-feature)
|
||||
- Allow auto setting of ble client id if there is only 1 in config :esphomepr:`4125` by :ghuser:`jesserockz`
|
||||
- fix RESTORE_INVERTED switch:restore_mode :esphomepr:`4129` by :ghuser:`jpeletier`
|
||||
- Bump pylint from 2.15.6 to 2.15.7 :esphomepr:`4127` by :ghuser:`dependabot[bot]`
|
||||
- Allow global setting of compile process limit :esphomepr:`4081` by :ghuser:`jesserockz`
|
||||
- Bump flake8 from 5.0.4 to 6.0.0 :esphomepr:`4084` by :ghuser:`dependabot[bot]`
|
||||
- Bump arduino pico and update wifi methods :esphomepr:`4144` by :ghuser:`jesserockz`
|
||||
- Bump aioesphomeapi from 12.2.0 to 12.2.1 :esphomepr:`4133` by :ghuser:`dependabot[bot]`
|
||||
- Bump esptool from 3.3.1 to 4.4 :esphomepr:`4071` by :ghuser:`dependabot[bot]`
|
||||
- Fix mismatched flake8 version in pre-commit :esphomepr:`4145` by :ghuser:`jesserockz`
|
||||
- Detect BLE stack unrecoverable state :esphomepr:`4128` by :ghuser:`bdraco`
|
||||
- Bump pylint from 2.15.7 to 2.15.8 :esphomepr:`4148` by :ghuser:`dependabot[bot]`
|
||||
- Fix crash with bluetooth tracker and esp-idf :esphomepr:`4140` by :ghuser:`bdraco`
|
||||
- Use ENTITY_CATEGORY_CONFIG for sprinkler config switches. :esphomepr:`4141` by :ghuser:`schinckel`
|
||||
- fix switch initialization :esphomepr:`4153` by :ghuser:`ssieb`
|
||||
- Change 4 chip limit on sn74hc595 to 256 :esphomepr:`4108` by :ghuser:`jesserockz`
|
||||
- Add reports fahrenheit to tuya climate :esphomepr:`4032` by :ghuser:`jesserockz`
|
||||
- Allow dashboard import to pull complete file from github :esphomepr:`3982` by :ghuser:`jesserockz`
|
||||
- Invalid config for waveshare models with no full_update_every :esphomepr:`4066` by :ghuser:`Nizzle`
|
||||
- Add sn74hc165 input shift register :esphomepr:`4151` by :ghuser:`jesserockz` (new-integration)
|
||||
- Fixed deep sleep for ESP32C3 :esphomepr:`4143` by :ghuser:`pistifonok`
|
||||
- ESP32 IDF: Override toolchain-esp32ulp with espressifs own published version :esphomepr:`4155` by :ghuser:`jesserockz`
|
||||
- Add API for dashboard to get boards list :esphomepr:`4154` by :ghuser:`jesserockz`
|
||||
- Bump pytest-asyncio from 0.20.1 to 0.20.2 :esphomepr:`4019` by :ghuser:`dependabot[bot]`
|
||||
- Bump pyupgrade from 3.2.2 to 3.3.0 :esphomepr:`4137` by :ghuser:`dependabot[bot]`
|
||||
- Bump dessant/lock-threads from 3 to 4 :esphomepr:`4150` by :ghuser:`dependabot[bot]`
|
||||
- Bump aioesphomeapi from 12.2.1 to 13.0.1 :esphomepr:`4149` by :ghuser:`dependabot[bot]`
|
||||
- Bump esphome-dashboard to 20221207.0 :esphomepr:`4156` by :ghuser:`jesserockz`
|
||||
- Fix ble parsing with zero padded advertisements :esphomepr:`4162` by :ghuser:`jesserockz`
|
||||
- Increase watchdog timeout when starting OTA :esphomepr:`4172` by :ghuser:`jesserockz`
|
||||
- Bump esphome-dashboard to 20221213.0 :esphomepr:`4176` by :ghuser:`jesserockz`
|
||||
- Remove internal pin restriction from cd74hc4067 :esphomepr:`4179` by :ghuser:`jesserockz`
|
||||
- Speed up bluetooth proxy connections when using esp-idf :esphomepr:`4171` by :ghuser:`bdraco` (notable-change)
|
||||
- Remove warnings when falling through switch cases on purpose :esphomepr:`4181` by :ghuser:`jesserockz`
|
||||
- Revert camera config change for esp-idf :esphomepr:`4182` by :ghuser:`jesserockz`
|
||||
|
||||
Past Changelogs
|
||||
---------------
|
||||
|
||||
- :doc:`2022.11.0`
|
||||
- :doc:`2022.10.0`
|
||||
- :doc:`2022.9.0`
|
||||
- :doc:`2022.8.0`
|
||||
- :doc:`2022.6.0`
|
||||
- :doc:`2022.5.0`
|
||||
- :doc:`2022.4.0`
|
||||
- :doc:`2022.3.0`
|
||||
- :doc:`2022.2.0`
|
||||
- :doc:`2022.1.0`
|
||||
- :doc:`2021.12.0`
|
||||
- :doc:`2021.11.0`
|
||||
- :doc:`2021.10.0`
|
||||
- :doc:`2021.9.0`
|
||||
- :doc:`2021.8.0`
|
||||
- :doc:`v1.20.0`
|
||||
- :doc:`v1.19.0`
|
||||
- :doc:`v1.18.0`
|
||||
- :doc:`v1.17.0`
|
||||
- :doc:`v1.16.0`
|
||||
- :doc:`v1.15.0`
|
||||
- :doc:`v1.14.0`
|
||||
- :doc:`v1.13.0`
|
||||
- :doc:`v1.12.0`
|
||||
- :doc:`v1.11.0`
|
||||
- :doc:`v1.10.0`
|
||||
- :doc:`v1.9.0`
|
||||
- :doc:`v1.8.0`
|
||||
- :doc:`v1.7.0`
|
||||
@ -2,7 +2,7 @@ Changelog
|
||||
=========
|
||||
|
||||
.. redirect::
|
||||
:url: /changelog/2022.11.0.html
|
||||
:url: /changelog/2022.12.0.html
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
||||
@ -14,7 +14,7 @@ and Home Assistant.
|
||||
If you're looking to create an ESPHome node that is just a Bluetooth Proxy, see
|
||||
our `Bluetooth Proxy installer <https://esphome.github.io/bluetooth-proxies/>`__ website.
|
||||
|
||||
.. note::
|
||||
.. warning:: Active connections
|
||||
|
||||
The Bluetooth proxy of ESPHome provides Home Assistant with a maximum number of 3 simultaneous active connections.
|
||||
Devices which maintain a *continuous active* connection will consume one of these constantly, whilst devices which
|
||||
@ -22,6 +22,14 @@ our `Bluetooth Proxy installer <https://esphome.github.io/bluetooth-proxies/>`__
|
||||
Passively broadcasted sensor data (that is advertised by certain devices without active connections) is received
|
||||
separately from these, and is not limited to a specific number.
|
||||
|
||||
The :doc:`esp32` component should be configured to use the ``esp-idf`` framework, as the ``arduino`` framework
|
||||
uses significantly more memory and performs poorly with the Bluetooth proxy enabled. When switching from
|
||||
``arduino`` to ``esp-idf``, make sure to update the device with a serial cable as the partition table is
|
||||
different between the two frameworks as :doc:`ota` updates will not change the partition table.
|
||||
|
||||
The :doc:`web_server` component should be disabled as the device is likely
|
||||
to run out of memory and will malfunction when both components are enabled simultaneously.
|
||||
|
||||
Not all devices are supported and ESPHome does not decode or keep a list. To find out if your device is supported,
|
||||
please search for it in the `Home Assistant Integrations <https://www.home-assistant.io/integrations/>`__ list.
|
||||
|
||||
@ -33,12 +41,13 @@ Configuration:
|
||||
bluetooth_proxy:
|
||||
|
||||
- **active** (*Optional*, boolean): Enables proxying active connections. Defaults to ``false``. Requires Home Assistant 2022.10 or later.
|
||||
- **cache_services** (*Optional*, boolean): Enables caching GATT services in NVS flash storage which significantly speeds up active connections. Defaults to ``true`` when using the ESP-IDF framework.
|
||||
|
||||
The Bluetooth proxy depends on :doc:`esp32_ble_tracker` so make sure to add that to your configuration.
|
||||
|
||||
.. note::
|
||||
|
||||
Bluetooth proxy requires Home Assistant 2022.9 or later.
|
||||
Bluetooth proxy requires Home Assistant 2022.9 or later. ESPHome 2022.12.0 and Home Assistant 2022.12.6 or later is recommended.
|
||||
|
||||
Improving reception performance
|
||||
-------------------------------
|
||||
@ -55,6 +64,54 @@ To maximize the chances of catching advertisements of the sensors, you can set `
|
||||
|
||||
Avoid placing the ESP node in racks, close to routers/switches or other network equipment as EMI interference will degrade Bluetooth signal reception. For best results put as far away as possible, at least 3 meters distance from any other such equipment. Place your ESPHome devices close to the Bluetooth devices that you want to interact with for the best experience.
|
||||
|
||||
Complete sample recommended configuration
|
||||
-----------------------------------------
|
||||
|
||||
Below is a complete sample recommended configuration for a Bluetooth proxy. If you experience issues with your proxy, try reducing your configuration to be as similar to this as possible.
|
||||
|
||||
This configuration is for an Olimex ESP32-PoE-ISO board with an Ethernet connection to the network. If you use a different board, you must change the ``board`` substitution to match your board.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
substitutions:
|
||||
name: my-bluetooth-proxy
|
||||
board: esp32-poe-iso
|
||||
|
||||
esphome:
|
||||
name: ${name}
|
||||
name_add_mac_suffix: true
|
||||
|
||||
esp32:
|
||||
board: ${board}
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
ethernet:
|
||||
type: LAN8720
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO17_OUT
|
||||
phy_addr: 0
|
||||
power_pin: GPIO12
|
||||
|
||||
# Enable logging
|
||||
logger:
|
||||
|
||||
# Enable Home Assistant API
|
||||
api:
|
||||
|
||||
ota:
|
||||
|
||||
esp32_ble_tracker:
|
||||
scan_parameters:
|
||||
interval: 1100ms
|
||||
window: 1100ms
|
||||
active: true
|
||||
|
||||
bluetooth_proxy:
|
||||
active: true
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -134,6 +134,24 @@ Below is a definition that includes a pixel_mapper suitable for these 8x32 matri
|
||||
rotation: 0°
|
||||
update_interval: 16ms
|
||||
|
||||
It's possible to use two 8x32 LED matrices in a 16x32 configuration (one above the other) by using the following definition:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
display:
|
||||
- platform: addressable_light
|
||||
id: led_matrix_32x16_display
|
||||
addressable_light_id: led_matrix_32x16
|
||||
width: 32
|
||||
height: 16
|
||||
pixel_mapper: |-
|
||||
int iMatrixOffset = y >= 8 ? 256 : 0;
|
||||
if (x % 2 == 0) {
|
||||
return (x * 8) + (y % 8) + iMatrixOffset;
|
||||
}
|
||||
return (x * 8) + iMatrixOffset + (7 - (y % 8));
|
||||
rotation: 0°
|
||||
update_interval: 16ms
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
@ -32,7 +32,7 @@ Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **type** (**Required**, string): The type of LAN chipset/phy. Must be one of
|
||||
``LAN8720``, ``TLK110`` or ``IP101`` (see datasheet for more details).
|
||||
``LAN8720``, ``RTL8201``, ``DP83848`` or ``IP101``.
|
||||
- **mdc_pin** (**Required**, :ref:`config-pin`): The MDC pin of the board.
|
||||
Usually this is ``GPIO23``.
|
||||
- **mdio_pin** (**Required**, :ref:`config-pin`): The MDIO pin of the board.
|
||||
@ -73,8 +73,10 @@ Configuration variables:
|
||||
clock signal that will not travel reliably over these types of connections. For more
|
||||
information and wiring details refer to the link in the *See also* section.
|
||||
|
||||
Configuration for Olimex ESP32-POE
|
||||
----------------------------------
|
||||
Configuration examples
|
||||
----------------------
|
||||
|
||||
**Olimex ESP32-POE**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -86,8 +88,8 @@ Configuration for Olimex ESP32-POE
|
||||
phy_addr: 0
|
||||
power_pin: GPIO12
|
||||
|
||||
Configuration for Olimex ESP32-EVB
|
||||
----------------------------------
|
||||
|
||||
**Olimex ESP32-EVB**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -98,8 +100,7 @@ Configuration for Olimex ESP32-EVB
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 0
|
||||
|
||||
Configuration for Olimex ESP32-GATEWAY
|
||||
--------------------------------------
|
||||
**Olimex ESP32-GATEWAY** and **LILYGO TTGO T-Internet-POE ESP32-WROOM LAN8270A**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -110,20 +111,7 @@ Configuration for Olimex ESP32-GATEWAY
|
||||
clk_mode: GPIO17_OUT
|
||||
phy_addr: 0
|
||||
|
||||
Configuration for LILYGO TTGO T-Internet-POE ESP32-WROOM LAN8270A Chip
|
||||
----------------------------------------------------------------------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: LAN8720
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO17_OUT
|
||||
phy_addr: 0
|
||||
|
||||
Configuration for Wireless Tag WT32-ETH01
|
||||
-----------------------------------------
|
||||
**Wireless Tag WT32-ETH01** and **SMLIGHT SLZB-06 PoE Zigbee**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -135,8 +123,55 @@ Configuration for Wireless Tag WT32-ETH01
|
||||
phy_addr: 1
|
||||
power_pin: GPIO16
|
||||
|
||||
Configuration for OpenHacks LAN8720
|
||||
-----------------------------------
|
||||
**M5Stack PoESP32** and **ESP32-Ethernet-Kit**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: IP101
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 1
|
||||
power_pin: GPIO5
|
||||
|
||||
**AiThinker ESP32-G Gateway**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: LAN8720
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO17_OUT
|
||||
phy_addr: 1
|
||||
power_pin: GPIO5
|
||||
|
||||
**wESP32**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# for board up to rev.5
|
||||
ethernet:
|
||||
type: LAN8720
|
||||
mdc_pin: GPIO16
|
||||
mdio_pin: GPIO17
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 0
|
||||
|
||||
# for board rev.7 and up
|
||||
ethernet:
|
||||
type: RTL8201
|
||||
mdc_pin: GPIO16
|
||||
mdio_pin: GPIO17
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 0
|
||||
|
||||
.. note::
|
||||
|
||||
Revision 5 and below of the wESP32 board use the LAN8720 Ethernet PHY. Revision 7 and newer of it use the RTL8201 Ethernet PHY. Support for RTL8201 is available from ESPHome version 2022.12 upwards.
|
||||
|
||||
**OpenHacks LAN8720**:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -152,55 +187,13 @@ Configuration for OpenHacks LAN8720
|
||||
you are monitoring the serial output and reboot the device several times to see if it boots into the
|
||||
program properly.
|
||||
|
||||
Configuration for wESP32 board (up to rev.6)
|
||||
--------------------------------------------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: LAN8720
|
||||
mdc_pin: GPIO16
|
||||
mdio_pin: GPIO17
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 0
|
||||
|
||||
.. note::
|
||||
|
||||
Revision 7 and upwards of the wESP32 board does not have a LAN8720 chip. Until support for the
|
||||
replacement RTL8201 is included in ESPHome, the wESP board rev.7 will not work with the above configuration.
|
||||
|
||||
Configuration for ESP32-Ethernet-Kit board
|
||||
------------------------------------------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: IP101
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 1
|
||||
power_pin: GPIO5
|
||||
|
||||
|
||||
Configuration for M5Stack PoESP32 Unit
|
||||
--------------------------------------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
ethernet:
|
||||
type: IP101
|
||||
mdc_pin: GPIO23
|
||||
mdio_pin: GPIO18
|
||||
clk_mode: GPIO0_IN
|
||||
phy_addr: 1
|
||||
power_pin: GPIO5
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`network`
|
||||
- :doc:`text_sensor/ethernet_info`
|
||||
- :apiref:`ethernet/ethernet_component.h`
|
||||
- `ESP32 Ethernet PHY connection info <https://pcbartists.com/design/embedded/esp32-ethernet-phy-schematic-design/>`__
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -20,3 +20,9 @@ Configuration variables:
|
||||
|
||||
- **enable_ipv6** (*Optional*, boolean): Enables IPv6 support. Defaults to ``false``. Only available on ESP32 with ESP-IDF framework.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/wifi`
|
||||
- :doc:`/components/ethernet`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -335,6 +335,30 @@ advanced stuff (see the full API Reference for more info).
|
||||
ESP_LOGI("main", "Select has index offset %d", index);
|
||||
}
|
||||
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
Setting up three options and set component state to selected option value.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
select:
|
||||
- platform: template
|
||||
name: Mode
|
||||
id: mode
|
||||
options:
|
||||
- "Option1"
|
||||
- "Option2"
|
||||
- "Option3"
|
||||
set_action:
|
||||
- logger.log:
|
||||
format: "Chosen option: %s"
|
||||
args: ["x.c_str()"]
|
||||
- lambda: |-
|
||||
id(mode).state = x.c_str();
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
||||
@ -62,5 +62,6 @@ See Also
|
||||
|
||||
- :ref:`sensor-filters`
|
||||
- :doc:`/components/wifi`
|
||||
- :doc:`/components/text_sensor/wifi_info`
|
||||
- :apiref:`wifi_signal/wifi_signal_sensor.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -544,6 +544,11 @@ Optional with **name**, **id** (:ref:`config-id`) and all other options from :re
|
||||
- **formaldehyde**
|
||||
- **battery_level**
|
||||
|
||||
|
||||
.. _obtaining_the_mac_address:
|
||||
|
||||
Obtaining the MAC address
|
||||
-------------------------
|
||||
To find the MAC Address so that ESPHome can identify the device, you can create a simple configuration without any sensor entries:
|
||||
|
||||
.. code-block:: yaml
|
||||
@ -564,7 +569,7 @@ It can sometimes take some time for the first BLE broadcast to be received. Once
|
||||
|
||||
.. _obtaining_the_bindkey:
|
||||
|
||||
Obtaining The Bindkey
|
||||
Obtaining the Bindkey
|
||||
---------------------
|
||||
|
||||
To set up an encrypted device such as the LYWSD03MMC (with Xiaomi stock firmware) and CGD1, you first need to obtain the bind key. The ``xiaomi_ble`` sensor component is not able to automatically generate a bindkey so other workarounds are necessary.
|
||||
|
||||
@ -26,5 +26,6 @@ Configuration variables:
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/ethernet`
|
||||
- :apiref:`ethernet_info/ethernet_info_text_sensor.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -41,5 +41,7 @@ Configuration variables:
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/wifi`
|
||||
- :doc:`/components/sensor/wifi_signal`
|
||||
- :apiref:`wifi_info/wifi_info_text_sensor.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -289,6 +289,9 @@ See Also
|
||||
--------
|
||||
|
||||
- :doc:`captive_portal`
|
||||
- :doc:`text_sensor/wifi_info`
|
||||
- :doc:`sensor/wifi_signal`
|
||||
- :doc:`network`
|
||||
- :doc:`/components/ethernet`
|
||||
- :apiref:`wifi/wifi_component.h`
|
||||
- :ghedit:`Edit`
|
||||
|
||||
@ -190,8 +190,6 @@ Contributors
|
||||
- `Alex Solomaha (@CyanoFresh) <https://github.com/CyanoFresh>`__
|
||||
- `Luar Roji (@cyberplant) <https://github.com/cyberplant>`__
|
||||
- `Aleš Komárek (@cznewt) <https://github.com/cznewt>`__
|
||||
- `d-two (@d-two) <https://github.com/d-two>`__
|
||||
- `dab0g (@dab0g) <https://github.com/dab0g>`__
|
||||
- `Dale Higgs (@dale3h) <https://github.com/dale3h>`__
|
||||
- `damanti-me (@damanti-me) <https://github.com/damanti-me>`__
|
||||
- `Daniel Bjørnbakk (@danibjor) <https://github.com/danibjor>`__
|
||||
@ -204,12 +202,10 @@ Contributors
|
||||
- `Dav-id (@dav-id-org) <https://github.com/dav-id-org>`__
|
||||
- `DAVe3283 (@DAVe3283) <https://github.com/DAVe3283>`__
|
||||
- `Dave Richer (@davericher) <https://github.com/davericher>`__
|
||||
- `davestubbs (@davestubbs) <https://github.com/davestubbs>`__
|
||||
- `Dave T (@davet2001) <https://github.com/davet2001>`__
|
||||
- `Dave Wongillies (@davewongillies) <https://github.com/davewongillies>`__
|
||||
- `David De Sloovere (@DavidDeSloovere) <https://github.com/DavidDeSloovere>`__
|
||||
- `David Beitey (@davidjb) <https://github.com/davidjb>`__
|
||||
- `davidmonro (@davidmonro) <https://github.com/davidmonro>`__
|
||||
- `David Zovko (@davidzovko) <https://github.com/davidzovko>`__
|
||||
- `Davy Landman (@DavyLandman) <https://github.com/DavyLandman>`__
|
||||
- `Darren Tucker (@daztucker) <https://github.com/daztucker>`__
|
||||
@ -449,6 +445,7 @@ Contributors
|
||||
- `Joe Gross (@joegross) <https://github.com/joegross>`__
|
||||
- `Johan van der Kuijl (@johanvanderkuijl) <https://github.com/johanvanderkuijl>`__
|
||||
- `Johboh (@Johboh) <https://github.com/Johboh>`__
|
||||
- `John Britton (@johndbritton) <https://github.com/johndbritton>`__
|
||||
- `John Erik Halse (@johnerikhalse) <https://github.com/johnerikhalse>`__
|
||||
- `John Moxley (@johnmoxley) <https://github.com/johnmoxley>`__
|
||||
- `JonasEr (@JonasEr) <https://github.com/JonasEr>`__
|
||||
@ -610,6 +607,7 @@ Contributors
|
||||
- `mnltake (@mnltake) <https://github.com/mnltake>`__
|
||||
- `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__
|
||||
- `Moritz Glöckl (@moritzgloeckl) <https://github.com/moritzgloeckl>`__
|
||||
- `Chris Laplante (@mostthingsweb) <https://github.com/mostthingsweb>`__
|
||||
- `Matthew Pettitt (@mpettitt) <https://github.com/mpettitt>`__
|
||||
- `Sam Hughes (@MrEditor97) <https://github.com/MrEditor97>`__
|
||||
- `Mariusz Kryński (@mrk-its) <https://github.com/mrk-its>`__
|
||||
@ -643,12 +641,14 @@ Contributors
|
||||
- `niklasweber (@niklasweber) <https://github.com/niklasweber>`__
|
||||
- `Niorix (@Niorix) <https://github.com/Niorix>`__
|
||||
- `Zvonimir Haramustek (@nitko12) <https://github.com/nitko12>`__
|
||||
- `Dennis (@Nizzle) <https://github.com/Nizzle>`__
|
||||
- `nldroid (@nldroid) <https://github.com/nldroid>`__
|
||||
- `Niccolò Maggioni (@nmaggioni) <https://github.com/nmaggioni>`__
|
||||
- `Jan Sandbrink (@NobodysNightmare) <https://github.com/NobodysNightmare>`__
|
||||
- `Łukasz Śliwiński (@nonameplum) <https://github.com/nonameplum>`__
|
||||
- `Greg Johnson (@notgwj) <https://github.com/notgwj>`__
|
||||
- `nouser2013 (@nouser2013) <https://github.com/nouser2013>`__
|
||||
- `Stephen Edgar (@ntwb) <https://github.com/ntwb>`__
|
||||
- `Stanislav Meduna (@numo68) <https://github.com/numo68>`__
|
||||
- `Nuno Sousa (@nunofgs) <https://github.com/nunofgs>`__
|
||||
- `Maksym Lunin (@nut-code-monkey) <https://github.com/nut-code-monkey>`__
|
||||
@ -747,6 +747,7 @@ Contributors
|
||||
- `Jan Čermák (@sairon) <https://github.com/sairon>`__
|
||||
- `sascha lammers (@sascha432) <https://github.com/sascha432>`__
|
||||
- `Søren Christian Aarup (@scaarup) <https://github.com/scaarup>`__
|
||||
- `Matthew Schinckel (@schinckel) <https://github.com/schinckel>`__
|
||||
- `Nils Schulte (@Schnilz) <https://github.com/Schnilz>`__
|
||||
- `Wolle (@schreibfaul1) <https://github.com/schreibfaul1>`__
|
||||
- `Ville Skyttä (@scop) <https://github.com/scop>`__
|
||||
@ -886,13 +887,13 @@ Contributors
|
||||
- `Wolfgang Tremmel (@wtremmel) <https://github.com/wtremmel>`__
|
||||
- `Wumpf (@Wumpf) <https://github.com/Wumpf>`__
|
||||
- `wysiwyng (@wysiwyng) <https://github.com/wysiwyng>`__
|
||||
- `Mike (@xsnoopy) <https://github.com/xsnoopy>`__
|
||||
- `Yaroslav (@Yarikx) <https://github.com/Yarikx>`__
|
||||
- `Marcin Jaworski (@yawor) <https://github.com/yawor>`__
|
||||
- `Pavel (@yekm) <https://github.com/yekm>`__
|
||||
- `Atsuko Ito (@yottatsa) <https://github.com/yottatsa>`__
|
||||
- `Nico B (@youknow0) <https://github.com/youknow0>`__
|
||||
- `Yuval Aboulafia (@yuvalabou) <https://github.com/yuvalabou>`__
|
||||
- `Björn Stenberg (@zagor) <https://github.com/zagor>`__
|
||||
- `david reid (@zathras777) <https://github.com/zathras777>`__
|
||||
- `Zebble (@Zebble) <https://github.com/Zebble>`__
|
||||
- `ZJY (@zhangjingye03) <https://github.com/zhangjingye03>`__
|
||||
@ -903,4 +904,4 @@ Contributors
|
||||
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
|
||||
*This page was last updated December 6, 2022.*
|
||||
*This page was last updated December 14, 2022.*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user