README.md

---
title: Hands-free Cursor
emoji: 👀
colorFrom: red
colorTo: pink
sdk: gradio
sdk_version: 3.43.2
app_file: app.py
pinned: false
license: apache-2.0
---

<p align="center">
    <a href="VERSION" alt="version">
        <img src="https://img.shields.io/badge/version-0.0.0-lightgray" /></a>    
    <a href="LICENSE" alt="License">
        <img src="https://img.shields.io/badge/license-Apache_2.0-blue" /></a>
    <a href="PLATFORM" alt="Platform">
        <img src="https://img.shields.io/badge/platform-linux--64,_macOS,_windows-red" /></a>  
    <a href="CONTRIBUTORS" alt="Contributors">
        <img src="https://img.shields.io/badge/contributors-2-brightgreen" /></a>                
</p>

# Hands-free Cursor Application

This HugginFace space represents a comprehensive application for controlling the computer's cursor and performing various mouse actions using voice commands and head position. This application is designed to provide hands-free control and enhance accessibility for users with motor disabilities.

For more information, you can visit the project's [GitHub repository](https://github.com/HenryAreiza/hands-free_cursor).


## Table of Contents

- [Hands-free Cursor Application](#hands-free-cursor-application)
  - [Table of Contents](#table-of-contents)
  - [Usage](#usage)
    - [Cursor movement controller](#cursor-movement-controller)
    - [Speech commands recognition](#speech-commands-recognition)
  - [Authors](#authors)
  - [License](#license)

## Usage

### Cursor movement controller
You can control the cursor movement with slight movements of your head in an intuitive way. The following images represent the different movements that the model can recognize:

| <img src="media/0.jpg" alt="Center" width="200" height="210"> | <img src="media/1.jpg" alt="Up" width="200" height="210"> | <img src="media/8.jpg" alt="Left/Up" width="200" height="210"> |
|:--:|:--:|:--:|
| *Center* | *Up* | *Left/Up* |

| <img src="media/7.jpg" alt="Left" width="200" height="210"> | <img src="media/6.jpg" alt="Left/Down" width="200" height="210"> | <img src="media/5.jpg" alt="Down" width="200" height="210"> |
|:--:|:--:|:--:|
| *Left* | *Left/Down* | *Down* |

| <img src="media/4.jpg" alt="Right/Down" width="200" height="210"> | <img src="media/3.jpg" alt="Right" width="200" height="210"> | <img src="media/2.jpg" alt="Right/Up" width="200" height="210"> |
|:--:|:--:|:--:|
| *Right/Down* | *Right* | *Right/Up* |

### Speech commands recognition
Here are the available voice commands and their corresponding actions:
- **"left"**: Performs a left mouse click.
- **"right"**: Performs a right mouse click.
- **"up"** or **"down"**: Scrolls the mouse wheel up or down, respectively.
- **"go"**: Performs a double left mouse click.
- **"follow"**: Initiates a sustained left mouse click (release by - repeating the command).
- **"on"**: Activates the functionality for cursor movement controlled by head position.
- **"off"**: Deactivates the functionality for cursor movement controlled by head position.
- **"one"**, **"two"**, **"three"**: Adjusts the cursor speed (and scroll step) to slow, medium, or fast, respectively.
- **"stop"**: Exits the program and terminates the application.

## Authors
- [HenryAreiza](https://github.com/HenryAreiza)
- [deividbotina-alv](https://github.com/deividbotina-alv)

## License
This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details.



Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference