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