mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-08-26 23:39:46 +02:00
commit
b5f55cadfa
2
Doxygen
2
Doxygen
|
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 2021.10.0b2
|
PROJECT_NUMBER = 2021.10.0b3
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# 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
|
# 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_PATH = ../esphome
|
||||||
ESPHOME_REF = 2021.10.0b2
|
ESPHOME_REF = 2021.10.0b3
|
||||||
|
|
||||||
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||||
|
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
2021.10.0b2
|
2021.10.0b3
|
|
@ -150,6 +150,18 @@ Breaking Changes
|
||||||
- Correctly invert the float output state :esphomepr:`2368` by :ghuser:`jesserockz` (breaking-change)
|
- Correctly invert the float output state :esphomepr:`2368` by :ghuser:`jesserockz` (breaking-change)
|
||||||
- Add SSD1305 support to SSD1306 integration along with few new options :esphomepr:`1902` by :ghuser:`zhangjingye03` (new-feature) (breaking-change)
|
- Add SSD1305 support to SSD1306 integration along with few new options :esphomepr:`1902` by :ghuser:`zhangjingye03` (new-feature) (breaking-change)
|
||||||
|
|
||||||
|
Beta Fixes
|
||||||
|
^^^^^^^^^^
|
||||||
|
|
||||||
|
- Fix light state remaining on after turn off with transition :esphomepr:`2509` by :ghuser:`oxan`
|
||||||
|
- Fix: Light flash not restoring previous LightState :esphomepr:`2383` by :ghuser:`paulmonigatti`
|
||||||
|
- Disallow using UART2 for logger on ESP-32 variants that lack it :esphomepr:`2510` by :ghuser:`oxan`
|
||||||
|
- Fix BME680_BSEC compilation issue with ESP32 :esphomepr:`2516` by :ghuser:`paulmonigatti`
|
||||||
|
- add missing include in sgp30 :esphomepr:`2517` by :ghuser:`dmitriy5181`
|
||||||
|
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
||||||
|
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
||||||
|
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
||||||
|
|
||||||
All changes
|
All changes
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
|
|
||||||
|
@ -326,6 +338,14 @@ All changes
|
||||||
- Improves ct_clamp component accuracy :esphomepr:`2283` by :ghuser:`skasi7`
|
- Improves ct_clamp component accuracy :esphomepr:`2283` by :ghuser:`skasi7`
|
||||||
- Allow multiple pn532_spi entries :esphomepr:`2489` by :ghuser:`jesserockz`
|
- Allow multiple pn532_spi entries :esphomepr:`2489` by :ghuser:`jesserockz`
|
||||||
- Add throttle_average sensor filter :esphomepr:`2485` by :ghuser:`sermayoral`
|
- Add throttle_average sensor filter :esphomepr:`2485` by :ghuser:`sermayoral`
|
||||||
|
- Fix light state remaining on after turn off with transition :esphomepr:`2509` by :ghuser:`oxan`
|
||||||
|
- Fix: Light flash not restoring previous LightState :esphomepr:`2383` by :ghuser:`paulmonigatti`
|
||||||
|
- Disallow using UART2 for logger on ESP-32 variants that lack it :esphomepr:`2510` by :ghuser:`oxan`
|
||||||
|
- Fix BME680_BSEC compilation issue with ESP32 :esphomepr:`2516` by :ghuser:`paulmonigatti`
|
||||||
|
- add missing include in sgp30 :esphomepr:`2517` by :ghuser:`dmitriy5181`
|
||||||
|
- Fix: Color modes not being correctly used in light partitions :esphomepr:`2513` by :ghuser:`paulmonigatti`
|
||||||
|
- Don't define UART_SELECTION_UART2 when UART2 is unavailable :esphomepr:`2512` by :ghuser:`oxan`
|
||||||
|
- Remove BME680_BSEC test :esphomepr:`2518` by :ghuser:`paulmonigatti`
|
||||||
|
|
||||||
Past Changelogs
|
Past Changelogs
|
||||||
---------------
|
---------------
|
||||||
|
|
|
@ -67,17 +67,17 @@ Configuration variables:
|
||||||
|
|
||||||
- **current** (*Optional*): Use the current value of the sensor in amperes. All options from
|
- **current** (*Optional*): Use the current value of the sensor in amperes. All options from
|
||||||
:ref:`Sensor <config-sensor>`.
|
:ref:`Sensor <config-sensor>`.
|
||||||
- **voltage** (*Optional*): Use the voltage value of the sensor in volts.
|
- **voltage** (*Optional*): Use the voltage value of the sensor in volts (V).
|
||||||
All options from :ref:`Sensor <config-sensor>`.
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **active_power** (*Optional*): Use the (active) power value of the sensor in watts. All options
|
- **active_power** (*Optional*): Use the (active) power value of the sensor in watts (W). All options
|
||||||
from :ref:`Sensor <config-sensor>`.
|
from :ref:`Sensor <config-sensor>`.
|
||||||
- **power_factor** (*Optional*): Use the power factor value of the sensor.
|
- **power_factor** (*Optional*): Use the power factor value of the sensor.
|
||||||
All options from :ref:`Sensor <config-sensor>`.
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **apparent_power** (*Optional*): Use the apparent power value of the sensor in VA. All
|
- **apparent_power** (*Optional*): Use the apparent power value of the sensor in volt amps (VA). All
|
||||||
options from :ref:`Sensor <config-sensor>`.
|
options from :ref:`Sensor <config-sensor>`.
|
||||||
- **reactive_power** (*Optional*): Use the reactive power value of the sensor in VAR. All
|
- **reactive_power** (*Optional*): Use the reactive power value of the sensor in volt amps reactive (VAR). All
|
||||||
options from :ref:`Sensor <config-sensor>`.
|
options from :ref:`Sensor <config-sensor>`.
|
||||||
- **phase_angle** (*Optional*): Use the phase angle value of the sensor in degree. All options
|
- **phase_angle** (*Optional*): Use the phase angle value of the sensor in degrees (°). All options
|
||||||
from :ref:`Sensor <config-sensor>`.
|
from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
- **phase_b** (*Optional*): The group of exposed sensors for Phase B/2 on applicable meters. eg: SDM630
|
- **phase_b** (*Optional*): The group of exposed sensors for Phase B/2 on applicable meters. eg: SDM630
|
||||||
|
@ -90,14 +90,14 @@ Configuration variables:
|
||||||
|
|
||||||
- **frequency** (*Optional*): Use the frequency value of the sensor in hertz.
|
- **frequency** (*Optional*): Use the frequency value of the sensor in hertz.
|
||||||
All options from :ref:`Sensor <config-sensor>`.
|
All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **import_active_energy** (*Optional*): Use the import active energy value of the sensor in watt
|
- **import_active_energy** (*Optional*): Use the import active energy value of the sensor in kilowatt
|
||||||
hours. All options from :ref:`Sensor <config-sensor>`.
|
hours (kWh). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **export_active_energy** (*Optional*): Use the export active energy value of the sensor in watt
|
- **export_active_energy** (*Optional*): Use the export active energy value of the sensor in kilowatt
|
||||||
hours. All options from :ref:`Sensor <config-sensor>`.
|
hours (kWh). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **import_reactive_energy** (*Optional*): Use the import reactive energy value of the sensor in
|
- **import_reactive_energy** (*Optional*): Use the import reactive energy value of the sensor in
|
||||||
volt amps reactive hours. All options from :ref:`Sensor <config-sensor>`.
|
kilovolt amps reactive hours (kVArh). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **export_reactive_energy** (*Optional*): Use the export reactive energy value of the sensor in
|
- **export_reactive_energy** (*Optional*): Use the export reactive energy value of the sensor in
|
||||||
volt amps reactive hours. All options from :ref:`Sensor <config-sensor>`.
|
kilovolt amps reactive hours (kVArh). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||||
sensor. Defaults to ``60s``.
|
sensor. Defaults to ``60s``.
|
||||||
- **address** (*Optional*, int): The address of the sensor if multiple sensors are attached to
|
- **address** (*Optional*, int): The address of the sensor if multiple sensors are attached to
|
||||||
|
|
|
@ -9,6 +9,14 @@ The ``sgp40`` sensor platform allows you to use your Sensirion SGP40 VOC sensor
|
||||||
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9_Gas_Sensors/Sensirion_Gas_Sensors_SGP40_Datasheet.pdf>`__) with ESPHome.
|
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9_Gas_Sensors/Sensirion_Gas_Sensors_SGP40_Datasheet.pdf>`__) with ESPHome.
|
||||||
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
|
The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This sensor need to be driven at a rate of 1Hz. Because of this, the
|
||||||
|
sensor will be read out on device once a second separately from the
|
||||||
|
update_interval. The state will be reported to other components, or
|
||||||
|
the front end at the update_interval, saving wifi power and network
|
||||||
|
communication.
|
||||||
|
|
||||||
.. figure:: images/sgp40.jpg
|
.. figure:: images/sgp40.jpg
|
||||||
:align: center
|
:align: center
|
||||||
:width: 80.0%
|
:width: 80.0%
|
||||||
|
|
2
conf.py
2
conf.py
|
@ -69,7 +69,7 @@ author = "Otto Winter"
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = "2021.10"
|
version = "2021.10"
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = "2021.10.0b2"
|
release = "2021.10.0b3"
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
|
|
@ -165,6 +165,7 @@ Contributors
|
||||||
- `dentra (@dentra) <https://github.com/dentra>`__
|
- `dentra (@dentra) <https://github.com/dentra>`__
|
||||||
- `Davide Depau (@Depau) <https://github.com/Depau>`__
|
- `Davide Depau (@Depau) <https://github.com/Depau>`__
|
||||||
- `dependabot[bot] (@dependabot[bot]) <https://github.com/dependabot[bot]>`__
|
- `dependabot[bot] (@dependabot[bot]) <https://github.com/dependabot[bot]>`__
|
||||||
|
- `Joeri Colman (@depuits) <https://github.com/depuits>`__
|
||||||
- `Destix (@Destix) <https://github.com/Destix>`__
|
- `Destix (@Destix) <https://github.com/Destix>`__
|
||||||
- `Develo (@devyte) <https://github.com/devyte>`__
|
- `Develo (@devyte) <https://github.com/devyte>`__
|
||||||
- `Dezorian (@Dezorian) <https://github.com/Dezorian>`__
|
- `Dezorian (@Dezorian) <https://github.com/Dezorian>`__
|
||||||
|
@ -177,6 +178,7 @@ Contributors
|
||||||
- `djtef (@djtef) <https://github.com/djtef>`__
|
- `djtef (@djtef) <https://github.com/djtef>`__
|
||||||
- `Marcos Pérez Ferro (@djwmarcx) <https://github.com/djwmarcx>`__
|
- `Marcos Pérez Ferro (@djwmarcx) <https://github.com/djwmarcx>`__
|
||||||
- `Dan Mannock (@dmannock) <https://github.com/dmannock>`__
|
- `Dan Mannock (@dmannock) <https://github.com/dmannock>`__
|
||||||
|
- `Dmitriy Lopatko (@dmitriy5181) <https://github.com/dmitriy5181>`__
|
||||||
- `dmkif (@dmkif) <https://github.com/dmkif>`__
|
- `dmkif (@dmkif) <https://github.com/dmkif>`__
|
||||||
- `Farzad E. (@dnetguru) <https://github.com/dnetguru>`__
|
- `Farzad E. (@dnetguru) <https://github.com/dnetguru>`__
|
||||||
- `DrZoid (@docteurzoidberg) <https://github.com/docteurzoidberg>`__
|
- `DrZoid (@docteurzoidberg) <https://github.com/docteurzoidberg>`__
|
||||||
|
@ -556,6 +558,7 @@ Contributors
|
||||||
- `Pär Stålberg (@rabbadab) <https://github.com/rabbadab>`__
|
- `Pär Stålberg (@rabbadab) <https://github.com/rabbadab>`__
|
||||||
- `Radim Karniš (@radimkarnis) <https://github.com/radimkarnis>`__
|
- `Radim Karniš (@radimkarnis) <https://github.com/radimkarnis>`__
|
||||||
- `Florian Ragwitz (@rafl) <https://github.com/rafl>`__
|
- `Florian Ragwitz (@rafl) <https://github.com/rafl>`__
|
||||||
|
- `razorback16 (@razorback16) <https://github.com/razorback16>`__
|
||||||
- `rbaron (@rbaron) <https://github.com/rbaron>`__
|
- `rbaron (@rbaron) <https://github.com/rbaron>`__
|
||||||
- `Robert Cambridge (@rcambrj) <https://github.com/rcambrj>`__
|
- `Robert Cambridge (@rcambrj) <https://github.com/rcambrj>`__
|
||||||
- `Ronald Dehuysser (@rdehuyss) <https://github.com/rdehuyss>`__
|
- `Ronald Dehuysser (@rdehuyss) <https://github.com/rdehuyss>`__
|
||||||
|
@ -739,4 +742,4 @@ Contributors
|
||||||
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
||||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||||
|
|
||||||
*This page was last updated October 13, 2021.*
|
*This page was last updated October 15, 2021.*
|
||||||
|
|
Loading…
Reference in New Issue
Block a user