arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-27 18:02:17 +03:00
Code Activity

Add board filter support ... (#6643)

Browse Source 
* Add boards filter support - allows for the creation of an abridged boards.txt.
Add some of the ITEAD Sonoff boards to boards.txt.py.
Minor reorder of presentation of board menu items, mainly grouped
board Model and module selection to the top.

* Corrected, I think, LED_BUILTIN vs BUILTIN_LED??

* Updated boards.txt

* Added support for DOIT ESP-Mx DevKit (ESP8285) board.
Adjusted wording and fixed side bar formating issue on the
Sonoff description. Also, removed resetmethod menu
and assigned resetmethod of none.
This commit is contained in:
M Hightower
2019-11-08 09:49:29 -08:00
committed by Develo
parent 5260b30730
commit 9f6d3c7c3e
5 changed files with 833 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
doc/faq/a05-board-generator.rst
View File

@ -54,6 +54,8 @@ As of today you can:
* change the default lwIP version (1.4 or 2)
* create an abridged boards.txt file
When do I need to mess with it ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -78,4 +80,61 @@ After a modification in the generator, it is **mandatory** to regenerate all
files (option ``--allgen``) and add them in the pull-request.
How to create an abridged boards.txt file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The list of boards presented by the IDE has gotten quite long. You can reduce
the ESP8266 boards shown by the IDE to a favorites list. This can
be done by generating a new boards.txt file using the ``--filter <file>``
option.
Start by getting a current list of boards supported by boards.txt.py.
This command will write a list of supported board names to favorites.txt.
::
./tools/boards.txt.py --boardnames >favorites.txt
Edit favorites.txt, keeping the name of the boards you want generated in
boards.txt.
to generate a new abridged boards.txt run:
::
./tools/boards.txt.py --boardsgen --filter favorites.txt
You can turn the process around by creating a list of boards, you do not want
to be generated. To do this we use the ``--xfilter <file>`` option.
to generate this abridged boards.txt run:
::
./tools/boards.txt.py --boardsgen --xfilter favorites.txt
Yet another option, you can split the boards between boards.txt and
boards.local.txt.
The commands below will generate a boards.txt file that omits the boards named
in favorites.txt, and generates a boards.local.txt ( via option ``--boardslocalgen`` ) that only contains boards
named in favorites.txt.
::
./tools/boards.txt.py --boardsgen --xfilter favorites.txt
./tools/boards.txt.py --boardslocalgen --filter favorites.txt
Additional Notes:
1. The boards.txt file will always contain the generic and esp8285 boards.
2. If boards.txt file exist and no backup copy named boards.txt.orig exist, the current boards.txt will be renamed to boards.txt.orig. Otherwise, the existing boards.txt is over-writen when you generate a new boards.txt file. Similar behavior for when generating a new boards.local.txt.
3. The boards in the boards.txt file will be in the order they were listed in your favorites file, specified by option ``--filter <file>``.
4. It is outside the scope of this document, but you could manually edit any boards.txt file to have fewer boards. One last observation, the Arduino IDE appears to need at least one board in a board.txt file.
`FAQ list :back: <readme.rst>`__