What's up with documentation

[H.Scheidl]

Hello! Just unpacked brand new Eye Tracking device – installation and configuration was superb on Windows 10. The development experience however… It seems the getting started documentation is outdated…

public static void Main(string[] args)
{
    var host = new Host();
    var gazePointDataStream = host.Streams.CreateGazePointDataStream();
    gazePointDataStream.GazePoint((gazePointX, gazePointY, _) => Console.WriteLine("X: {0} Y:{1}", gazePointX, gazePointY));
}

has to be…

        public static void Main(string[] args)
        {
            var host = new EyeXHost();
            host.Start();
            var gazePointDataStream = host.CreateGazePointDataStream(Tobii.EyeX.Framework.GazePointDataMode.Unfiltered);
            gazePointDataStream.Next += (s,e) => Console.WriteLine("X: {0} Y:{1}", e.X, e.Y);

        }

At least in my setup… Is documentation for an older version of the device?

[Denny [Tobii]]

Hi @h-scheid,

There are several SDKs out there from Tobii, the example code that you used are based on the Core SDK, but I suspect that you added the wrong nuget package for the example code. Make sure that your packages.config includes reference to Tobii.Interaction.

If you are developing for Windows 10 only, then you can also use the gaze API built into Windows. See here if https://docs.microsoft.com/en-us/windows/communitytoolkit/gaze/gazeinteractionlibrary on how to get started with those.

[H.Scheidl]

Hello Denny! As a developer I reiterate that documentation is not accurate enough…

Example 1, Getting started
“We add the Tobii Core SDK package by:
Right click on the project’s reference folder and choose Manage NuGet Packages… from the menu.
Browse for the Tobii Core SDK package and click install. ”

Reality: there is no Nuget package called “Tobii Core SDK”. Visual Studio suggests “Tobii.Interaction”.

If you search only for “Tobii”, you get 7 references, with conflicting descriptions. Example:

* Tobii.Eye.Tracking Adds eye-tracking to your application to make it more interactive.
* Tobii.EyeX.Client The Tobii EyeX Client package provides basic connectivity to the Tobii EyeX Engine to support development of interactive gaze applications.
* Tobii.EyeX.Framework The Tobii EyeX Framework provides you with the tools needed to build interactive eye-gaze enabled applications. This package supports WPF, WinForms and generic .net applications.

The descriptions above do not help developers choose which package to install 🙂 I’m sure you have quick answers to all my comments, but the point of documentation is not to need the forum to get started.

[Grant [Tobii]]

Hi @h-scheidl, many thanks for your feedback and our sincere apologies that you have not had the optimal experience that we endeavour to provide to all our customers.

We are aware that there is still work to be done in getting the online Core SDK documentation improved for new users, so we greatly appreciate your comments on this matter. With reference to the Nuget Packages, indeed Tobii has a number of offerings available including the Stream Engine and Tobii Pro SDK so any confusion is understandable and we will seek to clarify the Core SDK documentation to reflect this. For your purpose of developing against the Core SDK, the appropriate library is “Tobii.Interaction” which you have no doubt already discovered.

In the meantime, it may interest you to check out a few sample applications we have developed which illustrate how to implement key eye tracking features within the Core SDK which you can download @ https://github.com/Tobii/CoreSDK

And of course, should you have any further feedback or questions, please do not hesitate to get in touch again and we will be more than happy to help out.

[Author]

Posts