added example of flashing from python code (ESPTOOL-952)

[brentpicasso]

Example app demonstrating how to flash from python code. Follow up from PR #1022

[github-actions]

Warnings

⚠️

Some issues found for the commit messages in this PR: the commit message "added example of flashing from python code": summary looks empty type/action looks empty Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello brentpicasso, we appreciate your contribution to this project!

---

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

---

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 2fbcf3f

[radimkarnis]

Hi @brentpicasso,
thanks for taking the time to follow up and contribute to the documentation!

We will be refactoring esptool to be easily usable as a Python module in the next major release, so this script will most likely stop working quite soon due to changing APIs. On the other hand, starting with the documentation now won't hurt; this contribution seems like a good start.

I have some issues and suggestions before we can move on. Feel free to say you don't have time for this, in that case, I can take over.

[radimkarnis]

1. The commit name, please see the message from our bot above this comment. The commit type is missing. I suggest something like docs(scripting): Add example of usage as a Python module.

[radimkarnis]

2. New docs page. We already have a page explaining some basic scripting here. I would add this as a new section (e.g. Using Esptool as a Python Module).

[radimkarnis]

Left a few suggestions. Let me know if that seems reasonable!

[radimkarnis]

Changing ESP32 to {IDF_TARGET_NAME} will make it dynamically change based on the selected target.

[radimkarnis]

Please keep all the comments formatted uniformly.

[radimkarnis]

This is called FLASH_WRITE_SIZE in esptool and changes depending on if that's the ROM bootloader or the stub.
So in this case block_size = stub.FLASH_WRITE_SIZE seems better.

[radimkarnis]

Suggest renaming to FLASH_ADDRESS or FLASH_OFFSET

[brentpicasso]

Hi, @radimkarnis I ran out of time this week, preparing for some travel. I accept your offer to move it forward! Thank you!