2017-11-22 14:58:45 +00:00
|
|
|
<a name="module_ble"></a>
|
2017-09-17 21:54:07 +00:00
|
|
|
|
2017-11-22 14:58:45 +00:00
|
|
|
## ble
|
|
|
|
|
|
|
|
* [ble](#module_ble)
|
|
|
|
* [~BLE](#module_ble..BLE)
|
|
|
|
* [new BLE()](#new_module_ble..BLE_new)
|
|
|
|
* [.on(eventName, callback)](#module_ble..BLE+on)
|
|
|
|
* [~os](#module_ble..os)
|
|
|
|
|
|
|
|
<a name="module_ble..BLE"></a>
|
|
|
|
|
|
|
|
### ble~BLE
|
2017-09-17 21:54:07 +00:00
|
|
|
Class representing the bluetooth interface
|
|
|
|
|
2017-11-22 14:58:45 +00:00
|
|
|
**Kind**: inner class of [<code>ble</code>](#module_ble)
|
|
|
|
|
|
|
|
* [~BLE](#module_ble..BLE)
|
|
|
|
* [new BLE()](#new_module_ble..BLE_new)
|
|
|
|
* [.on(eventName, callback)](#module_ble..BLE+on)
|
|
|
|
|
|
|
|
<a name="new_module_ble..BLE_new"></a>
|
2017-09-17 23:51:33 +00:00
|
|
|
|
2017-11-22 14:58:45 +00:00
|
|
|
#### new BLE()
|
|
|
|
Establishes Bluetooth Low Energy services, accessible to process through this class
|
|
|
|
|
|
|
|
<a name="module_ble..BLE+on"></a>
|
|
|
|
|
|
|
|
#### blE.on(eventName, callback)
|
2017-09-17 23:51:33 +00:00
|
|
|
Binds functions to events that are triggered by BLE messages
|
|
|
|
|
2017-11-22 14:58:45 +00:00
|
|
|
**Kind**: instance method of [<code>BLE</code>](#module_ble..BLE)
|
2017-09-17 23:51:33 +00:00
|
|
|
|
|
|
|
| Param | Type | Description |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| eventName | <code>string</code> | Name of the event to to bind |
|
|
|
|
| callback | <code>function</code> | Invoked when the event is triggered |
|
|
|
|
|
2017-11-22 14:58:45 +00:00
|
|
|
<a name="module_ble..os"></a>
|
|
|
|
|
|
|
|
### ble~os
|
|
|
|
Bluetooth Low Energy module
|
|
|
|
|
|
|
|
**Kind**: inner constant of [<code>ble</code>](#module_ble)
|