The version on master tracks Ubuntu bluetoothd version (v5.64). There are dedicated branches/tags with various version
See branches for available versions.
The library is a wrapper to the Bluez DBus API and some high level API to ease the interaction.
High level features supported:
- Client code generation from bluez documentation
- Shell wrappers for
hcisocket basic API (inspired by go-ble/ble)
- Expose bluetooth service from go code [unstable]
- Pairing and authentication support (via agent)
- Beaconing send & receive (iBeacon and Eddystone)
- Mesh API support (since v5.53)
- Generate dbus-compatible XML from documentation
- Generate mock service to test the library against
Want to add your project? Please, add it to the README.md and open a PR!
Examples are available in
cd _examples go run main.go # print available example commands # Example discovery go run main.go discovery
- Clone the repository
git clone https://github.com/muka/go-bluetooth.git
- Retrieve the bluetooth API and generate GO code
make bluez/init bluez/checkout gen/clean gen/run
To generate code for a new version of bluez use the command
BLUEZ_VERSION=5.65 make gen/clean gen
Change to a version available in bluez. Note that generated code may be broken or incomplete and the generation script may need fine tuning.
The code structure follow this pattern:
./apicontains wrappers for the DBus Api
./bluezcontains the actual implementation, generated from the
make gen to re-generate go sources. There is also a commodity bluez JSON file available in the root folder for reference.
Generated code has
gen_ prefix. If an API file exists with the same filename but without the prefix, generation will be skipped for that API.
The library is tested with
- bluez bluetooth
Inspect a service ObjectManager
dbus-send --system --print-reply --dest=go.bluetooth /hci0/apps/0 org.freedesktop.DBus.ObjectManager.GetManagedObjects
Retrieve char properties
dbus-send --system --print-reply --dest=go.bluetooth /hci0/apps/0/service000003e8/char0 org.freedesktop.DBus.Properties.GetAll string:org.bluez.GattCharacteristic1
Give access to
hciconfigto any user and avoid
sudo(may have security implications)
sudo setcap 'cap_net_raw,cap_net_admin+eip' `which hciconfig`
Monitor Bluetooth activity
Monitor DBus activity
sudo dbus-monitor --system "type=error"
bluetoothdwith experimental features and verbose debug messages
Enable LE advertisement (on a single pc ensure to use at least 2x bluetooth adapter)
sudo btmgmt -i 0 power off sudo btmgmt -i 0 name "my go app" sudo btmgmt -i 0 le on sudo btmgmt -i 0 connectable on sudo btmgmt -i 0 advertising on sudo btmgmt -i 0 power on
- Standard GATT characteristics descriptions
- bluez git
- GATT services specs
- A C++ implementation
- DBus specifications
- SensorTag specs
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.