git.r.bdr.sh / rbdr / sorting-hat / blame
| Commit | Line | Data |
|---|---|---|
| 8cfba6fe BB |
1 | ## Classes |
| 2 | ||
| 3 | <dl> | |
| 4 | <dt><a href="#SortingHat">SortingHat</a></dt> | |
| 5 | <dd></dd> | |
| 6 | </dl> | |
| 7 | ||
| 8 | ## Typedefs | |
| 9 | ||
| 10 | <dl> | |
| 11 | <dt><a href="#tSortingHatConfig">tSortingHatConfig</a> : <code>object</code></dt> | |
| 12 | <dd><p>The configuration used to extend the SortingHat class</p> | |
| 13 | </dd> | |
| 14 | </dl> | |
| 15 | ||
| 16 | <a name="SortingHat"></a> | |
| 17 | ||
| 18 | ## SortingHat | |
| 19 | **Kind**: global class | |
| 20 | ||
| 21 | * [SortingHat](#SortingHat) | |
| 22 | * [new SortingHat(config)](#new_SortingHat_new) | |
| 23 | * [.deviceLocation](#SortingHat+deviceLocation) : <code>string</code> | |
| 24 | ||
| 25 | <a name="new_SortingHat_new"></a> | |
| 26 | ||
| 27 | ### new SortingHat(config) | |
| 28 | The main server for the sorting hat, it is in charge of connecting to the | |
| 29 | device and emitting events for the GUI via a socket | |
| 30 | ||
| 31 | ||
| 32 | | Param | Type | Description | | |
| 33 | | --- | --- | --- | | |
| 34 | | config | [<code>tSortingHatConfig</code>](#tSortingHatConfig) | the configuration to extend the object | | |
| 35 | ||
| 36 | <a name="SortingHat+deviceLocation"></a> | |
| 37 | ||
| 38 | ### sortingHat.deviceLocation : <code>string</code> | |
| 39 | The location of the mindwae device we'll be listening to | |
| 40 | ||
| 41 | **Kind**: instance property of [<code>SortingHat</code>](#SortingHat) | |
| 42 | **Default**: <code>"/dev/cu.Bluetooth-Incoming-Port"</code> | |
| 43 | <a name="tSortingHatConfig"></a> | |
| 44 | ||
| 45 | ## tSortingHatConfig : <code>object</code> | |
| 46 | The configuration used to extend the SortingHat class | |
| 47 | ||
| 48 | **Kind**: global typedef | |
| 49 | **Properties** | |
| 50 | ||
| 51 | | Name | Type | Description | | |
| 52 | | --- | --- | --- | | |
| 53 | | deviceLocation | <code>string</code> | the location of the mindwave device | | |
| 54 |