openrazer: init at 2.3.1 (driver, daemon, lib and NixOS module) #47009

roelvandijk · 2018-09-20T16:31:31Z

Motivation for this change

I want to disable the annoying 'breath' effect of my Razer Blackwidow 2016 keyboard.

Things done

Kernel drivers for talking to Razer products (keyboards, mice, etc.)
Daemon for talking to the kernel drivers.
Python library for talking to the daemon.
NixOS module hardware.openrazer which adds the kernel drivers and daemon to a system.

Enabled the NixOS module on my system. Tested with various Razer devices. Was able to successfully control the devices via the packaged python library.

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

cc @FRidh because of Python packages

basvandijk · 2018-09-20T21:42:25Z

pkgs/os-specific/linux/openrazer/driver.nix

+    description = "An entirely open source driver and user-space daemon that allows you to manage your Razer peripherals on GNU/Linux";
+    homepage = https://openrazer.github.io/;
+    license = stdenv.lib.licenses.gpl2;
+    maintainers = [ stdenv.maintainers.roelvandijk ];


This should be stdenv.lib.maintainers.roelvandijk (note the evaluation error reported by ofborg). Better yet place a with stdenv.lib; after the meta = so that you don't need to repeat yourself.

basvandijk · 2018-09-20T21:52:00Z

pkgs/os-specific/linux/openrazer/driver.nix

+let
+  openrazerSrc = import ./src.nix;
+
+  razermountPATH = stdenv.lib.makeBinPath [ coreutils ];


This doesn't seem to be used.

basvandijk · 2018-09-20T21:57:16Z

pkgs/os-specific/linux/openrazer/daemon.nix

+  sourceRoot = "source/daemon";
+  patches = [
+    # https://github.com/openrazer/openrazer/pull/681
+    ./openrazer_python_daemon_script.patch


Instead of storing the patches in nixpkgs you might be able to refer to them using:

(fetchpatch { url = https://github.com/openrazer/openrazer/commit/feefb86497af6ff7db827e682ae560c12d0aee2f.patch; sha256 = "..."; })

The patches from the pull requests are relative to the entire openrazer repository. The patches stored in nixpkgs are relative to the sourceRoot "source/daemon". We could of course take the patches from github and rewrite them to be relative to "daemon".

You can use the stripLen option of fetchpatch to strip of the "daemon/" prefix like:

(fetchpatch { url = https://github.com/openrazer/openrazer/commit/feefb86497af6ff7db827e682ae560c12d0aee2f.patch; sha256 = "..."; stripLen = 1; })

basvandijk

Looks pretty good. I wrote some minor issues and recommendations inline.

Kernel drivers for talking to Razer products (keyboards, mice, etc.) Daemon for talking to the kernel drivers. Python library for talking to the daemon. Adds NixOS module hardware.openrazer which adds the kernel drivers and daemon to a system.

basvandijk · 2018-09-21T08:29:02Z

@GrahamcOfBorg build linuxPackages.openrazer python3Packages.openrazer python3Packages.openrazer-daemon

GrahamcOfBorg · 2018-09-21T08:29:32Z

No attempt on x86_64-darwin (full log)

The following builds were skipped because they don't evaluate on x86_64-darwin: linuxPackages.openrazer, python3Packages.openrazer, python3Packages.openrazer-daemon

Partial log (click to expand)


a) For `nixos-rebuild` you can set
  { nixpkgs.config.allowUnsupportedSystem = true; }
in configuration.nix to override this.

b) For `nix-env`, `nix-build`, `nix-shell` or any other Nix command you can add
  { allowUnsupportedSystem = true; }
to ~/.config/nixpkgs/config.nix.

GrahamcOfBorg · 2018-09-21T08:30:42Z

Success on aarch64-linux (full log)

Attempted: linuxPackages.openrazer, python3Packages.openrazer, python3Packages.openrazer-daemon

Partial log (click to expand)

writing manifest file 'openrazer.egg-info/SOURCES.txt'
running build_ext

----------------------------------------------------------------------
Ran 0 tests in 0.000s

OK
/nix/store/0574z2wb4rm17xmz0mhjg8zwx31zjsp7-openrazer-2.3.1-4.14.71
/nix/store/8vg5l6r9flb1j0dykaglx8qzv651jidi-python3.6-openrazer-2.3.1
/nix/store/60qb6k9wjav06zzsc3lj487smr1bb467-openrazer_daemon-2.3.1

GrahamcOfBorg · 2018-09-21T08:30:43Z

Success on x86_64-linux (full log)

Attempted: linuxPackages.openrazer, python3Packages.openrazer, python3Packages.openrazer-daemon

Partial log (click to expand)

writing manifest file 'openrazer.egg-info/SOURCES.txt'
running build_ext

----------------------------------------------------------------------
Ran 0 tests in 0.000s

OK
/nix/store/6cplla4387falgc3in7jc8diahhfpp2g-openrazer-2.3.1-4.14.71
/nix/store/mzdpxlyrahfskcq1bmnlj3r7nniqw70h-python3.6-openrazer-2.3.1
/nix/store/lj3jjd69mi26wsnjjvvjqj8p8k5nclws-openrazer_daemon-2.3.1

roelvandijk · 2018-09-21T12:41:25Z

Note: there is a similar effort at https://github.com/lezed1/nixpkgs/commit/9b9cdf6d7e721657752b806e1e0df35bd2b02fd3 . It could be useful to compare both approaches.

lezed1 · 2018-09-21T13:03:55Z

@roelvandijk the biggest differences between ours I found on my phone was manually setting up service files vs using the ones that come from the repo. I'll look at it closer tonight.

basvandijk · 2018-09-28T09:25:43Z

@roelvandijk what about using @lezed1's trick of having a common.nix file instead of src.nix? This saves a bit of common code. I implemented this at:
LumiGuide/nixpkgs@feat-openrazer...LumiGuide:feat-openrazer-common

FRidh · 2018-11-04T10:24:29Z

pkgs/top-level/python-packages.nix

@@ -3545,6 +3545,9 @@ in {

  odfpy = callPackage ../development/python-modules/odfpy { };

+  openrazer        = callPackage ../os-specific/linux/openrazer/pylib.nix { };


The expressions need to move under pkgs/development/python-modules/*.
Also, fix indentation.

DanielFabian · 2019-04-15T17:53:29Z

What's the status on this? Is there anything I could do to help getting this merged?

evanjs · 2019-05-19T03:40:50Z

Also happy to help keep this one going.
As far as I can tell, the only hard blockers look like a merge conflict and moving the expressions in top-level/python-packages?

evanjs · 2019-06-14T02:38:23Z

Fixed (per @FRidh) and rebased but I can't push 😕
ERROR: Permission to LumiGuide/nixpkgs.git denied to evanjs.
Unless I'm doing something wrong

cawilliamson · 2019-06-24T15:44:49Z

@evanjs You wouldn't be able to push to LumiGuide's repo - my advice if @roelvandijk has gone radio silent on this (which considering the amount of time this PR has been active wouldn't surprise me) would be to create another PR with your changes and mention this PR number (#47009) in the new PR.

If you don't want to do that though I'm happy to take over this one since I just got a new Razer laptop myself and really need this merged ASAP.

evanjs · 2019-09-03T20:14:12Z

Resolved with #64552

jtojnar · 2019-09-03T20:15:45Z

Thanks.

roelvandijk requested a review from FRidh as a code owner September 20, 2018 16:31

GrahamcOfBorg added 6.topic: nixos 6.topic: python 8.has: module (update) labels Sep 20, 2018

basvandijk reviewed Sep 20, 2018

View reviewed changes

basvandijk self-requested a review September 20, 2018 21:59

basvandijk suggested changes Sep 20, 2018

View reviewed changes

roelvandijk force-pushed the feat-openrazer branch from 18aaf42 to 2c79fde Compare September 21, 2018 07:15

roelvandijk mentioned this pull request Sep 21, 2018

install openrazer-daemon script directly via setuptools openrazer/openrazer#681

Closed

GrahamcOfBorg added 8.has: package (new) 10.rebuild-darwin: 0 10.rebuild-linux: 11-100 labels Sep 21, 2018

roelvandijk force-pushed the feat-openrazer branch from 2c79fde to fa90486 Compare September 21, 2018 07:42

basvandijk approved these changes Sep 21, 2018

View reviewed changes

z3ntu mentioned this pull request Oct 28, 2018

Nixos support openrazer/openrazer#592

Closed

FRidh requested changes Nov 4, 2018

View reviewed changes

samueldr added the 2.status: merge conflict label Nov 11, 2018

evanjs mentioned this pull request Jul 10, 2019

openrazer: init at 2.6.0 #64552

Merged

10 tasks

jtojnar closed this Sep 3, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

openrazer: init at 2.3.1 (driver, daemon, lib and NixOS module) #47009

openrazer: init at 2.3.1 (driver, daemon, lib and NixOS module) #47009

roelvandijk commented Sep 20, 2018

basvandijk Sep 20, 2018

basvandijk Sep 20, 2018

basvandijk Sep 20, 2018

roelvandijk Sep 21, 2018 •

edited

basvandijk Sep 21, 2018

roelvandijk Sep 21, 2018

basvandijk left a comment

basvandijk commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

roelvandijk commented Sep 21, 2018

lezed1 commented Sep 21, 2018

basvandijk commented Sep 28, 2018

FRidh Nov 4, 2018

DanielFabian commented Apr 15, 2019

evanjs commented May 19, 2019

evanjs commented Jun 14, 2019

cawilliamson commented Jun 24, 2019

evanjs commented Sep 3, 2019

jtojnar commented Sep 3, 2019

		@@ -3545,6 +3545,9 @@ in {

		odfpy = callPackage ../development/python-modules/odfpy { };

		openrazer = callPackage ../os-specific/linux/openrazer/pylib.nix { };

openrazer: init at 2.3.1 (driver, daemon, lib and NixOS module) #47009

openrazer: init at 2.3.1 (driver, daemon, lib and NixOS module) #47009

Conversation

roelvandijk commented Sep 20, 2018

Motivation for this change

Things done

basvandijk Sep 20, 2018

Choose a reason for hiding this comment

basvandijk Sep 20, 2018

Choose a reason for hiding this comment

basvandijk Sep 20, 2018

Choose a reason for hiding this comment

roelvandijk Sep 21, 2018 • edited

Choose a reason for hiding this comment

basvandijk Sep 21, 2018

Choose a reason for hiding this comment

roelvandijk Sep 21, 2018

Choose a reason for hiding this comment

basvandijk left a comment

Choose a reason for hiding this comment

basvandijk commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

GrahamcOfBorg commented Sep 21, 2018

roelvandijk commented Sep 21, 2018

lezed1 commented Sep 21, 2018

basvandijk commented Sep 28, 2018

FRidh Nov 4, 2018

Choose a reason for hiding this comment

DanielFabian commented Apr 15, 2019

evanjs commented May 19, 2019

evanjs commented Jun 14, 2019

cawilliamson commented Jun 24, 2019

evanjs commented Sep 3, 2019

jtojnar commented Sep 3, 2019

roelvandijk Sep 21, 2018 •

edited