esphome-docs/components/debug.rst
Guillermo Ruffino 896afdcfa1
Fix format next (#1023)
* Missing colon

* update sun

* format fix and adaptation

* fix format

* fix format 2

* fix format 3

* fix format

* fix format

* fix format

* format fix

* revert title as heads

* rename image case-sensitive

* rename again
2021-02-20 18:02:46 -03:00

33 lines
679 B
ReStructuredText

Debug Component
===============
.. seo::
:description: Instructions for setting up the debug component in ESPHome
:image: bug-report.png
The ``debug`` component can be used to debug problems with ESPHome. At startup, it prints
a bunch of useful information like reset reason, free heap size, ESPHome version and so on.
.. figure:: images/debug.png
:align: center
Example debug component output.
.. code-block:: yaml
# Example configuration entry
debug:
# Logger must be at least debug (default)
logger:
level: debug
No configuration variables.
See Also
--------
- :doc:`logger`
- :apiref:`debug/debug_component.h`
- :ghedit:`Edit`