1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
//! Bluetooth LE advertising.
use dbus::{
arg::{PropMap, RefArg, Variant},
nonblock::Proxy,
};
use dbus_crossroads::{Crossroads, IfaceBuilder, IfaceToken};
use futures::channel::oneshot;
use std::{
collections::{BTreeMap, BTreeSet, HashMap},
fmt,
sync::Arc,
time::Duration,
};
use strum::{Display, EnumString};
use uuid::Uuid;
use crate::{read_dict, Adapter, Result, SessionInner, SERVICE_NAME, TIMEOUT};
pub(crate) const MANAGER_INTERFACE: &str = "org.bluez.LEAdvertisingManager1";
pub(crate) const ADVERTISEMENT_INTERFACE: &str = "org.bluez.LEAdvertisement1";
pub(crate) const ADVERTISEMENT_PREFIX: &str = publish_path!("advertising/");
/// Determines the type of advertising packet requested.
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Display, EnumString)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Type {
/// Broadcast
#[strum(serialize = "broadcast")]
Broadcast,
/// Peripheral
#[strum(serialize = "peripheral")]
Peripheral,
}
impl Default for Type {
fn default() -> Self {
Self::Peripheral
}
}
/// Secondary channel for advertisement.
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Display, EnumString)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum SecondaryChannel {
/// 1M
#[strum(serialize = "1M")]
OneM,
/// 2M
#[strum(serialize = "2M")]
TwoM,
/// Coded
#[strum(serialize = "Coded")]
Coded,
}
impl Default for SecondaryChannel {
fn default() -> Self {
Self::OneM
}
}
/// Advertisement feature.
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Display, EnumString)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum Feature {
/// TX power.
#[strum(serialize = "tx-power")]
TxPower,
/// Appearance.
#[strum(serialize = "appearance")]
Appearance,
/// Local name.
#[strum(serialize = "local-name")]
LocalName,
}
/// LE advertising platform feature.
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord, Hash, Display, EnumString)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum PlatformFeature {
/// Indicates whether platform can
/// specify TX power on each
/// advertising instance.
#[strum(serialize = "CanSetTxPower")]
CanSetTxPower,
/// Indicates whether multiple
/// advertising will be offloaded
/// to the controller.
#[strum(serialize = "HardwareOffload")]
HardwareOffload,
}
/// Advertising-related controller capabilities.
#[derive(Clone, Debug, Default, Eq, PartialEq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct Capabilities {
/// Maximum advertising data length.
pub max_advertisement_length: u8,
/// Maximum advertising scan response length.
pub max_scan_response_length: u8,
/// Minimum advertising TX power (dBm).
pub min_tx_power: i16,
/// Maximum advertising TX power (dBm).
pub max_tx_power: i16,
}
impl Capabilities {
pub(crate) fn from_dict(dict: &HashMap<String, Variant<Box<dyn RefArg + 'static>>>) -> Result<Self> {
Ok(Self {
max_advertisement_length: *read_dict(dict, "MaxAdvLen")?,
max_scan_response_length: *read_dict(dict, "MaxScnRspLen")?,
min_tx_power: *read_dict(dict, "MinTxPower")?,
max_tx_power: *read_dict(dict, "MaxTxPower")?,
})
}
}
/// Bluetooth LE advertisement data definition.
///
/// Specifies the Advertisement Data to be broadcast and some advertising
/// parameters. Properties which are not present will not be included in the
/// data. Required advertisement data types will always be included.
/// All UUIDs are 128-bit versions in the API, and 16 or 32-bit
/// versions of the same UUID will be used in the advertising data as appropriate.
///
/// Use [Adapter::advertise] to register a new advertisement.
#[derive(Clone, Debug, Default, Eq, PartialEq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Advertisement {
/// Determines the type of advertising packet requested.
pub advertisement_type: Type,
/// List of UUIDs to include in the "Service UUID" field of
/// the Advertising Data.
pub service_uuids: BTreeSet<Uuid>,
/// Manufacturer Data fields to include in
/// the Advertising Data.
///
/// Keys are the Manufacturer ID
/// to associate with the data.
pub manufacturer_data: BTreeMap<u16, Vec<u8>>,
/// Array of UUIDs to include in "Service Solicitation"
/// Advertisement Data.
pub solicit_uuids: BTreeSet<Uuid>,
/// Service Data elements to include.
///
/// The keys are the
/// UUID to associate with the data.
pub service_data: BTreeMap<Uuid, Vec<u8>>,
/// Advertising Type to include in the Advertising
/// Data.
///
/// Key is the advertising type and value is the
/// data as byte array.
///
/// Note: Types already handled by other properties shall
/// not be used.
pub advertising_data: BTreeMap<u8, Vec<u8>>,
/// Advertise as general discoverable.
///
/// When present this
/// will override adapter Discoverable property.
///
/// Note: This property shall not be set when Type is set
/// to broadcast. Additionally, Types that are official
/// Bluetooth assigned numbers cannot be used. So for
/// example the Type value of 0x0a cannot be used because
/// it is assigned as the TX Power Level Type. But,
/// currently the Type 0x0c is unassigned and can be used.
pub discoverable: Option<bool>,
/// The discoverable timeout in seconds.
///
/// A value of zero
/// means that the timeout is disabled and it will stay in
/// discoverable/limited mode forever.
///
/// Note: This property shall not be set when Type is set
/// to broadcast.
pub discoverable_timeout: Option<Duration>,
/// List of system features to be included in the advertising
/// packet.
pub system_includes: BTreeSet<Feature>,
/// Local name to be used in the advertising report.
///
/// If the
/// string is too big to fit into the packet it will be
/// truncated.
pub local_name: Option<String>,
/// Appearance to be used in the advertising report.
pub appearance: Option<u16>,
/// Duration of the advertisement in seconds.
///
/// If there are
/// other applications advertising no duration is set the
/// default is 2 seconds.
pub duration: Option<Duration>,
/// Timeout of the advertisement in seconds.
///
/// This defines
/// the lifetime of the advertisement.
pub timeout: Option<Duration>,
/// Secondary channel to be used.
///
/// Primary channel is
/// always set to "1M" except when "Coded" is set.
pub secondary_channel: Option<SecondaryChannel>,
/// Minimum advertising interval to be used by the
/// advertising set, in milliseconds.
///
/// Acceptable values
/// are in the range [20ms, 10,485s]. If the provided
/// MinInterval is larger than the provided MaxInterval,
/// the registration will return failure.
pub min_interval: Option<Duration>,
/// Maximum advertising interval to be used by the
/// advertising set, in milliseconds.
///
/// Acceptable values
/// are in the range [20ms, 10,485s]. If the provided
/// MinInterval is larger than the provided MaxInterval,
/// the registration will return failure.
pub max_interval: Option<Duration>,
/// Requested transmission power of this advertising set.
///
/// The provided value is used only if the "CanSetTxPower"
/// feature is enabled on the Advertising Manager. The
/// provided value must be in range [-127 to +20], where
/// units are in dBm.
pub tx_power: Option<i16>,
#[doc(hidden)]
pub _non_exhaustive: (),
}
impl Advertisement {
pub(crate) fn register_interface(cr: &mut Crossroads) -> IfaceToken<Self> {
cr.register(ADVERTISEMENT_INTERFACE, |ib: &mut IfaceBuilder<Self>| {
cr_property!(ib, "Type", la => {
Some(la.advertisement_type.to_string())
});
cr_property!(ib, "ServiceUUIDs", la => {
Some(la.service_uuids.iter().map(|uuid| uuid.to_string()).collect::<Vec<_>>())
});
cr_property!(ib, "ManufacturerData", la => {
Some(la.manufacturer_data.clone().into_iter().map(|(k, v)| (k, Variant(v))).collect::<HashMap<_, _>>())
});
cr_property!(ib, "SolicitUUIDs", la => {
Some(la.solicit_uuids.iter().map(|uuid| uuid.to_string()).collect::<Vec<_>>())
});
cr_property!(ib, "ServiceData", la => {
Some(la.service_data.iter().map(|(k, v)| (k.to_string(), Variant(v.clone()))).collect::<HashMap<_, _>>())
});
cr_property!(ib, "Data", la => {
Some(la.advertising_data.iter().map(|(k, v)| (*k, Variant(v.clone()))).collect::<HashMap<_, _>>())
});
cr_property!(ib, "Discoverable", la => {
la.discoverable
});
cr_property!(ib, "DiscoverableTimeout", la => {
la.discoverable_timeout.map(|t| t.as_secs().min(u16::MAX as _) as u16)
});
cr_property!(ib, "Includes", la => {
Some(la.system_includes.iter().map(|v| v.to_string()).collect::<Vec<_>>())
});
cr_property!(ib, "LocalName", la => {
la.local_name.clone()
});
cr_property!(ib, "Appearance", la => {
la.appearance
});
cr_property!(ib, "Duration", la => {
la.duration.map(|t| t.as_secs().min(u16::MAX as _) as u16)
});
cr_property!(ib, "Timeout", la => {
la.timeout.map(|t| t.as_secs().min(u16::MAX as _) as u16)
});
cr_property!(ib, "SecondaryChannel", la => {
la.secondary_channel.map(|v| v.to_string())
});
cr_property!(ib, "MinInterval", la => {
la.min_interval.map(|t| t.as_millis().min(u32::MAX as _) as u32)
});
cr_property!(ib, "MaxInterval", la => {
la.max_interval.map(|t| t.as_millis().min(u32::MAX as _) as u32)
});
cr_property!(ib, "TxPower", la => {
la.tx_power
});
})
}
pub(crate) async fn register(
self, inner: Arc<SessionInner>, adapter_name: Arc<String>,
) -> Result<AdvertisementHandle> {
let name = dbus::Path::new(format!("{}{}", ADVERTISEMENT_PREFIX, Uuid::new_v4().as_simple())).unwrap();
log::trace!("Publishing advertisement at {}", &name);
{
let mut cr = inner.crossroads.lock().await;
cr.insert(name.clone(), &[inner.le_advertisment_token], self);
}
log::trace!("Registering advertisement at {}", &name);
let proxy =
Proxy::new(SERVICE_NAME, Adapter::dbus_path(&adapter_name)?, TIMEOUT, inner.connection.clone());
proxy.method_call(MANAGER_INTERFACE, "RegisterAdvertisement", (name.clone(), PropMap::new())).await?;
let (drop_tx, drop_rx) = oneshot::channel();
let unreg_name = name.clone();
tokio::spawn(async move {
let _ = drop_rx.await;
log::trace!("Unregistering advertisement at {}", &unreg_name);
let _: std::result::Result<(), dbus::Error> =
proxy.method_call(MANAGER_INTERFACE, "UnregisterAdvertisement", (unreg_name.clone(),)).await;
log::trace!("Unpublishing advertisement at {}", &unreg_name);
let mut cr = inner.crossroads.lock().await;
let _: Option<Self> = cr.remove(&unreg_name);
});
Ok(AdvertisementHandle { name, _drop_tx: drop_tx })
}
}
/// Handle to active Bluetooth LE advertisement.
///
/// Drop to unregister advertisement.
pub struct AdvertisementHandle {
name: dbus::Path<'static>,
_drop_tx: oneshot::Sender<()>,
}
impl Drop for AdvertisementHandle {
fn drop(&mut self) {
// required for drop order
}
}
impl fmt::Debug for AdvertisementHandle {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "AdvertisementHandle {{ {} }}", &self.name)
}
}