| page_type | languages | products | urlFragment | extendedZipContent | description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
|
|
BluetoothAdvertisement |
|
Shows how to use the Bluetooth Advertisement API to send and receive Bluetooth Low Energy advertisements. |
Shows how to use the Bluetooth Advertisement API to send and receive Bluetooth Low Energy advertisements.
Note: This sample is part of a large collection of UWP feature samples. You can download this sample as a standalone ZIP file from docs.microsoft.com, or you can download the entire collection as a single ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.
This sample allows the user to publish and watch for Bluetooth Low Energy advertisements. You can choose one of four scenarios and you will likely need two Windows devices to see :
- Foreground watcher: Scanning for a particular LE advertisement containing a matching manufacturer data section and above a certain RSSI threshold.
- Foreground publisher: Publishing a LE advertisement. The advertisement generated by this scenario can be received by running Scenario 1 or 3 on another Windows platform in close proximity with this one.
- Background watcher: Scanning for a particular LE advertisement containing a matching manufacturer data section and above a certain RSSI threshold using a background trigger and task.
- Background publisher: Publishing a LE advertisement in the background. The advertisement generated by this scenario can be received by running Scenario 1 or 3 on another Windows platform in close proximity with this one.
This sample also detects and offers to take advantage of the ability to advertise Bluetooth LE advertisements and scan for Bluetooth LE advertisements using both the 1M, 2M, and Coded PHYs, use coexistence-optimized Bluetooth LE advertisement scanning, and offload Bluetooth LE advertisement filtering to hardware.
Note: A working Bluetooth dongle/radio is needed in order to test this sample's functionality. The VS Emulator is a valid target, but since there's technically no valid Bluetooth, the app will treat it as if there's no Bluetooth radio and beacon functionality cannot be used.
- BluetoothAdvertisement sample for JavaScript and Visual Basic (archived)
Windows 10 Version 1703 (build 15063) for basic functionality.
Windows 11 build 26100 for 1M and 2M PHY functionality.
Note: This sample requires Windows SDK version 10.0.26100.3916 or higher.
Unfortunately, there is no way to detect the 3916 revision at build time.
If you get errors about undefined members like IsLowEnergyUncoded2MPhySupported,
make sure you have installed a high enough version of the Windows SDK.
- If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
- Start Microsoft Visual Studio and select File > Open > Project/Solution.
- Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
- Press Ctrl+Shift+B, or select Build > Build Solution.
The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.
- Select Build > Deploy Solution.
- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.