From d7a84247137d23c5a78119aad62a2c64179af685 Mon Sep 17 00:00:00 2001
From: TTangNingzhi <tnz241736@gmail.com>
Date: Thu, 28 Dec 2023 03:50:16 -0500
Subject: [PATCH] real-time api

---
 .idea/workspace.xml                    |  9 ++++++---
 docs/developer.md                      | 28 +++++++++++++++++++-------
 src/main/java/trackers/EyeTracker.java | 13 ++++++++++++
 3 files changed, 40 insertions(+), 10 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index ef540c7..2978878 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,7 +5,9 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="14bb91d1-ebd0-4f11-b77e-711543adf329" name="Changes" comment="refresh">
-      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/developer.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/developer.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/trackers/EyeTracker.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/trackers/EyeTracker.java" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -80,7 +82,7 @@
     "ShowUsagesActions.previewPropertyKey": "true",
     "WebServerToolWindowFactoryState": "false",
     "git-widget-placeholder": "main",
-    "last_opened_file_path": "C:/Users/Lenovo/IdeaProjects/CodeGRITS/docs/static",
+    "last_opened_file_path": "C:/Users/Lenovo/IdeaProjects/DataStreamReceiver",
     "node.js.detected.package.eslint": "true",
     "node.js.detected.package.tslint": "true",
     "node.js.selected.package.eslint": "(autodetect)",
@@ -185,7 +187,8 @@
       <workItem from="1703638913629" duration="33159000" />
       <workItem from="1703678759806" duration="1861000" />
       <workItem from="1703689805171" duration="3254000" />
-      <workItem from="1703723025891" duration="7371000" />
+      <workItem from="1703723025891" duration="8208000" />
+      <workItem from="1703743132882" duration="5834000" />
     </task>
     <task id="LOCAL-00001" summary="fix api bug">
       <option name="closed" value="true" />
diff --git a/docs/developer.md b/docs/developer.md
index f6ae71b..51fc7fe 100644
--- a/docs/developer.md
+++ b/docs/developer.md
@@ -38,6 +38,13 @@ We provide a real-time data API for future JetBrains plugin developers and resea
 IDE tracker and eye tracker separately. The API is based on the [IDE Tracker](#ide-tracker)
 and [Eye Tracker](#eye-tracker).
 
+#### Example Project
+
+We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver)
+that builds on top of the real-time data API. It is designed to receive real-time IDE tracking and eye tracking data and
+directly visualize them in two separate windows. You could refer to the source code of the example project to learn how
+to use the API.
+
 ### Configuration
 
 Before using the API, you first need to build CodeGRITS from source
@@ -52,6 +59,13 @@ intellij {
 }
 ```
 
+You also need to add the following to `./src/main/resources/META-INF/plugin.xml`.
+
+```xml
+
+<depends>com.nd.codegrits</depends>
+```
+
 ### Quick Start
 
 To use the API, simply call the `getInstance()` method to get the instance of the IDE Tracker or Eye Tracker. Then, set
@@ -60,13 +74,13 @@ the `ideTrackerDataHandler` or `eyeTrackerDataHandler` to handle the real-time d
 method to start tracking.
 
 ```java
-IDETracker ideTracker = IDETracker.getInstance();
-ideTracker.setIsRealTimeDataTransmitting(true);
-ideTracker.setIdeTrackerDataHandler(element -> {
-    String formattedStr = "Event: " + element.getAttribute("id");
-    System.out.println(formattedStr);
-});
-ideTracker.startTracking(currentProject);
+IDETracker ideTracker=IDETracker.getInstance();
+        ideTracker.setIsRealTimeDataTransmitting(true);
+        ideTracker.setIdeTrackerDataHandler(element->{
+        String formattedStr="Event: "+element.getAttribute("id");
+        System.out.println(formattedStr);
+        });
+        ideTracker.startTracking(currentProject);
 ```
 
 !!!
diff --git a/src/main/java/trackers/EyeTracker.java b/src/main/java/trackers/EyeTracker.java
index 3839e9a..b0e129c 100644
--- a/src/main/java/trackers/EyeTracker.java
+++ b/src/main/java/trackers/EyeTracker.java
@@ -88,7 +88,20 @@ public void selectionChanged(@NotNull FileEditorManagerEvent event) {
                 }
             }
         });
+    }
 
+    public EyeTracker(String pythonInterpreter, double sampleFrequency, boolean isUsingMouse) throws ParserConfigurationException {
+        // designed specifically for the real-time data API
+        this(); // call default constructor
+        if (isUsingMouse) {
+            deviceIndex = 0;
+        } else {
+            deviceIndex = 1;
+        }
+        this.pythonInterpreter = pythonInterpreter;
+        this.sampleFrequency = sampleFrequency;
+        setPythonScriptMouse();
+        setPythonScriptTobii();
     }
 
     VisibleAreaListener visibleAreaListener = e -> visibleArea = e.getNewRectangle();