serial: Add UART over Bluetooth LE #69881
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ubieda
force-pushed
the
feature/serial/bt-nus
branch
7 times, most recently
from
d989517 to
a35fe05
Compare
zephyrbot
requested review from
alwa-nordic,
asbjornsabo,
dcpleung,
hermabe,
jeremybettis,
jhedberg,
jori-nordic,
kartben,
nashif,
nordic-krch,
sjanc,
tejlmand,
Thalley,
theob-pro and
Vudentz
bjarki-andreasen
previously requested changes
Mar 7, 2024
nordicjm
previously requested changes
Mar 7, 2024
carlescufi
reviewed
Mar 7, 2024
carlescufi
reviewed
Mar 7, 2024
ubieda
force-pushed
the
feature/serial/bt-nus
branch
2 times, most recently
from
b57238c to
cc96618
Compare
ubieda
force-pushed
the
feature/serial/bt-nus
branch
from
933b80c to
3d01c60
Compare
ubieda
force-pushed
the
feature/serial/bt-nus
branch
from
3d01c60 to
ddb147d
Compare
NUS is implemented as a Bluetooth LE service, exchanging data treating the NUS characteristics as Serial endpoints: RX characteristic to receive, TX characteristic to send binary packets. This implementation also enables the ability to define multiple instances of the NUS Service, analogous to mutliple serial endpoints, to use each one for different purposes. Unless disabled through Kconfig, NUS instantiates a default instance, similar to what other services do, which allows users not interested in using multiple instances, to not worry about the inherent complexities. Signed-off-by: Luis Ubieda <[email protected]>
Demonstrating basic usage of NUS to exchange data. Signed-off-by: Luis Ubieda <[email protected]>
Enables usage Bluetooth LE GATT as a serial endpoint to exchange data using UART APIs. This implementation is compatible with UART Interrupt Driven APIs and uses the nus-uart device-tree node properties to configure FIFO buffers for transmitting and receiving. Defining multiple instances of the driver is possible and it allows implementing multiple GATT NUS service instances to exchange data as separate serial endpoints. Signed-off-by: Luis Ubieda <[email protected]>
Enables compatibility of NUS for codebases that are not Bluetooth-centric (e.g: Non-bluetooth samples that use UART over Bluetooth LE for Console, Logging, Shell, others). Signed-off-by: Luis Ubieda <[email protected]>
Allowing to be applied on various samples to enable UART over Bluetooth LE NUS without added complexity. Tested with nrf52840dk/nrf52840 on the following samples: - samples/subsys/console/echo. - samples/subsys/console/getchar. - samples/subsys/console/getline. - samples/subsys/logging/logger. Signed-off-by: Luis Ubieda <[email protected]>
Tested and working with nrf52840dk/nrf52840. Signed-off-by: Luis Ubieda <[email protected]>
Tested and working with nrf52840dk/nrf52840. Signed-off-by: Luis Ubieda <[email protected]>
Add documentation on relevant sections to list addition of Bluetooth LE service NUS (Nordic UART Service), as well as the UART driver for UART over Bluetooth LE and snippets to easily enable it. Signed-off-by: Luis Ubieda <[email protected]>
|
I've made the following changes:
|
|
Logging + the echo (ie console) works w/ your script and the nrf connect apps. # using the snippet
west build -b nrf52840dk/nrf52840 -S nus-console
# using the overlays
west build -b nrf52840dk/nrf52840 -- -DDTC_OVERLAY_FILE=bt.overlay -DOVERLAY_CONFIG=overlay-bt.confedit: well, now the shell works when using the python script. Wonder what I did wrong on first try. |
jori-nordic
approved these changes
Mar 20, 2024
alwa-nordic
approved these changes
Mar 20, 2024
alwa-nordic
reviewed
Mar 20, 2024
alwa-nordic
reviewed
Mar 20, 2024
| LOG_ERR("RX Ring buffer full. received: %d, added to queue: %d", len, put_len); | ||
| } | ||
|
|
||
| k_work_submit(&dev_data->uart.cb_work); |
There was a problem hiding this comment.
Should this be guarded by if (dev_data->uart.rx_irq_ena)?
There was a problem hiding this comment.
This can also optionally be followed up in a separate PR. It is unclear if spurious interrupts are allowed in the UART IRQ API. If you do take a look, you may also want to guard against TX interrupts from uart_bt_irq_tx_enable when the buffer is full. Maybe it's over-engineering.. but correctness! :)
There was a problem hiding this comment.
I'll take a closer look at this when following up on suggested improvements (separate PR). This is good feedback. Thanks!
|
Just wanted to say I think this high quality code. 👍 The code comments are on point - it makes it easy to read. And the documentation is good as well. |
jhedberg
approved these changes
Mar 21, 2024
This was referenced Mar 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a UART-compatible implementation of Bluetooth LE GATT, using NUS (Nordic UART Service), which allows users to utilize Bluetooth LE as serial endpoints with UART APIs and take advantage of existing support of subsystems that already support UART.
Background
This PR fixes #12714. Also, this PR is a follow-up of #68076, with the agreed changes captured on the Bluetooth WG.
Changes
samples/subsys/logging/loggerandsamples/subsys/shell/shell_module.Testing
UART over Bluetooth LE has been tested using this python-app on the PC-side, and the MCU-side running each of the following samples:
Note
The feature is marked as experimental as the surface area of what uses UART goes beyond the aforementioned samples, and it would be beneficial to further test it before removing it.