cyme_win

Windows USB hotplug monitor based on cyme, simple and easy to use.

Installation

pip install cyme_win

Quick Start

import cyme_win

# Download cyme.exe (first time only)
cyme_win.download_cyme()

# Simple callback - one line to monitor USB hotplug
cyme_win.watch(lambda d: print(f"{d['event']}: {d['name']} ({d['vid_pid']})"))

import time
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    pass

Device Info

The callback receives a dict with these fields:

Examples

Example 1: Distinguish connect/disconnect events

import cyme_win

def on_device(d):
    symbol = "+" if d["event"] == "connect" else "-"
    print(f"[{symbol}] {d['name']}")
    print(f"    VID/PID: {d['vid_pid']}")
    print(f"    Location: {d['location']}")

cyme_win.watch(on_device)

import time
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    print("Stopped")

Example 2: Monitor specific devices

import cyme_win

def on_storage(d):
    # Only monitor mass storage devices
    if d.get("device_class") == "mass-storage":
        print(f"USB Drive {d['event']}: {d['name']}")
        print(f"  Serial: {d['serial']}")
        print(f"  Speed: {d['speed']}")

cyme_win.watch(on_storage)

Example 3: Using class API (multiple callbacks)

import cyme_win

def log_device(d):
    with open("usb_log.txt", "a") as f:
        f.write(f"{d['event']} | {d['name']} | {d['vid_pid']}\n")

def notify(d):
    print(f"Notify: {d['event']} - {d['name']}")

# Create monitor, add multiple callbacks
monitor = cyme_win.USBMonitor()
monitor.add_callback(log_device)
monitor.add_callback(notify)
monitor.start()

import time
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    monitor.stop()

Example 4: Using context manager

import cyme_win

with cyme_win.USBMonitor().add_callback(lambda d: print(d)):
    print("Monitoring... Press Ctrl+C to exit")
    import time
    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        pass

Example 5: Get full device info

import cyme_win

def show_details(d):
    print(f"\n{'='*50}")
    print(f"Event: {d['event']}")
    print(f"Name: {d['name']}")
    print(f"VID:PID: {d['vid_pid']}")
    print(f"Manufacturer: {d['manufacturer']}")
    print(f"Serial: {d['serial']}")
    print(f"Speed: {d['speed']}")
    print(f"Location: {d['location']} (bus {d['bus']}, port {d['port']})")
    print(f"Class: {d['device_class']}")
    print(f"{'='*50}\n")

cyme_win.watch(show_details)

import time
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    pass

API Reference

download_cyme(target_dir=None)

Download cyme.exe to specified directory (default: current working directory).

cyme_win.download_cyme()  # Current directory
cyme_win.download_cyme("E:/my_project")  # Specified directory

watch(callback, cyme_path=None)

Global singleton mode, simplest way to use.

# Auto-find cyme.exe
cyme_win.watch(lambda d: print(d))

# Specify cyme.exe path
cyme_win.watch(lambda d: print(d), cyme_path="E:/tools/cyme.exe")

stop()

Stop global monitoring.

cyme_win.stop()

USBMonitor class

# Auto-find cyme.exe
monitor = cyme_win.USBMonitor()

# Specify cyme.exe path
monitor = cyme_win.USBMonitor(cyme_path="E:/tools/cyme.exe")

Links

• cyme project: https://github.com/tuna-f1sh/cyme
• cyme releases: https://github.com/tuna-f1sh/cyme/releases

License

MIT