Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Investigate espflash library usage #794

Open
MabezDev opened this issue Feb 27, 2025 · 2 comments
Open

Investigate espflash library usage #794

MabezDev opened this issue Feb 27, 2025 · 2 comments
Labels
status:needs-investigation Issue requires further investigation
Milestone

Comments

@MabezDev
Copy link
Member

We don't have much from crates.io rev deps, but what we can, and should do is do a code search on Github/Gitlab to find library usage. From here, we can find what needs to be exposed in the library and what doesn't. It's also not that black and white, a module may be used because our other APIs are insufficient, or are tangled together forcing users to use both modules so keep that in mind.

@MabezDev MabezDev added the status:needs-investigation Issue requires further investigation label Feb 27, 2025
@MabezDev MabezDev added this to the v4 milestone Feb 27, 2025
@jessebraham
Copy link
Member

A few projects which appears to be using espflash directly as a library:

This is not comprehensive, but investigating how these projects are using the library should at least give us a reasonable idea of how people are currently using espflash.

@nullstalgia
Copy link

I'm currently working on a binary crate (serial-terminal adjacent, still an early WIP) that intends to use espflash as a library! (I had just started to sniff through issues here to get a clearer picture on what I might need to look out for, and ran into this issue near the top. 😄)

But so far, something I've really appreciated is the ability to create helpers like Connections and Flashers, and then be able to consume them and get back the Port object for my terminal to use again without reconnecting! The ResetStrategy's request for a &mut Port also makes this easy, and is also appreciated.

If you have more questions about how I intend to use it as a library, or would like feedback as I get deeper into the project, I'd be happy to oblige!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:needs-investigation Issue requires further investigation
Projects
Status: Todo
Development

No branches or pull requests

3 participants