An unofficial userspace driver for HID++ Logitech devices
Go to file
2024-09-29 15:43:38 +03:00
.github Fix make-release github action 2023-05-04 01:13:04 -04:00
src Fix CVE-2024-45752 2024-09-27 20:43:01 -04:00
.editorconfig add .editorconfig to ease contribution by external devs 2022-01-05 12:53:55 +02:00
.gitignore Added mutex to devices to avoid cuncurrency issues 2019-09-13 11:21:26 -03:00
.gitmodules Change ipcgull submodule upstream url to http protocol 2023-05-04 01:07:36 +08:00
CMakeLists.txt Use NDEBUG for None build type 2023-07-12 14:08:59 -04:00
LICENSE Initial commit 2019-07-09 13:58:10 -04:00
logid.example.cfg Merge a74d0938df into 628ab937a2 2024-09-29 15:43:38 +03:00
README.md Merge a74d0938df into 628ab937a2 2024-09-29 15:43:38 +03:00
TESTED.md Update TESTED.md 2024-03-04 13:17:30 +01:00

LogiOps

Build Status

This is an unofficial driver for Logitech mice and keyboard.

This is currently only compatible with HID++ >2.0 devices.

Configuration

Refer to the wiki for details.

You may also refer to logid.example.cfg for an example.

Default location for the configuration file is /etc/logid.cfg, but another can be specified using the -c flag.

Dependencies

This project requires a C++20 compiler, cmake, libevdev, libudev, glib, and libconfig. For popular distributions, I've included commands below.

Arch Linux: sudo pacman -S base-devel cmake libevdev libconfig systemd-libs glib2

Debian/Ubuntu: sudo apt install build-essential cmake pkg-config libevdev-dev libudev-dev libconfig++-dev libglib2.0-dev

Fedora: sudo dnf install cmake libevdev-devel systemd-devel libconfig-devel gcc-c++ glib2-devel

Gentoo Linux: sudo emerge dev-libs/libconfig dev-libs/libevdev dev-libs/glib dev-util/cmake virtual/libudev

Solus: sudo eopkg install cmake libevdev-devel libconfig-devel libgudev-devel glib2-devel

openSUSE: sudo zypper install cmake libevdev-devel systemd-devel libconfig-devel gcc-c++ libconfig++-devel libudev-devel glib2-devel

Initial setup

A critical item is to determine the name your device reports to the computer which will placed in the name field of the configuration file.

Build logid and from the repository root run it (use Ctrl+C to stop logid). You should see something like the following:

$ sudo ./build/logid
[ERROR] I/O Error while reading /etc/logid.cfg: FileIOException
[INFO] Device MX Anywhere 3 not configured, using default config.
[INFO] Device found: MX Anywhere 3 on /dev/hidraw3:255
^C

Next, create a configuration file that contains the name, MX Anywhere 3, of the device determined from executing logid above. A starting point is logid.example.cfg, located in the root of the repo. And copy it to /etc/logid.cfg, the default configuration location:

sudo cp ./logid.example.cfg /etc/logid.cfg

Now edit /etc/logid.cfg referring to the Configuration section of the wiki for details. At a minimum change the name field to match above. Such name: "MX Anywhere 3", here is the diff:

$ diff -u1 logid.example.cfg /etc/logid.cfg
--- logid.example.cfg   2022-04-26 10:41:59.650418368 -0700
+++ /etc/logid.cfg      2022-04-26 10:47:49.033924388 -0700
@@ -4,3 +4,3 @@
     #   https://github.com/PixlOne/logiops/wiki/Configuration#name
-    name: "Wireless Mouse MX Master";
+    name: "MX Anywhere 3";
     smartshift:

Next verify that your configuration is used. Run logid again and this time you should not have [ERROR] I/O Error while reading /etc/logid.cfg: FileIOException. And instead should it look something like:

$ sudo ./build/logid
[INFO] Device found: MX Anywhere 3 on /dev/hidraw3:255
[WARN] /dev/hidraw3:255: SmartShift feature not found, cannot use ToggleSmartShift action.
[WARN] MX Anywhere 3: CID 0xc3 does not exist.
^C

The two [WARN] lines indicate tweaks maybe needed to your configuration file.

Now install logid and use systemctl so it runs as a daemon.

Building

To build this project, run:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make

Install

To install, run sudo make install after building. You can set the daemon to start at boot by running sudo systemctl enable logid or sudo systemctl enable --now logid if you want to enable and start the daemon.

Development

The project may only run as root, but for development purposes, you may find it convenient to run as non-root on the user bus. You must compile with the CMake flag -DUSE_USER_BUS=ON to use the user bus.

Donate

This program is (and will always be) provided free of charge. If you would like to support the development of this project by donating, you can donate to my Ko-Fi below.

Buy Me a Coffee at ko-fi.com

I'm also looking for contributors to help in my project; feel free to submit a pull request or e-mail me if you would like to contribute.

Compatible Devices

For a list of tested devices, check TESTED.md

Credits

Logitech, Logi, and their logos are trademarks or registered trademarks of Logitech Europe S.A. and/or its affiliates in the United States and/or other countries. This software is an independent product that is not endorsed or created by Logitech.

Thanks to the following people for contributing to this repository.