Skip to main content

Overview

The Windows Interaction Sensor application captures and processes user interactions, including data collection and task management. This guide will walk you through the steps to set up, configure, and run the application.


System Requirements

  • OS: Windows 10 or higher
  • Python Version: 3.12.x
  • Conda: For managing Python environments
  • Git (optional): For cloning the repository
  • Windows Steps Recorder (PSR.exe): Required for capturing interactions

Setup Instructions

Step 1: Install Miniconda

  1. If you don’t have Miniconda installed, download and install it from:
    Miniconda: https://docs.conda.io/en/latest/miniconda.html

  2. Open Anaconda Prompt and run this command to add Conda to your PATH:

    conda init cmd.exe

Step 2: Create a Conda Environment

  1. Navigate to the Application Root:
    Before setting up the project, make sure you're in the directory where the environment.yml is located (the project root). Use the cd command to navigate there:

    cd path/to/windows-interaction-sensor

    Replace path/to/windows-interaction-sensor with the actual path to your project folder.

  2. Create the Conda Environment:
    Create the Conda environment using the environment.yml file:

    conda env create -f environment.yml

Step 3: Activate and Verify Setup

  1. Activate the Conda Environment:
    After creating the Conda environment, activate it to ensure all the installed dependencies are available:

    conda activate win_sensor
  2. Verify Installation:
    Once the environment is activated, you can verify that everything is installed properly by listing the installed packages:

    conda list

    This will display all installed dependencies within the win_sensor environment.


Running the Application

Once the setup is complete, you can run the application using the following steps:

Step 1: Activate the Conda Environment

 conda activate win_sensor

Step 2: Navigate to the Application Directory

You need to navigate to the app directory where the main application script is located. If you're in the root project directory, run the following command:

cd path/to/windows-interaction-sensor/app

Replace path/to/windows-interaction-sensor with the actual path to your project folder.

Step 3: Run the Application

Once inside the app directory, run the following command to start the application:

python main.py

This will start the application and begin monitoring user interactions.

Step 4: Stopping the Application

To stop the application, press Ctrl + C in the terminal window where the application is running.
This will stop any ongoing tasks and end the user session.