[debug] Update debug component docs (#1879)

This commit is contained in:
mknjc 2022-02-08 00:45:31 +01:00 committed by GitHub
parent 2e9e6be8c5
commit b3bdf475a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,23 +20,30 @@ ESP heap memory (free space, maximum free block size and fragmentation level) an
# Example configuration entry # Example configuration entry
debug: debug:
update_interval: 5s update_interval: 5s
device:
name: Device Info text_sensor:
free: - platform: debug
name: Heap Free device:
fragmentation: name: "Device Info"
name: Heap Fragmentation
block: sensor:
name: Heap Max Block - platform: debug
loop_time: free:
name: Loop Time name: "Heap Free"
fragmentation:
name: "Heap Fragmentation"
block:
name: "Heap Max Block"
loop_time:
name: "Loop Time"
# Logger must be at least debug (default) # Logger must be at least debug (default)
logger: logger:
level: debug level: debug
Text Sensor
------------
Configuration variables: Configuration variables:
------------------------
- **device** (*Optional*): Reports the following device information: - **device** (*Optional*): Reports the following device information:
@ -57,12 +64,16 @@ Configuration variables:
- Flash id - Flash id
- SDK, Core & Boot versions - SDK, Core & Boot versions
- Reset reason & information - Reset reason & information
Accepts these options: Accepts these options:
- **name** (**Required**, string): The name of the sensor. - **name** (**Required**, string): The name of the sensor.
- All other options from :ref:`Text Sensor <config-text_sensor>`. - All other options from :ref:`Text Sensor <config-text_sensor>`.
Sensor
-------
Configuration variables:
- **free** (*Optional*): Reports the free heap size in bytes. - **free** (*Optional*): Reports the free heap size in bytes.
- **name** (**Required**, string): The name of the sensor. - **name** (**Required**, string): The name of the sensor.