oxidecomputer / oxidecomputer/hubris
`build-i2c` should probably not permit multiple sensors of the same type to have the same name
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.6k
- Forks
- 239
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 23
Description
As seen in #2634, it is currently very easy to accidentally emit multiple sensors of the same type on a device and have them all end up with the same name, which is confusing for both upstack software and users. We should change the build system to check for this.
Before implementing such a check we should probably make it easier to fix such situations, though. The UX for renaming sensors is currently quite bad, as I described in https://github.com/oxidecomputer/hubris/issues/2634#issuecomment-5271249541.
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 build-i2c build system and the UX discussion in issue #2634, especially the linked comment about renaming sensors. Clarify how sensor names should be changed, then define the duplicate-name validation and its expected behavior before implementing either part.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, embedded-iot
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100