Merge pull request #4 from kexxu-robotics/jur/outline

outline and todo

Author: jurschreuder

README.md

@@ -39,3 +39,71 @@ Real time eye tracking data is available over MQTT.
 The list of recordings and the files of the recordings of the device are available on http.
 
 
+
+# This SDK is still work in progress, check the progress here
+
+
+### File format
+
+- [x] Convert from OpenEye Datafile to x,y pixel locations in video
+
+- [ ] Convert pixel locations back into OpenEye Datafile
+
+- [ ] Read specific event types in the Datafile
+
+- [ ] Add specific event types in the Datafile
+
+### Connectivity
+
+- [ ] Try to find device by DeviceID
+
+- [ ] Get current wifi network
+
+- [ ] Scan for device on all ip addresses
+
+- [ ] Send event to device
+
+
+### Actions
+
+- [ ] Start preview
+
+- [ ] Stop preview
+
+- [ ] Start recording
+
+- [ ] Stop recording
+
+
+### Calibration
+
+- [ ] Get conf
+
+- [ ] Get eye location
+
+- [ ] Move tracking window
+
+- [ ] Move tracking cross offset
+
+
+### Recordings
+
+- [ ] List recordings
+
+- [ ] Show disk space
+
+- [ ] Delete recording
+
+
+
+### WIFI
+
+- [ ] scanned networks
+
+- [ ] saved networks
+
+- [ ] add network
+
+- [ ] remove network
+
+

src/kexxu_eye_sdk/api.py

@@ -26,6 +26,17 @@
 # Stop recording
 
 
+# ==== Calibration
+
+# Get conf
+
+# Get eye location
+
+# Move tracking window
+
+# Move tracking cross offset
+
+
 # ==== Recordings
 
 # List recordings