makcu-rs

Fast and modular communication interface over serial ports. Built with performance and async-first in mind.

FASTEST EVER MAKCU LIB

🚦 Performance Comparison

Features

• ✅ Fast and lightweight sync/async communication via serialport and tokio-serial
• 🧠 Built-in command tracking with optional response timeout
• 🔧 Mouse movement, button presses, scroll wheel, and lock state support
• 🧪 Optional mock serial interface for testing (mockserial feature)
• 📈 Optional built-in performance profiler (profile feature)
• 🧵 Thread-safe, lock-free write queue (via crossbeam-channel)
• 🔋 Minimal dependencies & portable

📦 Installation

Add this to your Cargo.toml:

[dependencies]
makcu-rs = "0.1"

Or with optional features:

makcu-rs = { version = "0.1", features = ["async", "mockserial", "profile"] }

🚀 Quick Start

Sync (threaded) example

use makcu_rs::{Device, MouseButton};
use std::time::Duration;

fn main() -> anyhow::Result<()> {
    let dev = Device::new("/dev/ttyUSB0", 115200, Duration::from_millis(100));
    dev.connect()?;

    dev.move_rel(100, 0)?;
    dev.click(MouseButton::Left)?;
    dev.wheel(-2)?;

    dev.disconnect();
    Ok(())
}

Async version

#[tokio::main]
async fn main() -> std::io::Result<()> {
    use makcu_rs::{DeviceAsync, MouseButton};

    let dev = DeviceAsync::new("/dev/ttyUSB0", 115200).await?;

    dev.move_rel(50, 0).await?;
    dev.click(MouseButton::Right).await?;
    dev.wheel(1).await?;

    Ok(())
}

🧰 Features

Enable with:

cargo build --features "profile mockserial"

🔎 Tracked Commands

Send a command and wait for a response with a timeout:

let response = dev.set_serial("ABC123")?;
println!("Response: {response}");

🔄 Batch Commands

dev.batch()
    .move_rel(100, 20)
    .click(MouseButton::Left)
    .wheel(-1)
    .run()?;

📊 Profiler (Optional)

If the profile feature is enabled, collect per-operation timing:

let stats = makcu_rs::Device::profiler_stats();
dbg!(stats);

🧪 Testing with Mock Serial

To simulate serial behavior during development:

[features]
mockserial = []

📚 Documentation

• API Docs on docs.rs
• Repository on GitHub

🪪 License

Licensed under either of:

• MIT License
• Apache License 2.0

🇷🇺 makcu-rs

Быстрый и модульный интерфейс работы с COM-портами. С поддержкой трекинга, асинхронности и пакетных команд.

Основные возможности

• ✨ Поддержка как синхронного, так и асинхронного (tokio) режима
• ⏱ Отправка команд с ожиданием ответа (с таймаутом)
• 🔘 Управление движением мыши, кнопками, прокруткой
• 📦 Пакетная отправка команд (batch API)
• 🧪 Тестируемый mockserial режим
• 🔍 Встроенный профайлер (опционально)

Быстрый пример (синхронный)

let dev = Device::new("COM3", 115200, Duration::from_millis(100));
dev.connect()?;
dev.click(MouseButton::Left)?;
dev.disconnect();

Быстрый пример (асинхронный)

let dev = DeviceAsync::new("COM3", 115200).await?;
dev.press(MouseButton::Middle).await?;

Лицензия

Проект распространяется под MIT или Apache 2.0 лицензией на ваш выбор.

🤝 Поддержка

Создавайте issue на GitHub или пишите автору: @whatzwasthere (TG/GitHub)

📦 Cargo Features Summary

💡 makcu-rs помогает удобно управлять внешними устройствами (мыши, трекпады, манипуляторы) через COM-порт, минимизируя задержки и повышая надёжность взаимодействия.