HenRick69 commited on
Commit
60c685d
β€’
1 Parent(s): 5b0b374

Update README

Browse files
Files changed (1) hide show
  1. README.md +68 -2
README.md CHANGED
@@ -1,6 +1,6 @@
1
  ---
2
  title: Hands-free Cursor
3
- emoji: πŸŒ–
4
  colorFrom: red
5
  colorTo: pink
6
  sdk: gradio
@@ -10,4 +10,70 @@ pinned: false
10
  license: apache-2.0
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Hands-free Cursor
3
+ emoji: πŸ‘€
4
  colorFrom: red
5
  colorTo: pink
6
  sdk: gradio
 
10
  license: apache-2.0
11
  ---
12
 
13
+ <p align="center">
14
+ <a href="VERSION" alt="version">
15
+ <img src="https://img.shields.io/badge/version-0.0.0-lightgray" /></a>
16
+ <a href="LICENSE" alt="License">
17
+ <img src="https://img.shields.io/badge/license-Apache_2.0-blue" /></a>
18
+ <a href="PLATFORM" alt="Platform">
19
+ <img src="https://img.shields.io/badge/platform-linux--64,_macOS,_windows-red" /></a>
20
+ <a href="CONTRIBUTORS" alt="Contributors">
21
+ <img src="https://img.shields.io/badge/contributors-2-brightgreen" /></a>
22
+ </p>
23
+
24
+ # Hands-free Cursor Application
25
+
26
+ 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.
27
+
28
+ For more information, you can visit the project's [GitHub repository](https://github.com/HenryAreiza/hands-free_cursor).
29
+
30
+
31
+ ## Table of Contents
32
+
33
+ - [Hands-free Cursor Application](#hands-free-cursor-application)
34
+ - [Table of Contents](#table-of-contents)
35
+ - [Usage](#usage)
36
+ - [Cursor movement controller](#cursor-movement-controller)
37
+ - [Speech commands recognition](#speech-commands-recognition)
38
+ - [Authors](#authors)
39
+ - [License](#license)
40
+
41
+ ## Usage
42
+
43
+ ### Cursor movement controller
44
+ 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:
45
+
46
+ | <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"> |
47
+ |:--:|:--:|:--:|
48
+ | *Center* | *Up* | *Left/Up* |
49
+
50
+ | <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"> |
51
+ |:--:|:--:|:--:|
52
+ | *Left* | *Left/Down* | *Down* |
53
+
54
+ | <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"> |
55
+ |:--:|:--:|:--:|
56
+ | *Right/Down* | *Right* | *Right/Up* |
57
+
58
+ ### Speech commands recognition
59
+ Here are the available voice commands and their corresponding actions:
60
+ - **"left"**: Performs a left mouse click.
61
+ - **"right"**: Performs a right mouse click.
62
+ - **"up"** or **"down"**: Scrolls the mouse wheel up or down, respectively.
63
+ - **"go"**: Performs a double left mouse click.
64
+ - **"follow"**: Initiates a sustained left mouse click (release by - repeating the command).
65
+ - **"on"**: Activates the functionality for cursor movement controlled by head position.
66
+ - **"off"**: Deactivates the functionality for cursor movement controlled by head position.
67
+ - **"one"**, **"two"**, **"three"**: Adjusts the cursor speed (and scroll step) to slow, medium, or fast, respectively.
68
+ - **"stop"**: Exits the program and terminates the application.
69
+
70
+ ## Authors
71
+ - [HenryAreiza](https://github.com/HenryAreiza)
72
+ - [deividbotina-alv](https://github.com/deividbotina-alv)
73
+
74
+ ## License
75
+ This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details.
76
+
77
+
78
+
79
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference