BluetoothDevicePairing

Console utility to discover and pair Bluetooth and Bluetooth Low Energy devices. The utility also allows to connect and disconnect from audio Bluetooth devices.

• If you pair a device that is not already paired, the utility will also connect to it (this is the default behavior of Windows Bluetooth API)
  
• If you pair to an already paired audio Bluetooth device, the utility will connect to it.
• Managing Bluetooth devices by mac is much faster than by name, because it doesn't require device discovery.
• When managing Bluetooth devices by name, you can use the --discovery-time parameter to change the time spend on device discovery.

System requirements

Windows 10 1809 (10.0.17763) or higher

How to use

• Download and unpack the latest release.
• Run BluetoothDevicePairing.exe --help and BluetoothDevicePairing.exe <command> --help to get usage information and check the Examples section below.

Examples

• Discover devices:

BluetoothDevicePairing.exe discover

• Pair a device using its Mac address:

BluetoothDevicePairing.exe pair-by-mac --mac 12:34:56:78:9A:BC --type Bluetooth

• Pair a device using its name:

BluetoothDevicePairing.exe pair-by-name --name "MX Ergo" --type BluetoothLE

• Pair a device using its name and pin code:

BluetoothDevicePairing.exe pair-by-name --name "Device name" --type BluetoothLE --pin 1234

• Pair a device using its Mac and pin code:

BluetoothDevicePairing.exe pair-by-mac --mac 12:34:56:78:9A:BC --type Bluetooth --pin 1234

• Unpair a device using its Mac address:

BluetoothDevicePairing.exe unpair-by-mac --mac 12:34:56:78:9A:BC --type Bluetooth

• Unpair a device using its name:

BluetoothDevicePairing.exe unpair-by-name --name "MX Ergo" --type BluetoothLE

• List all Bluetooth adapters available to your machine

BluetoothDevicePairing.exe list-adapters

• Disconnect an audio device using its Mac address:

BluetoothDevicePairing.exe disconnect-bluetooth-audio-device-by-name --name WH-1000XM5

• Disconnect to an audio device using its name:

BluetoothDevicePairing.exe disconnect-bluetooth-audio-device-by-mac --mac 88:c9:e8:17:5e:0f

Examples of scripts

The BluetoothDevicePairing utility can be used in bat and PowerShell scripts.

Script to pair a Bluetooth device

The following bat script allows to automate the connection of Bluetooth devices. Before using this script, you need to find out the Bluetooth type and name of your device:

1. Put the device into the pairing mode
2. Run the BluetoothDevicePairing.exe discover command that will print the required information.
3. Adapt the script below to use your device's name and Bluetooth type.

How to use the script:

1. Put the device into a pairing mode
2. Run the script

C:\my\apps\BluetoothDevicePairing.exe unpair-by-name --name "MX Ergo" --type BluetoothLE --discovery-time 1
C:\my\apps\BluetoothDevicePairing.exe pair-by-name --name "MX Ergo" --type BluetoothLE --discovery-time 10
if %ErrorLevel% NEQ 0 (
    pause
    exit /b %errorlevel%
)

Device pairing by name

To pair a device by name, the utility starts by discovering all available devices and tries to find a device with the required name. After a device is found, its Mac address is used to request pairing. The command will fail if there are several devices with the same name.

Return values

If the command fails, it returns the value -1. If it succeeds, it returns 0.

Build

• Use Visual Studio 2022 to open the solution file and work with the code
• Run build.ps1 to build a release (to run this script, git.exe should be in your PATH)

References

• Windows.Devices.Enumeration API usage examples
• Windows.Devices.Enumeration Namespace
• ToothTray - reference implementation of connecting to Bluetooth audio devices