Compare commits

..

1 Commits

Author SHA1 Message Date
c4d4b1fa60 Documentation 2019-11-27 11:07:37 -05:00
3 changed files with 5 additions and 5 deletions

2
.gitignore vendored
View File

@ -1 +1 @@
Ble.jar

BIN
Ble.jar

Binary file not shown.

View File

@ -3,9 +3,9 @@
A modern, cross-platform Go library for Bluetooth Low Energy A modern, cross-platform Go library for Bluetooth Low Energy
This package is a working but incomplete interface for access to Bluetooth This package is a working but incomplete interface for access to Bluetooth
Low Energy devices. It is intended to support multiple operating systems Low Energy. It is intended to support multiple operating systems with a
with a uniform API. Currently, MacOS and Android are supported. Android uniform API. Currently, MacOS and Android are supported. Android support
support requires the use of [Gio](https://gioui.org). requires the use of [Gio](https://gioui.org).
The API is asyncrhonous and event driven. To access Bluetooth hardware, The API is asyncrhonous and event driven. To access Bluetooth hardware,
first create a `BLE` variable with `NewBLE()`. On Android, you must also first create a `BLE` variable with `NewBLE()`. On Android, you must also
@ -30,7 +30,7 @@ Once enabled, you can call the primary API functions, `Scan`, `StopScan`,
Bluetooth hardware by calling `State`. Bluetooth hardware by calling `State`.
Calling `Events` on your `BLE` object returns a channel on which API events Calling `Events` on your `BLE` object returns a channel on which API events
are delivered. These events notify your program when the state of the are be delivered. These events notify your program when the state of the
BLE hardware changes (e.g. powered on or off), peripherals are connected, BLE hardware changes (e.g. powered on or off), peripherals are connected,
services or characteristics are discovered, or values for characteristics services or characteristics are discovered, or values for characteristics
are updated. are updated.