zephyrproject-rtos/zephyr

Bluetooth: Specify unit of RSSI in API

Open

#55,480 opened on Mar 6, 2023

View on GitHub
 (10 comments) (1 reaction) (1 assignee)C (15,249 stars) (9,144 forks)batch import
EnhancementGood first issuearea: APIarea: Bluetooth

Description

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

Contributor guide

Tech stack
c
Domain
api
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic C knowledgeunderstanding of Bluetooth RSSI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.