GetVoltage() unconditionally leaves I2C bus in EXTERNAL state — latent hazard
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 56/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- arduino, cpp
- 领域
- embedded-iot
调研方向
Start at the GetVoltage() entry point and trace I2CState(INTERNAL) / I2CState(EXTERNAL), then inspect its AddDataPoint() call sites and the possible GetOnBoardVals() context. Done means GetVoltage() no longer changes the caller's I2C bus state when invoked from an INTERNAL context, while current EXTERNAL usage remains safe.
由索引模型根据 Issue 内容生成。
描述
Issue
GetVoltage() now wraps the ADC read with I2CState(INTERNAL) / I2CState(EXTERNAL) (added in 7c04bf1) without saving or restoring the caller's I2C bus state. The EXTERNAL restore at the end is unconditional.
float Okapi::GetVoltage(uint8_t Pin) {
I2CState(INTERNAL);
float Val = ADC_Ext.readADC_SingleEnded(Pin) * 0.1875;
I2CState(EXTERNAL); // always left on EXTERNAL, regardless of caller state
return Val;
}
Current status
All current call sites for GetVoltage() are in user Update() callbacks, which AddDataPoint() always invokes during the EXTERNAL phase — so the unconditional restore is safe for present usage.
Latent hazard
If GetVoltage() is ever called from setup() or any INTERNAL context (e.g., added to GetOnBoardVals() in the future), the bus will be left on EXTERNAL, corrupting subsequent BME280/RTC reads. There is nothing in the function signature or documentation to warn callers of this constraint.
Fix
Save and restore the caller's I2C state, or document the EXTERNAL-context-only precondition prominently.
Severity
Low (latent) — not triggered by current library code; risk increases as the API evolves.
🤖 Generated with Claude Code
- 主要语言
- C++
- 星标
- 1
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
NorthernWidget/Okapi_Library 的其他 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 76/100
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 1/5 1 小时以内 新手友好度 88/100
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
NorthernWidget/Okapi_Library#10 · 1 条评论 ·
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
NorthernWidget/Okapi_Library#9 · 1 条评论 ·
查看 NorthernWidget/Okapi_Library 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 69/100
notepad-plus-plus/notepad-plus-plus#18553 ·
维护者通常 1 天内回复
-
bug docs performance
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 3 天内回复
-
good first issue help wanted
难度 2/5 1-3 小时 新手友好度 85/100
-
good first issue neural P2
难度 2/5 1-3 小时 新手友好度 65/100