Skip to content

Update README.md #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 34 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,86 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />


# [Project Name] 🎯
# Snap Shield 🎯


## Basic Details
### Team Name: [Name]
### Team Name: Pixel pada


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Alphin - MACE
- Member 2: Anuranj -MACE

### Project Description
[2-3 lines about what your project does]
Snap shield is a comedic yet functional eye-closure detection system that uses AI to watch your eyelids. If you blink too often or keep your eyes shut for too long, it blasts a song and turns off an LED through an ESP32 — perfect for turning naps into dramatic events.

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
Sometimes, when you accidentally fall asleep, nothing fun happens. You just… sleep. That’s boring.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
We use AI-powered eyelid tracking to detect suspicious sleep attempts and instantly launch a wake-up concert, complete with LED theatrics. Your naps will never be peaceful again.

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
Languages: Python, Arduino C++
Frameworks: MediaPipe, OpenCV
Libraries: mediapipe, opencv-python, pygame, pyserial, scipy
Tools: Arduino IDE, Python 3.x

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]
Controller: ESP32 WROOM Board
Output Device: LED (with resistor)
Power Supply: USB (5V)
Other Tools: Breadboard, jumper wires

### Implementation
For Software:
# Installation
[commands]
pip install opencv-python mediapipe pygame pyserial scipy

# Run
[commands]
python blink_beats.py

Comment on lines 39 to +45
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix heading levels and add code fences for install/run (MD001).

Headings jump levels and commands aren’t fenced; this hurts readability and violates markdownlint MD001.

-For Software:
-# Installation
-pip install opencv-python mediapipe pygame pyserial scipy
-
-# Run
-python blink_beats.py
+#### Software
+##### Installation
+```bash
+pip install opencv-python mediapipe pygame pyserial scipy
+```
+
+##### Run
+```bash
+python blink_beats.py
+```
🤖 Prompt for AI Agents 
In README.md around lines 39 to 45, the heading levels are inconsistent and the
installation and run commands lack proper code fences, reducing readability and
violating markdownlint MD001. Fix this by adjusting the heading levels to follow
a proper hierarchy and enclosing the pip install and python run commands within
triple backtick code fences labeled with "bash" to clearly format them as shell
commands.


### Project Documentation
For Software:

# Screenshots (Add at least 3)
Comment on lines 47 to 50
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Unify documentation headings under a consistent hierarchy.

“Project Documentation” (H3) should contain H4/H5 children; several child sections are H1s. This aligns with MD001 and improves TOC rendering.

-### Project Documentation
-For Software:
-
-# Screenshots (Add at least 3)
+### Project Documentation
+#### Software
+
+#### Screenshots (at least 3)
 
-# Diagrams
+#### Diagrams
 
-# Schematic & Circuit
+##### Schematic & Circuit
@@
-# Build Photos
+##### Build Photos
@@
-### Project Demo
+## Project Demo

Also applies to: 57-57, 62-66, 73-73

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

47-47: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents 
In README.md around lines 47 to 50, the heading "Project Documentation" is an H3
but its child sections are incorrectly marked as H1, breaking the heading
hierarchy. Change the child section headings under "Project Documentation" to H4
or H5 to maintain a consistent and proper markdown heading structure. Apply
similar fixes to lines 57, 62-66, and 73 to ensure all nested sections follow
the correct heading levels.

![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
[Real-time eyelid tracking using MediaPipe.](https://github.com/a-nuranj/anuranj/blob/main/Sleepy%20Detector%2009-08-2025%2005_02_31.png)

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
[Detection triggered after 3 rapid closures.](https://github.com/a-nuranj/anuranj/blob/main/Screenshot%202025-08-09%20050531.png)

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
[Song plays and LED turns off when sleep detected.](https://github.com/a-nuranj/anuranj/blob/main/Screenshot%202025-08-09%20050611.png)

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*
Snap shield workflow: Eye detection → Blink count logic → Song trigger → ESP32 LED control.

For Hardware:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*
https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg
Connections between ESP32, LED, resistor, and GND.
Comment on lines +63 to +64
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Avoid bare URL and embed schematic image (MD034).

Also add a clear caption.

-https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg
-Connections between ESP32, LED, resistor, and GND.
+![Schematic: ESP32, LED, resistor, GND connections](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
+Connections between ESP32, LED, resistor, and GND.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg
Connections between ESP32, LED, resistor, and GND.
![Schematic: ESP32, LED, resistor, GND connections](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
Connections between ESP32, LED, resistor, and GND.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

63-63: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md around lines 63 to 64, replace the bare URL of the schematic image
with an embedded image using markdown syntax. Add a clear, descriptive caption
below the image to explain what it shows, specifically the connections between
the ESP32, LED, resistor, and GND. This will improve readability and comply with
markdown best practices.


# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
[LED](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.19.09_6af1bd64.jpg)
[Resistor](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.19.10_dc262e0a.jpg)
[esp32 WROOM](http://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.19.10_af895e05.jpg)

![Build](Add photos of build process here)
*Explain the build steps*

![Final](Add photo of final product here)
*Explain the final build*
!Final](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix malformed image syntax; also avoid bare URL (MD034).

Missing opening bracket after the exclamation mark breaks rendering.

-!Final](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
+![Final](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
!Final](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
![Final](https://github.com/a-nuranj/anuranj/blob/main/WhatsApp%20Image%202025-08-09%20at%2005.10.22_b8beafa9.jpg)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

71-71: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md at line 71, the image markdown syntax is malformed because it lacks
the opening bracket after the exclamation mark. Fix this by adding the missing
opening bracket so the image syntax is properly formatted as ![Alt text](URL).
This will correct the rendering issue and comply with markdown standards.


### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*

(https://www.youtube.com/watch?v=FN2iBmGGBCI)
when eye blink for 3 times music starts to play and led turns off . If eye opens led turns ON and music stops playing.
# Additional Demos
[Add any extra demo materials/links]
[https://www.youtube.com/watch?v=g2KgJIACXjU]
when eye closed for more than 10sec , music starts to play and led gets turned off
Comment on lines 73 to +79
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Normalize heading level; fix bare URLs and grammar (MD001, MD034).

  • Make “Project Demo” an H2 (expected by linter).
  • Use descriptive links; fix bracket-only link at Line 78.
  • Improve sentence casing.
-### Project Demo
-# Video
-(https://www.youtube.com/watch?v=FN2iBmGGBCI)
-when eye blink for 3 times music starts to play and led turns off . If eye opens led turns ON and music stops playing.
-# Additional Demos
-[https://www.youtube.com/watch?v=g2KgJIACXjU]
-when eye closed for more than 10sec , music starts to play and led gets turned off 
+## Project Demo
+### Video
+[YouTube: Snap Shield Demo](https://www.youtube.com/watch?v=FN2iBmGGBCI)
+When eyes blink 3 times rapidly, music starts playing and the LED turns off. When eyes open, the LED turns on and the music stops.
+### Additional Demos
+[YouTube: Extended demo](https://www.youtube.com/watch?v=g2KgJIACXjU)
+When eyes remain closed for more than 10 seconds, music starts playing and the LED turns off.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
(https://www.youtube.com/watch?v=FN2iBmGGBCI)
when eye blink for 3 times music starts to play and led turns off . If eye opens led turns ON and music stops playing.
# Additional Demos
[Add any extra demo materials/links]
[https://www.youtube.com/watch?v=g2KgJIACXjU]
when eye closed for more than 10sec , music starts to play and led gets turned off
## Project Demo
### Video
[YouTube: Snap Shield Demo](https://www.youtube.com/watch?v=FN2iBmGGBCI)
When eyes blink 3 times rapidly, music starts playing and the LED turns off. When eyes open, the LED turns on and the music stops.
### Additional Demos
[YouTube: Extended demo](https://www.youtube.com/watch?v=g2KgJIACXjU)
When eyes remain closed for more than 10 seconds, music starts playing and the LED turns off.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

73-73: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

75-75: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In README.md around lines 73 to 79, the "Project Demo" heading should be changed
to an H2 for consistency with markdown linting rules. Replace bare URLs with
descriptive markdown links to improve readability and fix the bracket-only link
at line 78 by adding link text. Also, correct the grammar and sentence casing in
the demo descriptions to follow proper sentence case conventions.


## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
Anuranj-hardware,documentation
Alphin-coding,documentation

---
Made with ❤️ at TinkerHub Useless Projects
Expand Down