Documentation for blootstrap

This commit is contained in:
mmcwilliams 2017-09-17 17:54:07 -04:00
parent b60334d4b7
commit c49c6a5b8d
3 changed files with 20 additions and 0 deletions

View File

@ -0,0 +1,6 @@
<a name="Blootstrap"></a>
## Blootstrap
Class representing the bluetooth interface
**Kind**: global class

View File

@ -6,6 +6,7 @@ function capitalize (s) {
return s[0].toUpperCase() + s.slice(1)
}
/** Class representing the bluetooth interface */
class Blootstrap {
constructor () {
this._onData = () => {}
@ -24,6 +25,13 @@ class Blootstrap {
})
})
}
/**
* Blootstrap.on() -
* Binds functions to events that are triggered by BLE messages
*
* @param {string} eventName Name of the event to to bind
* @param {function} callback Invoked when the event is triggered
*/
on (eventName, callback) {
this[`_on${capitalize(eventName)}`] = callback
}

View File

@ -0,0 +1,6 @@
<a name="Intval"></a>
## Intval
Class representing the intval3 features
**Kind**: global class