esphome-docs/components/debug.rst

33 lines
702 B
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Debug Component
===============
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up the debug component in ESPHome
:image: bug-report.png
2018-11-14 22:12:27 +01:00
2019-02-16 23:25:23 +01:00
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.
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
.. figure:: images/debug.png
2018-05-13 11:37:02 +02:00
:align: center
Example debug component output.
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
debug:
# Logger must be at least debug (default)
logger:
level: debug
There are no configuration variables for this component.
2018-06-01 18:10:00 +02:00
See Also
2018-08-24 22:44:01 +02:00
--------
2018-06-01 18:10:00 +02:00
- :doc:`logger`
- :apiref:`debug_component.h`
- :ghedit:`Edit`