Skip to content

Latest commit

 

History

History
101 lines (61 loc) · 4.36 KB

README.md

File metadata and controls

101 lines (61 loc) · 4.36 KB
Raw

🌶️ to 🌶️🌶️🌶️ - Bluetooth sample pack

These samples are using nanoFramework.Device.Bluetooth to work with the nimble BLE implementation on the ESP32 device. For more information about the library you can check nanoFrameworkDevice.Bluetooth Library repository and the API documentation.

Hardware requirements

Bluetooth is currently only supported on ESP32 devices with following firmware.

  • ESP32_BLE_REV0
  • ESP32_BLE_REV3
  • ESP32_PSRAM_BLE_GenericGraphic_REV3
  • ESP32_S3_BLE
  • M5Core2
  • LilygoTWatch2021
  • ESP32_ETHERNET_KIT_1.2

On other firmware versions a not supported exception will be returned.

Server Samples

These are samples which advertise service(s) and allow central devices to connect to them so that characteristics values can be read or written.

This shows how to create a simple bare bones custom service.

This sample adds security to the Characteristic access. This will force the Server/Client to pair which is used to generate key pairs for communications. See sample for details.

This showcases the use of adding extra services or replacing an existing service like the default "Device Information Service".

Provision device directly from a web page using Improv standard. See sample readme for more information.

Shows how to use the built-in SSP(Serial Service Profile) which simulates a serial link over Bluetooth. Use a phone application such as "Serial Bluetooth Terminal" to connect to device and send and receive messages.

Central/Client samples

This a simple sample showing how to scan for Bluetooth LE devices.

This Sample will scan for devices with the service UUID used in the BluetoothLESample3 sample and connect to all found devices. It will then read and set-up notifications for changes in Environmental Service temperatures. The 🌶️ - Bluetooth Low energy sample 3 was changed to provide notifications of temperature changes.

Central/Client sample to show how to watch for advertisements and connect to a device which requires encryption and authentication to access the Characteristics values.

By using filter classes on the Watcher you can filter out all advertisements events except the ones from your devices.

Advertising samples

Uses the BluetoothLEAdvertisementPublisher class to create an iBeacon. Contains a utility class "Beacon" which can easily be used in other applications.

Uses the BluetoothLEAdvertisementPublisher to create an advertisement with Manufacturer data containing the current value of a dummy device which is updated every 1 second.

Building the samples

  1. Start Microsoft Visual Studio 2019 (VS 2017 or VS 2022 should be OK too) and select File > Open > Project/Solution.
  2. Starting in the folder where you unzipped the samples/cloned the repository, go to the subfolder for this specific sample. Double-click the Visual Studio Solution (.sln) file.
  3. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

  • Select Build > Deploy Solution.

Deploying and running the sample

  • To debug the sample and then run it, press F5 or select Debug > Start Debugging.

Note

Important: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.

Tip: To display the Device Explorer, go to Visual Studio menus: View > Other Windows > Device Explorer.