Package request: `logiops`

[kylechui]

Project description

Logiops is a replacement for Logitech Options that allows users to configure the extra buttons/gestures functionality on certain Logitech mice (i.e. MX Master series).

Metadata

• homepage URL: https://github.com/PixlOne/logiops
• source URL: https://github.com/PixlOne/logiops
• license: GPL v3
• platforms: Linux

[kylechui]

For those that are also new to Nix, here's how I set it up for myself:

Details

{ pkgs, ... }:

{
  # Install logiops package
  environment.systemPackages = [ pkgs.logiops ];

  # Create systemd service
  systemd.services.logiops = {
    description = "An unofficial userspace driver for HID++ Logitech devices";
    serviceConfig = {
      Type = "simple";
      ExecStart = "${pkgs.logiops}/bin/logid";
    };
  };

  # Configuration for logiops
  environment.etc."logid.cfg".text = ''
    devices: ({
      name: "Wireless Mouse MX Master 3";
      smartshift: {
        on: true;
        threshold: 12;
      };
      hiresscroll: {
        hires: true;
        target: false;
      };
      dpi: 1200;
      buttons: ({
        cid: 0xc3;
        action = {
          type: "Gestures";
          gestures: ({
            direction: "Left";
            mode: "OnRelease";
            action = {
              type = "Keypress";
              keys: ["KEY_F15"];
            };
          }, {
            direction: "Right";
            mode: "OnRelease";
            action = {
              type = "Keypress";
              keys: ["KEY_F16"];
            };
          }, {
            direction: "Down";
            mode: "OnRelease";
            action = {
              type: "Keypress";
              keys: ["KEY_F17"];
            };
          }, {
            direction: "Up";
            mode: "OnRelease";
            action = {
              type: "Keypress";
              keys: ["KEY_F18"];
            };
          }, {
            direction: "None";
            mode: "OnRelease";
            action = {
              type = "Keypress";
              keys: ["KEY_PLAYPAUSE"];
            };
          });
        };
      }, {
        cid: 0xc4;
        action = {
          type: "Keypress";
          keys: ["KEY_F19"];
        };
      });
    });
  '';
}

[koenhendriks]

Thanks @kylechui

I've got my setup from your example and everything works but only if I manually run the binary using

sudo /run/current-system/sw/bin/logid

It doesn't seem to start at boot or after a rebuild.

My config

# Logiops settings
  systemd.services.logiops = {
    description = "An unofficial userspace driver for HID++ Logitech devices";
    serviceConfig = {
      Type = "simple";
      ExecStart = "${pkgs.logiops}/bin/logid";
    };
  };

  # Configuration for logiops
   environment.etc."logid.cfg".text = ''
    devices: (
    {
        name: "Wireless Mouse MX Master 3";

        buttons: (
            {
                cid: 0xc3;
                action =
                {
                    type: "Gestures";
                    gestures: (
                        {
                            direction: "Right";
                            mode: "OnRelease";
                            action =
                            {
                                type: "Keypress";
                                keys: ["KEY_LEFTMETA", "KEY_LEFTCTRL", "KEY_RIGHT"];
                            };
                        },
                        { 
                            direction: "Left";
                            mode: "OnRelease";
                            action =
                            {
                                type: "Keypress";
                                keys: ["KEY_LEFTMETA","KEY_LEFTCTRL", "KEY_LEFT"];
                            };
                        },
                        { 
                            direction: "None";
                            mode: "OnRelease";
                            action =
                            {
                                type: "Keypress";
                                keys: ["KEY_LEFTMETA","KEY_W"];
                            };
                        }
                    );
                };
            },
        );
    }
    );
    '';

Am I missing something?

[kylechui]

Uhh I don't see anything immediately wrong, but here's the current version of my configuration

[mnpqraven]

To anyone using a Bolt receiver (e.g. MX Master 3S) mouse and stumbled upon this PR, you will need to make a few additions to make it work.

• apply a patch from Bolt receiver support patch PixlOne/logiops#460 to fix some nasty timeout bug with bolt adapters, you can do this with a patch overlay like down below
• add logiops to the system packages, i don't know why but without this my service always exits instantly.

Down below is my configuration, the systemd targets are different from @kylechui but i was just copying from the source repo and don't see any difference

nix file

{ pkgs, ... }:
{
nixpkgs.overlays = [
 (final: prev: {
   logiops = prev.logiops.overrideAttrs (old: {
     patches = (old.patches or [ ]) ++ [
       (prev.fetchpatch {
         url = "https://github.com/PixlOne/logiops/commit/91aa0c12175f33a4184ccaf41181b0a799f7cc55.patch";
         hash = "sha256-A+StDD+Dp7lPWVpuYR9JR5RuvwPU/5h50B0lY8Qu7nY=";
       })
     ];
   });
 })
];

environment.systemPackages = with pkgs; [
 logiops
];

# Create systemd service
# https://github.com/PixlOne/logiops/blob/5547f52cadd2322261b9fbdf445e954b49dfbe21/src/logid/logid.service.in
systemd.services.logiops = {
 description = "Logitech Configuration Daemon";
 startLimitIntervalSec = 0;
 after = [ "multi-user.target" ];
 wantedBy = [ "graphical.target" ];
 wants = [ "multi-user.target" ];
 serviceConfig = {
   Type = "simple";
   ExecStart = "${pkgs.logiops}/bin/logid -v -c /etc/logid.cfg";
   User = "root";
 };
};

# Add a `udev` rule to restart `logiops` when the mouse is connected
# https://github.com/PixlOne/logiops/issues/239#issuecomment-1044122412
services.udev.extraRules = ''
 ACTION=="change", SUBSYSTEM=="power_supply", ATTRS{manufacturer}=="Logitech", ATTRS{model_name}=="MX Master 3S", RUN{program}="${pkgs.systemd}/bin/systemctl --no-block try-restart logiops.service"
'';

# Configuration for logiops
environment.etc."logid.cfg".text = ''
 devices: ({
     name: "MX Master 3S";
     dpi: 1000;
     smartshift:
     {
         on: true;
         threshold: 5;
         torque: 8;
     };
     hiresscroll:
     {
         hires: false;
         invert: false;
         target: false;
     };
     thumbwheel:
     {
         divert: true;
         left: {
             mode: "OnInterval";
             interval: 3;
             direction: "Left";
             action =
             {
                 type: "Keypress";
                 keys: ["KEY_LEFT"];
             };
         },
         right: {
             mode: "OnInterval";
             interval: 3;
             direction: "Right";
             action =
             {
                 type: "Keypress";
                 keys: ["KEY_RIGHT"];
             };
         }
     }
     buttons: (
     {
         cid: 0xc3;
         action =
         {
             type: "Gestures";
             gestures: (
             {
                 direction: "Up";
                 mode: "OnRelease";
                 action =
                 {
                     type: "None";
                };
             },
             {
                 direction: "Down";
                 mode: "OnRelease";
                 action =
                 {
                     type: "None";
                 };
                 },
             {
                 direction: "Left";
                 mode: "OnRelease";
                 action =
                 {
                     type: "Keypress";
                     keys: ["KEY_LEFTCTRL", "KEY_C"];
                 }
                 },
             {
                 direction: "Right";
                 mode: "OnRelease";
                 action =
                 {
                     type: "Keypress";
                     keys: ["KEY_LEFTCTRL", "KEY_V"];
                 }
                 },
             {
                 direction: "None"
                 mode: "OnRelease";
                 action =
                 {
                     type: "Keypress";
                     keys: ["KEY_ENTER"];
                 }
             });
         };
     },
     {
         cid: 0xc4;
         action =
         {
             type: "ToggleSmartshift";
         };
     },
     {
         cid: 0x56;
         action =
         {
             type: "Keypress";
             keys: ["KEY_PAGEUP"]
         }
     },
     {
         cid: 0x53;
         action =
         {
             type: "Keypress";
             keys: ["KEY_PAGEDOWN"]
         }
     });
 });
'';
}

[nixpkgs-ci]

Thank you for your interest in packaging new software in Nixpkgs. Unfortunately, to mitigate the unsustainable growth of unmaintained packages, Nixpkgs is no longer accepting package requests via Issues.

As a volunteer community, we are always open to new contributors. If you wish to see this package in Nixpkgs, we encourage you to contribute it yourself, via a Pull Request. Anyone can become a package maintainer! You can find language-specific packaging information in the Nixpkgs Manual. Should you need any help, please reach out to the community on Matrix or Discourse.