summaryrefslogtreecommitdiff
path: root/nrf-softdevice/src/ble/peripheral.rs
diff options
context:
space:
mode:
authorDario Nieuwenhuis <dirbaio@dirbaio.net>2020-09-14 03:44:35 +0200
committerDario Nieuwenhuis <dirbaio@dirbaio.net>2020-09-14 03:44:35 +0200
commit042b7b0af0b5aeac058b542eb1f914f7de2fc6e5 (patch)
treea8193d0dbda4be9653374014fb6cf5f75482a8d1 /nrf-softdevice/src/ble/peripheral.rs
parent7567bffb617135a68138762e2a7ca2793a26fe75 (diff)
downloadnrf-softdevice-042b7b0af0b5aeac058b542eb1f914f7de2fc6e5.zip
Add some docs.
Diffstat (limited to 'nrf-softdevice/src/ble/peripheral.rs')
-rw-r--r--nrf-softdevice/src/ble/peripheral.rs8
1 files changed, 7 insertions, 1 deletions
diff --git a/nrf-softdevice/src/ble/peripheral.rs b/nrf-softdevice/src/ble/peripheral.rs
index f7db4c3..307ab3c 100644
--- a/nrf-softdevice/src/ble/peripheral.rs
+++ b/nrf-softdevice/src/ble/peripheral.rs
@@ -1,3 +1,5 @@
+//! Bluetooth Peripheral operations. Peripheral devices emit advertisements, and optionally accept connections from Central devices.
+
use core::mem;
use core::ptr;
@@ -25,6 +27,7 @@ pub(crate) unsafe fn on_sec_info_request(
) {
}
+/// Connectable advertisement types, which can accept connections from interested Central devices.
pub enum ConnectableAdvertisement<'a> {
ScannableUndirected {
adv_data: &'a [u8],
@@ -44,7 +47,9 @@ pub enum ConnectableAdvertisement<'a> {
},
}
-enum NonconnectableAdvertisement {
+/// Non-Connectable advertisement types. They cannot accept connections, they can be
+/// only used to broadcast information in the air.
+pub enum NonconnectableAdvertisement {
ScannableUndirected,
NonscannableUndirected,
ExtendedScannableUndirected,
@@ -53,6 +58,7 @@ enum NonconnectableAdvertisement {
ExtendedNonscannableDirected,
}
+/// Error for [`advertise_start`]
#[derive(defmt::Format)]
pub enum AdvertiseError {
Stopped,