gazetk / DesktopConnector / README.md @ 33640c32
History | View | Annotate | Download (1.315 KB)
1 | 908a231e | Thies Pfeiffer | DesktopConnector |
---|---|---|---|
2 | ================ |
||
3 | |||
4 | [Download](https://opensource.cit-ec.de/projects/gazetk/repository/gazetk) |
||
5 | |||
6 | License |
||
7 | ------- |
||
8 | DesktopConnector is free and open source software distributed under the terms of the [GNU General Public License](http://www.gnu.org/licenses/). |
||
9 | |||
10 | Description |
||
11 | ----------- |
||
12 | Welcome to DesktopConnector! |
||
13 | |||
14 | DesktopConnector is the bridge between your remote desktop eye tracking device and gaze-enabled applications. |
||
15 | |||
16 | At the moment, DesktopConnector is written in Node.js. It consists of a basic server, which provides the interface to the application, and different DeviceConnectors for certain types of remote eye tracking systems. |
||
17 | |||
18 | Requirements |
||
19 | ------------ |
||
20 | * Node.js |
||
21 | * One of the supported eye tracking systems |
||
22 | ** Eyetribe |
||
23 | ** MyGaze |
||
24 | ** SMI REDm |
||
25 | |||
26 | Installation |
||
27 | ------------ |
||
28 | 1. Install Node.js |
||
29 | 2. Install the Node.js module nodejs-websocket |
||
30 | |||
31 | $ npm install nodejs-websocket |
||
32 | |||
33 | Starting DesktopConnector |
||
34 | ------------------------- |
||
35 | 1. Use the corresponding bat-file to start the DeviceConnector confiured for your eye tracking device, or start |
||
36 | |||
37 | $ node DesktopConnector.js --tracker=XXX |
||
38 | |||
39 | with XXX standing for smi, eyetribe or mygaze, which are the eye tracking systems that are currently supported. |
||
40 | |||
41 | 2. If you are using SMI REDm or MyGaze, you will need to start an additional DeviceServer. You can find them in the subdirectories. |