Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-27 22:31:37 +01:00
Code Issues Projects Releases Wiki Activity

Clarify that includes option does not only accept headers (#1188)

Browse Source
This commit is contained in:
Oxan van Leeuwen 2021-09-13 22:15:14 +02:00 committed by GitHub
parent b02a19d40d
commit d8fd0ac7fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
components/esphome.rst
View File

@ -45,9 +45,9 @@ Advanced options:
but you can customize this behavior using this option. but you can customize this behavior using this option.
- **platformio_options** (*Optional*, mapping): Additional options to pass over to PlatformIO in the - **platformio_options** (*Optional*, mapping): Additional options to pass over to PlatformIO in the
platformio.ini file. See :ref:`esphome-platformio_options`. platformio.ini file. See :ref:`esphome-platformio_options`.
- **includes** (*Optional*, list of files): A list of C[++] files to include in the main (auto-generated) sketch file - **includes** (*Optional*, list of files): A list of C/C++ files to include in the main (auto-generated) sketch file
for custom components. The paths in this list are relative to the directory where the YAML configuration file for custom components. The paths in this list are relative to the directory where the YAML configuration file
is in. Should have file extension ``.h`` - See :ref:`esphome-includes` for more info. is in. See :ref:`esphome-includes` for more info.
- **libraries** (*Optional*, list of libraries): A list of `platformio libraries <https://platformio.org/lib>`__ - **libraries** (*Optional*, list of libraries): A list of `platformio libraries <https://platformio.org/lib>`__
to include in the project. See `platformio lib install <https://docs.platformio.org/en/latest/userguide/lib/cmd_install.html>`__. to include in the project. See `platformio lib install <https://docs.platformio.org/en/latest/userguide/lib/cmd_install.html>`__.
- **comment** (*Optional*, string): Additional text information about this node. Only for display in UI. - **comment** (*Optional*, string): Additional text information about this node. Only for display in UI.
@ -267,10 +267,13 @@ The ``includes`` option is only a helper option that does that for you.
This option behaves differently depending on what the included file is pointing at: This option behaves differently depending on what the included file is pointing at:
- If the include string is pointing at a directory, the entire directory tree is copied over - If the include string is pointing at a directory, the entire directory tree is copied into the
to the src/ folder. src/ folder.
- If the include string is point at a header file (.h, .hpp, .tcc) - it is copied in the src/ folder - If the include string points to a header file (.h, .hpp, .tcc), it is copied in the src/ folder
AND included in the main.cpp. This way the lambda code can access it. AND included in the ``main.cpp`` file. This way the lambda code can access it.
- If the include string points to a regular source file (.c, .cpp), it is copied in the src/ folder
AND compiled into the binary. This way implementation of classes and functions in header files can
be provided.
.. _esphome-changing_node_name: .. _esphome-changing_node_name: