IRKeybridge

Transform any IR remote into a wireless keyboard controller

---

What is IRKeybridge?

IRKeybridge lets you use any IR remote control as a wireless remote for your PC. Perfect for gaming, media control, or any application where you need quick access to keyboard shortcuts without reaching for your keyboard.

Created to add flexible controls for BeamNG.Drive racing without spending a single dollar more!

Key Features

• Universal Remote Support: Works with most TV remotes
• Low Latency: Responsive enough for real-time gaming
• Dual Interface: GUI + CLI Tool
• Profiles: Save configurations for different remotes/games
• (pretty) Easy Setup: Learn IR codes directly from your remote

---

Quick Setup

Hardware Requirements

• Arduino Uno/Nano (or compatible)
• IR Receiver (TSOP4838, VS1838B, or similar)
• Any IR remote control
• USB 2.0 Cable Type A/B

Software Installation

git clone https://github.com/yourusername/IRKeybridge.git
cd IRKeybridge
pip install -r requirements.txt

Flash Arduino Firmware

1. Upload the provided Arduino sketch to your microcontroller
2. Connect IR receiver to your Arduino
3. Note the COM port in Device Manager

Run the Application

# GUI Mode (Recommended for first-time setup)
python run_app.py --gui

# CLI Mode
python run_app.py --cli

# Quick start with interactive setup
python run_app.py

---

Usage Examples

Gaming

Map your TV remote buttons to game controls:

• Volume Up/Down: Volume Up/Volume Down
• Channel Up/Down: Camera angles
• Play/Pause: Play/Pause
• Arrow Keys: Menu navigation
• Number Pad: Type Numbers

---

Interface Options

GUI Mode

• Visual IR Learning: Point remote, press button, assign action
• Profile Manager: Create and switch between remote configurations
• Serial Monitor: Real-time Arduino communication
• System Settings: Configure all options in one place

CLI Mode

# List available profiles
python run_app.py --cli --list-profiles

# Load specific profile
python run_app.py --cli --profile my_remote.json

# Enable special modes
python run_app.py --cli --enable-ghost --enable-tap

# Create executable
pyinstaller --onefile --noconsole run_app.py

---

Configuration

Profile Structure

{
    "name": "Gaming Remote",
    "brand": "Samsung TV",
    "mappings": {
        "FF": {
            "action_type": "single",
            "keys": "space",
            "description": "Jump"
        },
        "AA": {
            "action_type": "combo", 
            "keys": ["ctrl", "shift", "r"],
            "description": "Quick Restart"
        }
    }
}

Action Types

• Single Key: space, enter, f1
• Key Combinations: ["ctrl", "c"], ["alt", "tab"]
• Key Sequences: Multiple actions in order
• Special Actions: System commands, macros

---

Testing & Development

Run Tests

# Full test suite
python run_app.py --test

# Coverage report
python run_app.py --coverage

# Debug mode
python run_app.py --cli --debug --verbose

Code Formatting

black src/ tests/

Test Coverage: >80% with comprehensive unit, integration, and GUI tests.

---

Troubleshooting

No Serial Connection: Check COM port, try different USB cable IR Codes Not Received: Verify firmware upload, check IR receiver wiring Keys Not Working: Confirm profile mappings, try Ghost Key mode GUI Won't Start: Install PyQt5, check Python 3.8+

Debug Mode: python run_app.py --cli --debug for detailed logging.

Create Standalone Executable

pip install pyinstaller
pyinstaller --onefile --noconsole --name="IRKeybridge" run_app.py

Stop the background service via Task Manager or your configured stop button.

License

This project is open source under the MIT License. See LICENSE file for details.

---