board generator documentation #4989
Conversation
doc/faq/a02-my-esp-crashes.rst
Outdated
| @@ -286,6 +286,9 @@ Memory, memory, memory | |||
| modification. For example, std::vector is available for use. The standard implementations | |||
| rely on exceptions for error handling, which is not available for the ESP, and in any | |||
| case there is no access to the underlying code. | |||
|
|
|||
| Instrumenting the code with the OOM debug option and calls to ``ESP.getFreeHeap()`` will | |||
There was a problem hiding this comment.
Should we add a line about the last memory allocation failure report in the panic that was added a while back?
doc/faq/a05-board-generator.rst
Outdated
|
|
||
| The board generator is a python script originally intended to ease the | ||
| Arduino IDE's `boards.txt` configuration file about the multitude of | ||
| available board, especially when common data have to be updated for all of |
There was a problem hiding this comment.
common data -> common parameters
| How can I run the script ? | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Python 2 needs to be installed on your system. |
There was a problem hiding this comment.
Does it work with Python 3?
There was a problem hiding this comment.
Does it work with Python 3?
No. At least all prints must be updated.
edit: that could be an issue for 2.5.0: all python scripts must be py2/3 agnostic.
|
|
||
| * increase available flash space by disabling floats in ``*printf`` functions | ||
|
|
||
| * enable WPS which is now disabled by default (at the cost of a smaller heap by ~4KB) |
There was a problem hiding this comment.
all of these are in the IDE, right?
There was a problem hiding this comment.
float/printf and WPS are not in IDE. The board generator script is currently the only way to change these.
edit: I may have misunderstood. The generator does make changes for usability within the IDE. Some of the changes are not doable from inside the IDE. The generator does them. Then the IDE must be restarted to take effect.
The IDE could do them, but we don't want to flood all users, especially beginners, with thousands of options (arduino, KISS). We already have lots of them. Eclipsification of esp8266/Arduino's IDE shall not happen.
doc/faq/a05-board-generator.rst
Outdated
| When do I need to mess with it ? | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The board generator is used to automate configuration files generation when it is |
There was a problem hiding this comment.
automate generation of configuration files
doc/faq/a05-board-generator.rst
Outdated
| The board generator is used to automate configuration files generation when it is | ||
| possible to. It needs to be edited for: | ||
|
|
||
| * All the specific board informations. This is the only place where a new |
There was a problem hiding this comment.
All information for specific boards
doc/faq/readme.rst
Outdated
|
|
||
| The board generator is a python script originally intended to ease the | ||
| Arduino IDE's `boards.txt` configuration file about the multitude of | ||
| available board, especially when common data have to be updated for all of |
There was a problem hiding this comment.
common data -> common parameters
doc/faq/readme.rst
Outdated
| available board, especially when common data have to be updated for all of | ||
| them. | ||
|
|
||
| This script is also used to manage uncommon options that will not find their |
There was a problem hiding this comment.
that are currently not available in the IDE menu (we can't say for sure that they will never ever be in the IDE :p)
Changes can be seen there.