Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mickeyl/core-bluetooth-tool
Bluetooth Low Energy Command Line Tool (macOS)
https://github.com/mickeyl/core-bluetooth-tool
Last synced: 5 days ago
JSON representation
Bluetooth Low Energy Command Line Tool (macOS)
- Host: GitHub
- URL: https://github.com/mickeyl/core-bluetooth-tool
- Owner: mickeyl
- License: mit
- Created: 2021-03-17T10:32:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T06:54:50.000Z (over 1 year ago)
- Last Synced: 2024-10-26T22:48:13.309Z (19 days ago)
- Language: Swift
- Size: 52.7 KB
- Stars: 34
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: Supporting/Entitlements.plist
Awesome Lists containing this project
README
# core-bluetooth-tool
Bluetooth Low Energy command line tool for macOS.
## Features
* Scan BLE devices
* Establish a serial TTY connection to a BLE device
* (more planned is planned, but this is v0.3)
## Quick Start
### Installation
#### [Mint](https://github.com/yonaskolb/mint)
```sh
mint install mickeyl/core-bluetooth-tool
```
#### [Homebrew](https://brew.sh)
```sh
brew tap mickeyl/formulae
brew install core-bluetooth-tool
```
### Requirements
Since this application uses Bluetooth, you need to grant Bluetooth access to your favorite terminal emulator before
running `core-bluetooth-tool`. Otherwise, the application will be halted by the OS.
### Usage
Scan all BLE devices in vicinity (**broken in macOS Monterey < 12.3, earlier and newer versions OK**):
```sh
core-bluetooth-tool scan
```
Scan all BLE devices in vicinity providing a certain service, e.g. with a UUID of `FFF0`:
```sh
core-bluetooth-tool scan fff0
```
Establish a serial bridge to the first BLE device providing a serial communication service, e.g., with a UUID of `FFF0`:
```sh
core-bluetooth-tool bridge fff0
```
Establish a serial bridge to a concrete BLE device providing a serial communication service, e.g., with a UUID of `FFF0`:
```sh
core-bluetooth-tool bridge fff0 F890A301-A464-D37C-AAFB-9374B546F7FE
```
## Motivation
For my work on car diagnosis apps like [OBD2 Expert](https://apps.apple.com/app/obd2-experte/id1142156521), I have been writing a lot of code to communicate
with various kinds of serial OBD2 adapters. The most common technologies here are USB (`ftdi232`), WiFi, Bluetooth 3.x (`rfcomm`), and – more recently – Bluetooth Low Energy (BLE).
While (of course) I have code that interacts with such devices, it's always important to be able to _directly_ communicate with an adapter.
This is no problem with USB, WiFi, and Bluetooth 3.x communication, as we already have tools like `minicom`, `picocom`, and `ncat` to our disposal.
For Bluetooth Low Energy devices though, this has always been kind of a hassle. In contrast to Bluetooth 3.x, the serial port is provided
through a service providing one or two BLE characteristics, one readable, and one writable.
That's why I wrote the `bridge` subcommand, which opens a pseudo `tty` and allows you to use a terminal program to seamlessly interact with the device.
And while I was there, I figured I'd extend this to facilitate more tools.
## Plans
I want to extend this tool in order to handle all the common tasks typically associated with Bluetooth Low Energy devices, such as
* scanning and printing services
* scanning and printing characteristics
* scanning and printing descriptors
* trigger bonding (by reading from an encrypted characteristic)
* subscribing to a characteristic and continously printing the output
* reading and writing to/from a characteristic
It would also be nice to have kind of a `readline`-based REPL, where you directly interact with one device.
I could even imagine an `ncurses`-alike interface (such as `htop` is presenting) for showing the signal strength of devices in vicinity.
It might also be interesting to evaluate [PureSwift/BluetoothLinux](https://github.com/PureSwift/BluetoothLinux) in order to make this tool work
on Linux.
## Contribution
Please use under the terms of the MIT license. As always, I welcome any form of contribution.