diff options
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..67eb065 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,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 | + |