diff --git a/platforms/ble/LICENSE b/platforms/ble/LICENSE new file mode 100644 index 00000000..c43e8d30 --- /dev/null +++ b/platforms/ble/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2015 The Hybrid Group + +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 + + http://www.apache.org/licenses/LICENSE-2.0 + +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. diff --git a/platforms/ble/README.md b/platforms/ble/README.md new file mode 100644 index 00000000..47b0c05f --- /dev/null +++ b/platforms/ble/README.md @@ -0,0 +1,34 @@ +# Bluetooth LE + +The gobot-ble adaptor makes it easy to interact with Bluetooth LE using Go. + +It is written using the [gatt](https://github.com/paypal/gatt) package from [Paypal](https://github.com/paypal). Thank you! + +Learn more about Bluetooth LE [here](http://en.wikipedia.org/wiki/Bluetooth_low_energy). + +## How to Install +``` +go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/ble +``` + +## How To Connect + +### OSX + +Info here... + +### Ubuntu + +Info here... + +### Windows + +Info here... + +## How to Use + +Example of a simple program... + +```go +... +``` diff --git a/platforms/ble/ble_adaptor.go b/platforms/ble/ble_adaptor.go new file mode 100644 index 00000000..f341b00d --- /dev/null +++ b/platforms/ble/ble_adaptor.go @@ -0,0 +1,156 @@ +package ble + +import ( + "fmt" + "log" + "strings" + "github.com/hybridgroup/gobot" + "github.com/paypal/gatt" +) + +var DefaultClientOptions = []gatt.Option{ + gatt.LnxMaxConnections(1), + gatt.LnxDeviceID(-1, false), +} + +var _ gobot.Adaptor = (*BLEAdaptor)(nil) + +// Represents a Connection to a BLE Peripheral +type BLEAdaptor struct { + name string + uuid string + device gatt.Device + //sp io.ReadWriteCloser + connected bool + //connect func(string) (io.ReadWriteCloser, error) +} + +// NewBLEAdaptor returns a new BLEAdaptor given a name and uuid +func NewBLEAdaptor(name string, uuid string) *BLEAdaptor { + return &BLEAdaptor{ + name: name, + uuid: uuid, + // connect: func(port string) (io.ReadWriteCloser, error) { + // return serial.OpenPort(&serial.Config{Name: port, Baud: 115200}) + // }, + } +} + +func (b *BLEAdaptor) Name() string { return b.name } +func (b *BLEAdaptor) UUID() string { return b.uuid } + +// Connect initiates a connection to the BLE peripheral. Returns true on successful connection. +func (b *BLEAdaptor) Connect() (errs []error) { + device, err := gatt.NewDevice(DefaultClientOptions...) + if err != nil { + log.Fatalf("Failed to open BLE device, err: %s\n", err) + return + } + + b.device = device + + // Register handlers. + device.Handle( + gatt.PeripheralDiscovered(b.onDiscovered), + gatt.PeripheralConnected(b.onConnected), + gatt.PeripheralDisconnected(b.onDisconnected), + ) + + device.Init(b.onStateChanged) + + // TODO: make sure peripheral currently exists for this UUID before returning + return nil +} + +// Reconnect attempts to reconnect to the BLE peripheral. If it has an active connection +// it will first close that connection and then establish a new connection. +// Returns true on Successful reconnection +func (b *BLEAdaptor) Reconnect() (errs []error) { + if b.connected { + b.Disconnect() + } + return b.Connect() +} + +// Disconnect terminates the connection to the BLE peripheral. Returns true on successful disconnect. +func (b *BLEAdaptor) Disconnect() (errs []error) { + // if a.connected { + // if err := a.sp.Close(); err != nil { + // return []error{err} + // } + // a.connected = false + // } + return +} + +// Finalize finalizes the BLEAdaptor +func (b *BLEAdaptor) Finalize() (errs []error) { + return b.Disconnect() +} + +// ReadCharacteristic returns bytes from the BLE device for the +// requested service and characteristic +func (b *BLEAdaptor) ReadCharacteristic(sUUID string, cUUID string) (data []byte, err error) { + // TODO: get the peripheral p + // TODO: get the service s that matches sUUID + // TODO: get characteristic c matches cUUID for service sUUID + // b, err := p.ReadCharacteristic(c) + // if err != nil { + // fmt.Printf("Failed to read characteristic, err: %s\n", err) + // return []byte{}, err + // } + + return nil, nil +} + +func (b *BLEAdaptor) getPeripheral() { + +} + +func (b *BLEAdaptor) getService() { + +} + +func (b *BLEAdaptor) onStateChanged(d gatt.Device, s gatt.State) { + fmt.Println("State:", s) + switch s { + case gatt.StatePoweredOn: + fmt.Println("scanning...") + d.Scan([]gatt.UUID{}, false) + return + default: + d.StopScanning() + } +} + +func (b *BLEAdaptor) onDiscovered(p gatt.Peripheral, a *gatt.Advertisement, rssi int) { + fmt.Println("Discovered") + id := strings.ToUpper(b.UUID()) + if strings.ToUpper(p.ID()) != id { + return + } + + b.connected = true + + // Stop scanning once we've got the peripheral we're looking for. + p.Device().StopScanning() + + fmt.Printf("\nPeripheral ID:%s, NAME:(%s)\n", p.ID(), p.Name()) + fmt.Println(" Local Name =", a.LocalName) + fmt.Println(" TX Power Level =", a.TxPowerLevel) + fmt.Println(" Manufacturer Data =", a.ManufacturerData) + fmt.Println(" Service Data =", a.ServiceData) + fmt.Println("") + + p.Device().Connect(p) +} + +func (b *BLEAdaptor) onConnected(p gatt.Peripheral, err error) { + fmt.Println("Connected") + defer p.Device().CancelConnection(p) +} + +func (b *BLEAdaptor) onDisconnected(p gatt.Peripheral, err error) { + fmt.Println("Disconnected") +} + diff --git a/platforms/ble/ble_adaptor_test.go b/platforms/ble/ble_adaptor_test.go new file mode 100644 index 00000000..c852bc4b --- /dev/null +++ b/platforms/ble/ble_adaptor_test.go @@ -0,0 +1,21 @@ +package ble + +import ( + "testing" + + "github.com/hybridgroup/gobot" +) + +func initTestBLEAdaptor() *BLEAdaptor { + a := NewBLEAdaptor("bot", "D7:99:5A:26:EC:38") + // a.connect = func(n *BLEAdaptor) (io.ReadWriteCloser, error) { + // return &NullReadWriteCloser{}, nil + // } + return a +} + +func TestBLEAdaptor(t *testing.T) { + a := NewBLEAdaptor("bot", "D7:99:5A:26:EC:38") + gobot.Assert(t, a.Name(), "bot") + gobot.Assert(t, a.UUID(), "D7:99:5A:26:EC:38") +}