Skip to content

# Installation & Setup

## Requirements

To begin using the SDK, you need:

1. Windows 10 or later.

2. The Beam Eye Tracker application installed and setup on your system.

3. The SDK downloaded and unzipped on your system (If using Python, this is optional).

4. A development environment for your chosen programming language or framework.

## Project configuration

Depending on your specific project and language, you need to follow the steps below to integrate the SDK.

C/C++

1. Add the `beam_eye_tracker_sdk-2.x.x\include` directory to your project’s include paths.

   Note

   In case of using CMake, you can use the `target_include_directories` command.

2. Add the `beam_eye_tracker_sdk-2.x.x\lib\win64` directory to your project’s library directories.

   Note

   In case of using CMake, you can use the `target_link_directories` command.

3. Add the `beam_eye_tracker_client.lib` file to your project’s linker input dependencies.

   Note

   In case of using CMake, you can use the `target_link_libraries` command.

4. Copy the `beam_eye_tracker_client.dll` from the `beam_eye_tracker_sdk-2.x.x\bin\win64` directory to your project’s output directory.

Note

We also provide an alternative library build with `/MT`` (`beam_eye_tracker_client_MT.lib`` and `beam_eye_tracker_client_MT.dll`) and thus not requiring the Visual C++ Redistributable at the host machine. However, in most cases, it is acceptable and even preferred to use the default library (`/MD` build).

Python

1. Install the `beam-eye-tracker` package:

   >     pip install beam-eye-tracker

   > Note

   > Alternatively, you can download the SDK, unzip it and add the `beam_eye_tracker_sdk-2.x.x\python\package` directory to your `PYTHONPATH`.

2. Test your installation:

   >     # This should not raise an import error:
   >     from eyeware.beam_eye_tracker import API

C#

This assumes the project platform target is `x64`:

1. Copy `beam_eye_tracker_sdk-2.x.x\csharp\Eyeware\BeamEyeTracker.cs` into your project directory (e.g., root or a subfolder like `Eyeware/`).

2. Include the `BeamEyeTracker.cs` file in your project.

   > Note

   > For Visual Studio: Right-click the project in Solution Explorer, select `Add > Existing Item`, and add `BeamEyeTracker.cs`.

3. Copy the `beam_eye_tracker_client.dll` from the `beam_eye_tracker_sdk-2.x.x\bin\win64` directory to your project’s output directory.

   > Note

   > For Visual Studio: Add it to the project (`Add > Existing Item`), then set `Properties > Copy to Output Directory` to `Copy always`.

4. Add the using directive in your code:

       using Eyeware.BeamEyeTracker;

Unity

Note

A ready to use Unity package is available. See Unity Package Installation for more information.

Now that you have the SDK integrated into your project, you can continue to the next section to get a general explanation of how the API is structured.

Overview
General API concepts