zephyrproject-rtos/zephyr

Bluetooth: Specify unit of RSSI in API

Open

#55,480 建立於 2023年3月6日

在 GitHub 查看
 (10 留言) (1 反應) (1 負責人)C (15,249 star) (9,144 fork)batch import
EnhancementGood first issuearea: APIarea: Bluetooth

描述

Is your enhancement proposal related to a problem? Please describe. In bluetooth.h there are multiple uses of rssi, but the unit is not described.

The unit of struct bt_le_scan_recv_info and bt_le_scan_cb_t is in dBm, but is not specified.

Describe the solution you'd like Specifiy the unit of RSSI in all uses, and if they are not already the same unit, they should be made into the same unit.

Describe alternatives you've considered N/A

Additional context N/A

貢獻者指南

技術棧
c
領域
api
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic C knowledgeunderstanding of Bluetooth RSSI
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Examine `bluetooth.h` for all occurrences of `rssi` in the public API structures and callbacks. Add a comment specifying the unit is dBm for each. Ensure consistency across all uses. No code changes needed.
Bluetooth: Specify unit of RSSI in API · zephyrproject-rtos/zephyr#55480 | Good First Issue