https://github.com/nexussays/ble.net
Cross-platform Bluetooth Low Energy (BLE) library for Android, iOS, and UWP
https://github.com/nexussays/ble.net
android ble bluetooth bluetooth-le bluetooth-low-energy csharp dotnet dotnet-standard ios uwp xamarin
Last synced: 5 months ago
JSON representation
Cross-platform Bluetooth Low Energy (BLE) library for Android, iOS, and UWP
- Host: GitHub
- URL: https://github.com/nexussays/ble.net
- Owner: nexussays
- License: mpl-2.0
- Created: 2015-11-18T03:57:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-08-07T02:24:49.000Z (almost 7 years ago)
- Last Synced: 2025-10-06T03:43:30.572Z (9 months ago)
- Topics: android, ble, bluetooth, bluetooth-le, bluetooth-low-energy, csharp, dotnet, dotnet-standard, ios, uwp, xamarin
- Language: C#
- Homepage:
- Size: 403 KB
- Stars: 196
- Watchers: 13
- Forks: 51
- Open Issues: 35
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# [ble.net](https://www.fuget.org/packages/ble.net)  [](https://www.nuget.org/packages/ble.net) [](https://www.mozilla.org/MPL/2.0/)
`ble.net` is a cross-platform Bluetooth Low Energy (aka BLE, aka Bluetooth LE, aka Bluetooth Smart) library to enable simple development of BLE clients on Android, iOS, and UWP/Windows.
It provides a consistent API across all supported platforms and hides most of the problems and poor API decisions of the native BLE APIs.
## Platform Support
| Platform | Version |
| ---------------- | :-------: |
| Xamarin.iOS | iOS 8.3+ |
| Xamarin.Android | API 18+ |
| Windows 10 (UWP) | 1709+ |
> Note: Currently UWP only supports listening for broadcasts/advertisements, not connecting to devices.
## Quick example
This is a quick overview of the API and usage; continue reading below for setup instructions and more comprehensive examples.
```csharp
var connection = await ble.FindAndConnectToDevice(
new ScanFilter().AddAdvertisedService( service ),
TimeSpan.FromSeconds( 30 )
);
if(connection.IsSuccessful())
{
try
{
var gattServer = connection.GattServer;
var read = gattServer.ReadCharacteristicValue( service, char1 );
await Task.WhenAll( new Task[]
{
gattServer.WriteCharacteristicValue(
service, char1, new Byte[]{/* bytes */}
),
gattServer.WriteCharacteristicValue(
service, char2, new Byte[]{/* bytes */}
),
gattServer.WriteCharacteristicValue(
service2, char3, new Byte[]{/* bytes */}
)
} );
// Even though we await "read" after awaiting the write calls, the read was
// dispatched first and so will have executed prior to the write calls
originalValue = await read;
}
catch(GattException ex)
{
Debug.WriteLine( ex.ToString() );
}
finally
{
// The device will stay connected until you call Disconnect or the connection is lost through some external means.
await connection.GattServer.Disconnect();
}
}
```
## Getting Started
### 1. Install NuGet packages
#### In your shared library project
Install the `ble.net (API)` package.
```shell
dotnet add package ble.net
```
> NOTE: BLE.net switched from targetting `portable-net45+win8` in version `1.1.1`, to `.netstandard1.4` in version `1.2.0`, to `.netstandard2.0` in `1.2.1` (where it will remain for the forseeable future). If you are having problems please [file an issue](https://github.com/nexussays/ble.net/issues/new)
#### In your platform project(s)
Install the relevant platform package. (See table at the top of the readme for supported versions.)
```shell
dotnet add package ble.net-android
```
```shell
dotnet add package ble.net-ios
```
```shell
dotnet add package ble.net-uwp
```
### 2. Add relevant app permissions
#### Android
```csharp
[assembly: UsesPermission( Manifest.Permission.Bluetooth )]
[assembly: UsesPermission( Manifest.Permission.BluetoothAdmin )]
```
> If you are having issues discovering devices when scanning, try adding coarse location permissions. Android has inconsistent behavior across devices and adding this permission sometimes helps.
> ```csharp
> [assembly: UsesPermission( Manifest.Permission.AccessCoarseLocation )]
> ```
> Note also that this is a ["dangerous" permission](https://developer.android.com/guide/topics/permissions/requesting.html#normal-dangerous) in API 23+, so if you are targeting Android 6.0 or higher you will need to request this permission from the user at runtime.
#### iOS
If you are only using BLE in the foreground, when your app is active, you don't need to do any further setup for iOS.
If you need to use BLE in the background:
1. Add [bluetooth-central](https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/CoreBluetooth_concepts/CoreBluetoothBackgroundProcessingForIOSApps/PerformingTasksWhileYourAppIsInTheBackground.html#//apple_ref/doc/uid/TP40013257-CH7-SW6) to background modes
2. Add a string value for key [NSBluetoothPeripheralUsageDescription](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW20). iOS will display this value in a permission dialog box that the user must approve.
```xml
UIBackgroundModes
bluetooth-central
NSBluetoothPeripheralUsageDescription
[MyAppNameHere] would like to use bluetooth.
```
#### UWP
```xml
```
### 3. Initialize `BluetoothLowEnergyAdapter` (Android-only)
> There is no initialization needed for iOS or UWP.
If you want `IBluetoothLowEnergyAdapter.DisableAdapter()` and `IBluetoothLowEnergyAdapter.EnableAdapter()` to work, then in your main `Activity` add:
```csharp
protected override void OnCreate( Bundle bundle )
{
// ...
BluetoothLowEnergyAdapter.Init( this );
// ...
}
```
If you want `IBluetoothLowEnergyAdapter.CurrentState.Subscribe()` to work, then in your calling `Activity` add:
```csharp
protected sealed override void OnActivityResult( Int32 requestCode, Result resultCode, Intent data )
{
BluetoothLowEnergyAdapter.OnActivityResult( requestCode, resultCode, data );
}
```
### 4. Obtain a reference to `BluetoothLowEnergyAdapter`
Each platform project has a static method `BluetoothLowEnergyAdapter.ObtainDefaultAdapter()` which you call from your platform project and provide to your application code using whatever strategy you prefer (dependency injection, manual reference passing, a singleton or service locator, etc).
See the sample Xamarin Forms app for real-life examples:
* [Android Xamarin.Forms](src/ble.net.sampleapp-android/MyApplication.cs#L108) example
* [iOS Xamarin.Forms](src/ble.net.sampleapp-ios/MyApplication.cs#L59) example
* [UWP Xamarin.Forms](src/ble.net.sampleapp-uwp/MainPage.xaml.cs#L12) example
## API
> See [sample Xamarin Forms app](/src/ble.net.sampleapp/) included in the repo for further examples of how to integrate BLE.net into an app.
All the examples presume you have obtained the `IBluetoothLowEnergyAdapter` as per the setup notes above, e.g.:
```csharp
IBluetoothLowEnergyAdapter ble = /* platform-provided adapter from BluetoothLowEnergyAdapter.ObtainDefaultAdapter()*/;
```
### Control the Bluetooth Adapter on the device
#### Enable Bluetooth
> There are corresponding methods to disable the adapter.
```csharp
if(ble.AdapterCanBeEnabled && ble.CurrentState.IsDisabledOrDisabling()) {
await ble.EnableAdapter();
}
```
#### See & Observe Adapter Status
```csharp
ble.CurrentState.Value; // e.g.: EnabledDisabledState.Enabled
// The adapter implements IObservable so you can subscribe to its state
ble.CurrentState.Subscribe( state => Debug.WriteLine("New State: {0}", state) );
```
### Scan for advertisements being broadcast by nearby BLE peripherals
```csharp
var cts = new CancellationTokenSource(TimeSpan.FromSeconds( 30 ));
await ble.ScanForBroadcasts(
// providing ScanSettings is optional
new ScanSettings()
{
// Setting the scan mode is currently only applicable to Android and has no effect on other platforms.
// If not provided, defaults to ScanMode.Balanced
Mode = ScanMode.LowPower,
// Optional scan filter to ensure that the observer will only receive peripherals
// that pass the filter. If you want to scan for everything around, omit the filter.
Filter = new ScanFilter()
{
AdvertisedDeviceName = "foobar",
AdvertisedManufacturerCompanyId = 76,
// peripherals must advertise at-least-one of any GUIDs in this list
AdvertisedServiceIsInList = new List(){ someGuid },
},
// ignore repeated advertisements from the same device during this scan
IgnoreRepeatBroadcasts = false
},
// Your IObserver or Action will be triggered for each discovered
// peripheral based on the provided scan settings and filter (if any).
( IBlePeripheral peripheral ) =>
{
// read the advertising data
var adv = peripheral.Advertisement;
Debug.WriteLine( adv.DeviceName );
Debug.WriteLine( adv.Services.Select( x => x.ToString() ).Join( "," ) );
Debug.WriteLine( adv.ManufacturerSpecificData.FirstOrDefault().CompanyName() );
Debug.WriteLine( adv.ServiceData );
// if we found what we needed, stop the scan manually
cts.Cancel();
// perhaps connect to the device (see next example)...
},
// Provide a CancellationToken to stop the scan, or use the overload that takes a TimeSpan.
// If you omit this argument, the scan will timeout after BluetoothLowEnergyUtils.DefaultScanTimeout
cts.Token
);
// scanning has stopped when code reached this point since the scan was awaited
```
You can also create a `ScanFilter` using a fluent builder syntax if you prefer that:
```csharp
new ScanFilter()
.SetAdvertisedDeviceName( "foobar" )
.SetAdvertisedManufacturerCompanyId( 76 )
.AddAdvertisedService( someGuid )
```
### Connect to a BLE device
If you have already scanned for and discovered a peripheral and you now want to connect to it:
```csharp
var connection = await ble.ConnectToDevice(
// The IBlePeripheral to connect to
peripheral,
// TimeSpan or CancellationToken to stop the
// connection attempt.
// If you omit this argument, it will use
// BluetoothLowEnergyUtils.DefaultConnectionTimeout
TimeSpan.FromSeconds( 15 ),
// Optional IProgress
progress => Debug.WriteLine(progress)
);
if(connection.IsSuccessful())
{
var gattServer = connection.GattServer;
// ... do things with gattServer here... (see later examples...)
}
else
{
// Do something to inform user or otherwise handle unsuccessful connection.
Debug.WriteLine( "Error connecting to device. result={0:g}", connection.ConnectionResult );
// e.g., "Error connecting to device. result=ConnectionAttemptCancelled"
}
```
Be sure to disconnect when you are done:
```csharp
await gattServer.Disconnect();
```
#### Connect to a specific device without manually scanning
In use-cases where you are not scanning for advertisements but rather looking to connect to a specific, known, device:
```csharp
var connection = await ble.FindAndConnectToDevice(
new ScanFilter()
.SetAdvertisedDeviceName( "foo" )
.SetAdvertisedManufacturerCompanyId( 0xffff )
.AddAdvertisedService( guid ),
TimeSpan.FromSeconds( 30 ) );
if(connection.IsSuccessful())
{
// ...
}
```
### See & Observe server connection Status
```csharp
Debug.WriteLine(gattServer.State); // e.g. ConnectionState.Connected
// the server implements IObservable so you can subscribe to its state
gattServer.Subscribe( state =>
{
if(state == ConnectionState.Disconnected)
{
Debug.WriteLine("Connection Lost");
}
} );
```
### Get and store descriptions for GATT GUIDs
You can provide information for the GUIDs representing services, characteristics, and descriptors with `KnownAttributes`.
```csharp
var known = new KnownAttributes();
// You can add descriptions for any desired
// characteristics, services, and descriptors
known.AddService( myGuid1, "Foo" );
known.AddCharacteristic( myGuid2, "Bar" );
known.AddDescriptor( myGuid3, "Baz" );
```
There are shortcuts to add all the attributes that have been adopted by the Bluetooth SIG.
```csharp
known.AddAdoptedServices();
known.AddAdoptedCharacteristics();
known.AddAdoptedDescriptors();
```
You can also create a new KnownAttributes with all the above adopted attributes already populated:
```csharp
known = KnownAttributes.CreateWithAdoptedAttributes();
```
Then use it as a lookup as needed.
```csharp
known.Get(guid);
known.GetDescriptionOrGuid(guid);
```
### Enumerate all services on the GATT Server
```csharp
foreach(var guid in await gattServer.ListAllServices())
{
Debug.WriteLine( $"service: {known.GetDescriptionOrGuid(guid)}" );
}
```
### Enumerate all characteristics of a service
```csharp
Debug.WriteLine( $"service: {serviceGuid}" );
foreach(var guid in await gattServer.ListServiceCharacteristics( serviceGuid ))
{
Debug.WriteLine( $"characteristic: {known.GetDescriptionOrGuid(guid)}" );
}
```
### Read a characteristic
```csharp
try
{
var value = await gattServer.ReadCharacteristicValue( someServiceGuid, someCharacteristicGuid );
}
catch(GattException ex)
{
Debug.WriteLine( ex.ToString() );
}
```
### Listen for notifications on a characteristic
```csharp
IDisposable notifyHandler;
try
{
// Will also stop listening when gattServer
// is disconnected, so if that is acceptable,
// you don't need to store this disposable.
notifyHandler = gattServer.NotifyCharacteristicValue(
someServiceGuid,
someCharacteristicGuid,
// IObserver> or IObserver or
// Action> or Action
bytes => {/* do something with notification bytes */} );
}
catch(GattException ex)
{
Debug.WriteLine( ex.ToString() );
}
// ... later, once done listening for notifications ...
notifyHandler.Dispose();
```
### Write to a characteristic
```csharp
try
{
// The resulting value of the characteristic is returned. In nearly all cases this
// will be the same value that was provided to the write call (e.g. `byte[]{ 1, 2, 3 }`)
var value = await gattServer.WriteCharacteristicValue(
someServiceGuid,
someCharacteristicGuid,
new byte[]{ 1, 2, 3 } );
}
catch(GattException ex)
{
Debug.WriteLine( ex.ToString() );
}
```
### Logging
BLE.net uses a simple logging library internally. You can add a log "sink" to receive each log entry which you can then write to the console or a logging system of your choice.
> Also, each platform's static `BluetoothLowEnergyAdapter.ObtainAdapter()` method has an overload that takes an `ILog`. If no log is provided the default log (`SystemLog.Instance`) is used, but you could provide your own entire logging implementation if you really wanted to.
#### Add a debug log sink on Android
```csharp
var logId = Assembly.GetAssembly( GetType() ).GetName().Name;
// ble.net will log to SystemLog.Instance unless provided a custom logger
SystemLog.Instance.AddSink(
entry =>
{
var message = entry.FormatAsString();
switch(entry.Severity)
{
case LogLevel.Error:
Log.Error( logId, message );
break;
case LogLevel.Warn:
Log.Warn( logId, message );
break;
case LogLevel.Info:
Log.Info( logId, message );
break;
case LogLevel.Trace:
default:
Log.Debug( logId, message );
break;
}
} );
```
#### Add a console log sink on iOS
```csharp
// ble.net will log to SystemLog.Instance unless provided a custom logger
SystemLog.Instance.AddSink(
entry =>
{
var message = entry.FormatAsString();
if(entry.Severity == LogLevel.Error)
{
Console.Error.WriteLine( message );
}
else
{
Console.Out.WriteLine( message );
}
} );
```