Skip to content
HID-IO Library and Daemon
Rust Python Cap'n Proto Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
examples
misc/images
python
spec
src
.gitignore
Cargo.toml
LICENSE
README.md
build.rs
hid-io.service
hidio.plist
logo.png
schema
uninstall_service.bat
vt.sh

README.md

hid-io core

HID-IO Client Side Library and Daemon

Overview

Linux Status macOS Status Windows Status Doc Status Total alerts Language grade: Python

Visit our IRC channel

API Documentation

Getting

Currently you have to build the HID-IO daemon yourself. But it will be made available in binary form once we are ready for a public beta.

Usage

hid-io
hid-io --help

RPC Terminal Example

cargo run --example rpc

Dependencies

  • Rust nightly (may relax over time)
  • capnproto >= 0.7.0

i686-pc-windows-gnu Dependencies

  • make must be path

Building

cargo build

Testing

RUST_LOG=hid_io=info RUST_BACKTRACE=1 cargo run

Inspecting rawhid traffic:

sudo usbhid-dump -m 308f:0013 -es sudo usbhid-dump -m 1c11:b04d -es -t 0 -i 5

Running Unit Tests

cargo test

Supported Keyboard Firmware

Contributing

  • Please run cargo test before submitting a pull-request

  • Travis will fail any commits that do not pass all tests

Debugging

echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope rust-gdb target/debug/hid-io -p $(pidof hid-io)

Packaging

cargo build --release --target "x86_64-pc-windows-gnu"

Linux systemd service

cp hid-io.service /etc/systemd/system systemctl daemon-reload systemctl enable --now hid-io

Windows service

install_service.exe sc start hid-io sc stop hid-io sc query hid-io

OSX service

cp hidio.plist ~/Library/LaunchAgents launchctl -w ~/Library/LaunchAgents/hidio.plist

You can’t perform that action at this time.