OpenDevicePartnership / OpenDevicePartnership/ec-slimloader
Clarify Boot Image Version usage and example
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3
- Forks
- 14
- Avg merge
- 7d 11h
- Merged PRs (30d)
- 1
Description
I can submit a PR for this, but in the rt685s example, it uses the crate version as the Boot Image Version. Based on my understanding, this needs to be well-formed according to the reference manual (something about two bytes for the version, the other two bytes is the complement of the version)
I found this out the hard way when I changed the version in my project.
I can update the example, but I can't test it. But the short answer I think is "unless you know what you're doing, don't touch this."
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the rt685s example and compare its Boot Image Version value with the reference manual's version and complement-byte requirements. Update the example and its explanation so the expected format and the warning about changing it are clear; confirm the documented value matches the manual, noting that the reporter could not test it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100