Skip to content

eikenb/udev-notify

Repository files navigation

Deprecated (Rewrite)

Please note that I'm no longer maintaining this project as I'm working on a rewrite using a new pattern and a native Go library.

Udev Device Connection Nofity/Trigger

A tool to watch for device Udev events, matching on a property and running a configured command. Designed to run as part of a user session, add it to your appropriate place for your window-manager or desktop.

GoDoc Build Status

Getting Started

Install the software. Via go get..

go get github.com/eikenb/udev-notify

Or download a release.

Say you want to run some xinput commands to configure your mouse when you plug it in. First you need to create a config rule for it, for which you need some information. To get this run udev-notify in watch mode and plug in your mouse.

udev-notify -w all
(plug in mouse)

It will spit out a list of properties for that device event. Note the SUBSYSTEM, ACTION and another property that would be unique among that type of subsystem, like the NAME or ID_MODEL. You write up the commands in a script and put it all in your config file.

An entry would look something like this..

[[Rules]]
Subsystem = "input"
Action    = "add"
PropName  = "ID_MODEL"
PropValue = "Kensington_Slimblade_Trackball"
Command   = "xinput-slimblade"

It searches for a TOML formatted config file passed on the command line or in $XDG_CONFIG_HOME/udev-notify/config.toml.

See the ./example-config.toml for the config file structure.

NOTE: By default XDG_CONFIG_HOME is set to ~/.config on most Linux systems.

NOTE: Udev can get triggered sometimes at odd times (docker seems to trigger some events). So it is best to try to make your commands idempotent.

Copyright

CC0; To the extent possible under law, John Eikenberry has waived all copyright and related or neighboring rights to this work. This work is published from: United States.

About

User Udev Connection Monitor/Trigger For Linux

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published