mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-06-26 10:34:54 +02:00
Merge branch 'current' into next
This commit is contained in:
Jesse Hills
commit
644a52fa2d
|
|
@ -410,7 +410,10 @@ RGB displays use red, green, and blue, while grayscale displays may use white.
|
|||
Graph Component
|
||||
***************
|
||||
|
||||
You can display a graph of a sensor value(s) using this component. Examples:
|
||||
You can display a graph of a sensor value(s) using this component. The states used for the graph are stored in
|
||||
memory at the time the sensor updates and will be lost when the device reboots.
|
||||
|
||||
Examples:
|
||||
|
||||
.. figure:: images/graph_screen.png
|
||||
:align: center
|
||||
|
|
|
|||
|
|
@ -16,6 +16,10 @@ ST7789V (`datasheet <https://github.com/Xinyuan-LilyGO/TTGO-T-Display>`__,
|
|||
displays with ESPHome. Note that this component utilizes the 4-Wire :ref:`SPI bus <spi>`; the physical
|
||||
connection is already in place on the TTGO T-Display module as shown below.
|
||||
|
||||
.. note::
|
||||
|
||||
Currently this only supports 135x240 pixel ST7789V displays. Other sizes (e.g. 240x320, 240x240) are not supported.
|
||||
|
||||
.. figure:: images/st7789v-full.jpg
|
||||
:align: center
|
||||
:width: 75.0%
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ Ethernet Component
|
|||
|
||||
This core ESPHome component sets up ethernet connections for ESP32s.
|
||||
Ethernet for ESP8266 is not supported.
|
||||
This component can't be used in same time than Wifi one, even if your ESP32 has both wired.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,10 @@ ESPHome also has an "OTA safe mode". If for some reason your
|
|||
node gets into a boot loop, ESPHome will automatically try to detect
|
||||
this and will go over into a safe mode after the configured unsuccessful boot
|
||||
attempts (Defaults to ``10``). In that mode, all components are disabled and only Serial
|
||||
Logging+WiFi+OTA are initialized, so that you can upload a new binary.
|
||||
Logging + Network(WiFi or Ethernet) + OTA are initialized, so that you can upload a new
|
||||
binary. You can trigger entering safe mode by either configuring a dedicated button or
|
||||
switch to do that or by pressing the reset button on the board for ``num_attempts`` times.
|
||||
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -192,4 +195,6 @@ See Also
|
|||
--------
|
||||
|
||||
- :apiref:`ota/ota_component.h`
|
||||
- :doc:`/components/button/safe_mode`
|
||||
- :doc:`/components/switch/safe_mode`
|
||||
- :ghedit:`Edit`
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ To simplify this, we provide the setting ``attenuation: auto`` for an automatic/
|
|||
Different ESP32-ADC behavior since 2021.11
|
||||
------------------------------------------
|
||||
|
||||
The ADC output reads voltage very accurately since 2021.11 where manufacturer calibration was incorporated. Before this every ESP32 would read different voltages and be largely innacurate/nonlinear. Users with a manually calibrated setup are encouraged to check their the installations to ensure proper output.
|
||||
The ADC output reads voltage very accurately since 2021.11 where manufacturer calibration was incorporated. Before this every ESP32 would read different voltages and be largely inaccurate/nonlinear. Users with a manually calibrated setup are encouraged to check their installations to ensure proper output.
|
||||
For users that don't need a precise voltage reading, the "raw" output option allows to have the raw ADC values (0-4095 for ESP32) prior to manufacturer calibration. It is possible to get the old uncalibrated measurements with a filter multiplier:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
|
|
|||
|
|
@ -398,7 +398,9 @@ out an average on a specific interval (thus increasing resolution).
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **alpha** (*Optional*, float): The forget factor/alpha value of the filter. Defaults to ``0.1``.
|
||||
- **alpha** (*Optional*, float): The forget factor/alpha value of the filter.
|
||||
A higher value includes more details in the output while a lower value removes more noise.
|
||||
Defaults to ``0.1``.
|
||||
- **send_every** (*Optional*, int): How often a sensor value should be pushed out. Defaults to ``15``.
|
||||
- **send_first_at** (*Optional*, int): By default, the very first raw value on boot is immediately
|
||||
published. With this parameter you can specify when the very first value is to be sent.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
MCP3008 I/O Expander
|
||||
====================
|
||||
MCP3008 8-Channel 10-Bit A/D Converter
|
||||
======================================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up MCP3008 10 Bit Analog to Digital Converter in ESPHome.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Sun
|
|||
:description: Instructions for setting up tracking the sun position in ESPHome.
|
||||
:image: weather-sunny.svg
|
||||
|
||||
The ``sun`` component allows you to track the sun's position in the sky.
|
||||
The ``sun`` component allows you to track the sun's position in the sky. Calculations are done every 60 seconds.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -29,8 +29,8 @@ Configuration variables:
|
|||
- **name** (**Required**, string): The name for the switch.
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- **restore_mode** (*Optional*): Control how the GPIO Switch attempts to restore state on bootup.
|
||||
For restoring on ESP8266s, also see ``esp8266_restore_from_flash`` in the
|
||||
:doc:`esphome section </components/esphome>`.
|
||||
For restoring on ESP8266s, also see ``restore_from_flash`` in the
|
||||
:doc:`esp8266 section </components/esp8266>`.
|
||||
|
||||
- ``RESTORE_DEFAULT_OFF`` (Default) - Attempt to restore state and default to OFF if not possible to restore.
|
||||
- ``RESTORE_DEFAULT_ON`` - Attempt to restore state and default to ON.
|
||||
|
|
|
|||
|
|
@ -85,7 +85,20 @@ The write command to be constructed uses the function code to determine the writ
|
|||
Because the write command only touches one register start_address and offset have to be corrected.
|
||||
The final command will be write_single_coil address 5 (start_address+offset) value 1 or 0
|
||||
|
||||
For holding registers the write command will be write_single_register. Because the offset for holding registers is given in bytes and the size of a register is 16 bytes the start_address is calculated as start_address + offset/2
|
||||
For holding registers the write command will be write_single_register. Because the offset for holding registers is given in bytes and the size of a register is 16 bytes the start_address is calculated as ``start_address + offset/2``
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
switch:
|
||||
- platform: modbus_controller
|
||||
modbus_controller_id: ventilation_system
|
||||
name: "enable turn off"
|
||||
register_type: holding
|
||||
address: 25
|
||||
bitmask: 1
|
||||
entity_category: config
|
||||
icon: "mdi:toggle-switch"
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -7,8 +7,9 @@ WiFi Component
|
|||
:keywords: WiFi, WLAN, ESP8266, ESP32
|
||||
|
||||
This core ESPHome component sets up WiFi connections to access points
|
||||
for you. It needs to be in your configuration or otherwise ESPHome
|
||||
will fail in the config validation stage.
|
||||
for you. You need to have a network configuration (either Wifi or Ethernet)
|
||||
or ESPHome will fail in the config validation stage. You also can't have both Wifi
|
||||
and Ethernet setup in same time (even if your ESP has both wired).
|
||||
|
||||
It’s recommended to provide a static IP for your node, as it can
|
||||
dramatically improve connection times.
|
||||
|
|
@ -22,8 +23,8 @@ dramatically improve connection times.
|
|||
|
||||
# Optional manual IP
|
||||
manual_ip:
|
||||
static_ip: 10.0.0.42
|
||||
gateway: 10.0.0.1
|
||||
static_ip: 192.168.0.123
|
||||
gateway: 192.168.0.1
|
||||
subnet: 255.255.255.0
|
||||
|
||||
.. code-block:: yaml
|
||||
|
|
|
|||
|
|
@ -527,7 +527,7 @@ tracer-real-time.yaml
|
|||
address: 0x3110
|
||||
unit_of_measurement: °C
|
||||
register_type: read
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
accuracy_decimals: 1
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
|
@ -539,7 +539,7 @@ tracer-real-time.yaml
|
|||
address: 0x3111
|
||||
unit_of_measurement: °C
|
||||
register_type: read
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
accuracy_decimals: 1
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
|
@ -551,7 +551,7 @@ tracer-real-time.yaml
|
|||
address: 0x3112
|
||||
unit_of_measurement: °C
|
||||
register_type: read
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
accuracy_decimals: 1
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
|
@ -573,7 +573,7 @@ tracer-real-time.yaml
|
|||
address: 0x311B
|
||||
unit_of_measurement: °C
|
||||
register_type: read
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
accuracy_decimals: 1
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
|
@ -584,7 +584,7 @@ tracer-real-time.yaml
|
|||
address: 0x311D
|
||||
unit_of_measurement: "°C"
|
||||
register_type: read
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
accuracy_decimals: 1
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
|
@ -983,7 +983,7 @@ tracer-settings.yaml
|
|||
name: "Battery temperature warning upper limit"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
# new range add 'skip_updates' again
|
||||
skip_updates: 50
|
||||
filters:
|
||||
|
|
@ -996,7 +996,7 @@ tracer-settings.yaml
|
|||
name: "Battery temperature warning lower limit"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
||||
|
|
@ -1007,7 +1007,7 @@ tracer-settings.yaml
|
|||
name: "Controller inner temperature upper limit"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
||||
|
|
@ -1018,7 +1018,7 @@ tracer-settings.yaml
|
|||
name: "Controller inner temperature upper limit recover"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
||||
|
|
@ -1029,7 +1029,7 @@ tracer-settings.yaml
|
|||
name: "Power component temperature upper limit"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
||||
|
|
@ -1040,7 +1040,7 @@ tracer-settings.yaml
|
|||
name: "Power component temperature upper limit recover"
|
||||
unit_of_measurement: "°C"
|
||||
register_type: holding
|
||||
value_type: U_WORD
|
||||
value_type: S_WORD
|
||||
filters:
|
||||
- multiply: 0.01
|
||||
|
||||
|
|
|
|||
|
|
@ -270,6 +270,11 @@ global variables can be used to store the state of a garage door.
|
|||
type: int
|
||||
restore_value: no
|
||||
initial_value: '0'
|
||||
# Example for global string variable
|
||||
- id: my_global_string
|
||||
type: std::string
|
||||
restore_value: no # Strings cannot be saved/restored
|
||||
initial_value: '"hello world"'
|
||||
|
||||
# In an automation
|
||||
on_press:
|
||||
|
|
@ -350,6 +355,8 @@ All Actions
|
|||
- :ref:`script.execute <script-execute_action>` / :ref:`script.stop <script-stop_action>` / :ref:`script.wait <script-wait_action>`
|
||||
- :ref:`logger.log <logger-log_action>`
|
||||
- :ref:`homeassistant.service <api-homeassistant_service_action>`
|
||||
- :ref:`homeassistant.event <api-homeassistant_event_action>`
|
||||
- :ref:`homeassistant.tag_scanned <api-homeassistant_tag_scanned_action>`
|
||||
- :ref:`mqtt.publish <mqtt-publish_action>` / :ref:`mqtt.publish_json <mqtt-publish_json_action>`
|
||||
- :ref:`switch.toggle <switch-toggle_action>` / :ref:`switch.turn_off <switch-turn_off_action>` / :ref:`switch.turn_on <switch-turn_on_action>`
|
||||
- :ref:`light.toggle <light-toggle_action>` / :ref:`light.turn_off <light-turn_off_action>` / :ref:`light.turn_on <light-turn_on_action>`
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user