15 releases

0.12.1 Dec 9, 2022
0.12.0 Aug 18, 2022
0.11.7 Aug 18, 2022
0.11.5 Mar 5, 2022
0.9.2 Jul 21, 2015

#63 in Unix APIs

Download history 2693/week @ 2023-12-11 2618/week @ 2023-12-18 1103/week @ 2023-12-25 1178/week @ 2024-01-01 2261/week @ 2024-01-08 3348/week @ 2024-01-15 2393/week @ 2024-01-22 2417/week @ 2024-01-29 2481/week @ 2024-02-05 1780/week @ 2024-02-12 2654/week @ 2024-02-19 2831/week @ 2024-02-26 3288/week @ 2024-03-04 3449/week @ 2024-03-11 3311/week @ 2024-03-18 2906/week @ 2024-03-25

13,171 downloads per month
Used in 34 crates (33 directly)

Apache-2.0 OR MIT

170KB
4K SLoC

evdev

GitHub Workflow Status Crates.io

Documentation

Nice(r) access to evdev devices.

What is evdev?

evdev is the Linux kernel's generic input interface, also implemented by other kernels such as FreeBSD.

libevdev is a userspace library written in c for interacting with this system in a high level way rather than using ioctl system calls directly.

This crate is a re-implementation of libevdev in rust. There is some trickery involved, so please read the crate documentation.

There is also an alternative crate: evdev-rs which wraps libevdev instead.

Overview

This crate provides functionality for reading streams of events from input devices.

Like libevdev, this crate also provides functionality for interacting with uinput. Uinput is a kernel module which allows virtual input devices to be created from userspace.

Synchronization

This library exposes raw evdev events, but uses the Rust Iterator trait to do so. When processing events via fetch_events, the library will handle SYN_DROPPED events by injecting fake state updates in an attempt to ensure callers see state transition messages consistent with actual device state. When processing via *_no_sync this correction is not done, and SYN_DROPPED messages will appear if the kernel ring buffer is overrun before messages are read. I try to match libevdev closely, where possible.

Limitations

There is no abstraction for gamepad-like devices that allows mapping button numbers to logical buttons, nor is one planned. Such a thing should take place in a higher-level crate, likely supporting multiple platforms.

Example

Plenty of nice examples of how to use this crate can be found in the examples directory of this repository. If you feel like an example of how to use a certain part of the evdev crate is missing, then feel free to open a pull request.

A good introduction is the evtest.rs example (which roughly corresponds to the userspace evtest tool.

Releases

Detailed release notes are available in this repository at CHANGELOG.md.

Dependencies

~3–13MB
~150K SLoC