Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Copilot Physical Notifier

🇯🇵 日本語版はこちら

License: MIT Arduino Python Sponsor

GitHub Copilot Physical Notifier

A physical notification device that shakes a figurine's head and pulses an LED when GitHub Copilot enters a user-question-waiting state (ask_user).
Built with just an Arduino Nano, a servo motor, and an LED — anyone can assemble it with basic soldering skills and a 3D printer.

Quick Start with GitHub Copilot

  1. Clone this repository and open it in VS Code or your terminal
  2. Launch GitHub Copilot Chat or GitHub Copilot and type "Start building"
  3. GitHub Copilot will guide you through the build process

Quick Start by Human

Follow the Build Guide step by step.


Specs

Item Value
Microcontroller Arduino Nano (CH340, USB-C)
Communication USB Serial 9600 baud
Supported OS macOS / Linux / Windows
Estimated Cost Under $20 USD
Assembly Time Approx. 1 hour (excluding 3D print time)

Architecture

GitHub Copilot (preToolUse / postToolUse hook)
  → send_trigger.py (pyserial)
    → Arduino Nano (servo head-shake + LED breathing)
  • preToolUse hook detects ask_user → sends serial "1" → animation starts
  • postToolUse hook detects ask_user completion → sends serial "0" → animation stops

This project uses GitHub Copilot CLI Hooks. The same hook functionality is also available in VS Code Copilot Chat (Agent Mode) — see the official documentation.


Required Skills & Tools

Skills

Skill Level
Soldering Beginner (basic wire and LED connections)
Arduino IDE Basic (uploading sketches)
Python Basic (able to run pip install)
3D Printer Optional (outsourcing services also work)

Main Tools

Soldering iron set / Phillips screwdriver / Tweezers / Rubber adhesive

See BOM.md for the complete parts and tools list.


Repository Structure

├── README.md              ← This file
├── LICENSE                 ← MIT License
├── docs/
│   ├── BOM.md             … Parts & tools list
│   ├── HARDWARE.md        … Circuit diagram, wiring & assembly
│   ├── BUILD_GUIDE.md     … Step-by-step build guide
│   ├── GHC.md             … PC & GitHub Copilot setup
│   └── images/            … Documentation images
├── firmware/
│   └── firmware.ino       … Arduino firmware
├── models/                … 3D printable STL files
└── script/
    └── send_trigger.py    … Serial trigger script

⚠️ Safety Notice

  • Be careful of burns when soldering and work in a well-ventilated area
  • Do not look directly at the LED
  • This device is powered by USB 5V, so the risk of electric shock is low, but be careful of short circuits

Contributing

Issues and Pull Requests are welcome.


Credits

  • 3D Model: octoprints by Martin Woodward — source data for the character figurine
  • Libraries: pyserial, Arduino Servo library

License

This project is licensed under the MIT License.

Note: The character 3D models from octoprints are provided under the CC BY-NC 4.0 license and may not be used for commercial purposes. The MIT license of this repository does not apply to the octoprints model data.

About

Physical desk toy that wiggles and glows when GitHub Copilot needs your attention.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages