Improve the ESPFLASH section
bbulkow opened this issue · 2 comments
Key need: specify port. In most cases, one needs to specify the port, and neither this document nor the espflash documentation is clear on how to do so. It appears the first argument is the name of the port, but not clear.
The espflash documentation states there is a configuration file on windows which is not true. ChatGPT thinks there is an environment variable which is used, also doesn't seem true.
There are also three esptools (or two, one with two invokation mechanism?): the one you may have from doing development with esp-idf, the one you get with a standard cargo and is global, and the per-project espflash. Instructions you find about these three are confusing because some take port as an option (--port) and some have it as a positional option. When I read different documents its very confusing because of the three tools. Documentation on one doesn't work for the others.
It seems most people get something working then just use it. in my C++ based env I just use idf.py so I've never had to understand espflash
I would suggest: bring up the different tools, explain which ones document what.
Then, suggest the per-project one as per the current document, but show how to override the port, and/or set a port in the config file.
Thanks! When I learn the answer, can I put in a PR? Right now I don't know the answer, can't flash yet.
Hi! The espflash section was just updated after merging: #94. Which version of espflash are you using?
Key need: specify port. In most cases, one needs to specify the port, and neither this document nor the espflash documentation is clear on how to do so. It appears the first argument is the name of the port, but not clear.
If you run the command without specifying a port, a list with the available ports will be printed, and you can select it from there.
The espflash documentation states there is a configuration file on windows which is not true. ChatGPT thinks there is an environment variable which is used, also doesn't seem true.
See the documentation in the readme: https://github.com/esp-rs/espflash/tree/main/espflash#configuration
There are also three esptools (or two, one with two invokation mechanism?): the one you may have from doing development with esp-idf, the one you get with a standard cargo and is global, and the per-project espflash. Instructions you find about these three are confusing because some take port as an option (--port) and some have it as a positional option. When I read different documents its very confusing because of the three tools. Documentation on one doesn't work for the others.
The difference between espflash and cargo-espflash can be found in the espflash chapter of the book and in the repository readme.
Thanks! When I learn the answer, can I put in a PR? Right now I don't know the answer, can't flash yet.
Yes, feel free to open a PR with what you think should be included, but we would like to avoid duplicating information between the remade of the repo and the book, that's why we point to the readme and keep the information short in the book.
I will be closing this issue for inactivity and I think it's already properly documented, feel free to reopen it if you have any suggestion/issue.