feat: add BLEAdapter common interface (#431)

* feat: add BLEAdapter common interface

* add errNotSupported

* cast nil instance

* change gap s117 errors to errNotSupported

Author: acouvreur

adapter.go

@@ -1,6 +1,15 @@
 package bluetooth
 
-// SetConnectHandler sets a handler function to be called whenever the adaptor connects
+// BLEAdapter is the shared interface that all platform-specific Adapter types must implement.
+type BLEAdapter interface {
+	Connect(address Address, params ConnectionParams) (Device, error)
+	Enable() error
+	Scan(callback func(*Adapter, ScanResult)) (err error)
+	SetConnectHandler(c func(device Device, connected bool))
+	StopScan() error
+}
+
+// SetConnectHandler sets a handler function to be called whenever the adapter connects
 // or disconnects. You must call this before you call adapter.Connect() for centrals
 // or advertisement.Start() for peripherals in order for it to work.
 func (a *Adapter) SetConnectHandler(c func(device Device, connected bool)) {

adapter_cyw43439.go

@@ -12,6 +12,8 @@ import (
 
 const maxConnections = 1
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 // Adapter represents a SPI connection to the HCI controller on an attached CYW4349 module.
 type Adapter struct {
 	hciAdapter

adapter_darwin.go

@@ -8,6 +8,8 @@ import (
 	"github.com/tinygo-org/cbgo"
 )
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 // Adapter is a connection to BLE devices.
 type Adapter struct {
 	cmd *centralManagerDelegate

adapter_hci_uart.go

@@ -8,6 +8,8 @@ import (
 
 const maxConnections = 1
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 // Adapter represents a "plain" UART connection to the HCI controller.
 type Adapter struct {
 	hciAdapter

adapter_linux.go

@@ -14,6 +14,8 @@ import (
 
 const defaultAdapter = "hci0"
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 type Adapter struct {
 	id                   string
 	scanCancelChan       chan struct{}

adapter_ninafw.go

@@ -9,6 +9,8 @@ import (
 
 const maxConnections = 1
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 // Adapter represents the HCI connection to the NINA fw using the hardware UART.
 type Adapter struct {
 	hciAdapter

adapter_nrf51.go

@@ -127,3 +127,24 @@ func makeMACAddress(addr C.ble_gap_addr_t) MACAddress {
 		isRandom: addr.addr_type != 0,
 	}
 }
+
+// Connect starts a connection attempt to the given peripheral device address.
+//
+// Not yet implemented on the nrf51.
+func (a *Adapter) Connect(address Address, params ConnectionParams) (Device, error) {
+	return Device{}, errNotYetImplmented
+}
+
+// Scan starts a BLE scan. It is stopped by a call to StopScan.
+//
+// Not yet implemented on the nrf51.
+func (a *Adapter) Scan(callback func(*Adapter, ScanResult)) (err error) {
+	return errNotYetImplmented
+}
+
+// StopScan stops any in-progress scan.
+//
+// Not yet implemented on the nrf51.
+func (a *Adapter) StopScan() error {
+	return errNotYetImplmented
+}

adapter_s113v7.go

@@ -11,3 +11,24 @@ package bluetooth
 nrf_nvic_state_t nrf_nvic_state = {0};
 */
 import "C"
+
+// Connect starts a connection attempt to the given peripheral device address.
+//
+// s113v7 is a peripheral-only device, so this is not supported.
+func (a *Adapter) Connect(address Address, params ConnectionParams) (Device, error) {
+	return Device{}, errNotSupported
+}
+
+// Scan starts a BLE scan. It is stopped by a call to StopScan.
+//
+// s113v7 is a peripheral-only device, so this is not supported.
+func (a *Adapter) Scan(callback func(*Adapter, ScanResult)) (err error) {
+	return errNotSupported
+}
+
+// StopScan stops any in-progress scan.
+//
+// s113v7 is a peripheral-only device, so this is not supported.
+func (a *Adapter) StopScan() error {
+	return errNotSupported
+}

adapter_sd.go

@@ -41,6 +41,8 @@ func init() {
 	secModeOpen.set_bitfield_lv(1)
 }
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 // Adapter is a dummy adapter: it represents the connection to the (only)
 // SoftDevice on the chip.
 type Adapter struct {

adapter_windows.go

@@ -10,6 +10,8 @@ import (
 	"github.com/saltosystems/winrt-go/windows/foundation"
 )
 
+var _ BLEAdapter = (*Adapter)(nil)
+
 type Adapter struct {
 	watcher *advertisement.BluetoothLEAdvertisementWatcher