Packaging Request: Tuxedo Control Center

[blitz]

Project description

Tuxedo is a German laptop manufacturer that provides Linux-friendly laptops. Their system control is done via an app called "Tuxedo Control Center" (TCC). This open source app provides fan control settings among other things. Without this app, the Tuxedo laptops default to very noisy fan control settings. It lives on Github.

Besides the source, Tuxedo provides binary packages for Ubuntu and OpenSUSE.

TCC consists of:

• a set of systemd services implemented in Javascript,
• an Electron GUI application to control everything.

Metadata

• homepage URL: https://www.tuxedocomputers.com/en/TUXEDO-Control-Center.tuxedo
• source URL: https://github.com/tuxedocomputers/tuxedo-control-center
• license: GPL3
• platforms: Linux

[nixos-discourse]

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/packaging-the-tuxedo-control-center-electron/14326/2

[Artturin]

i'll take a shot at this

[Artturin]

builds and launches but complains about

/bin/sh: prime-select: command not found
/bin/sh: prime-supported: command not found

which are provided by a fedora only package

will also need a module as tccd service is needed

{ lib
, stdenv
, makeWrapper
, fetchurl
, rpmextract
, autoPatchelfHook
, alsa-lib
, cups
, gdk-pixbuf
, glib
, gtk3
, libnotify
, libuuid
, libX11
, libXScrnSaver
, libXcomposite
, libXcursor
, libXdamage
, libXext
, libXfixes
, libXi
, libXrandr
, libXrender
, libXtst
, libxcb
, libxshmfence
, mesa
, nspr
, nss
, pango
, systemd
, libappindicator-gtk3
, libdbusmenu

}:

stdenv.mkDerivation rec {
  pname = "tuxedo-control-center";
  version = "1.0.14";

  src = fetchurl {
    url = "https://rpm.tuxedocomputers.com/opensuse/15.2/x86_64/tuxedo-control-center_${version}.rpm";
    sha256 = "1fhcxf6jdb2b79pkyjxz6l78m8gbzlv0swncys6r17i08y2vv8d1";
  };


  nativeBuildInputs = [
    rpmextract
    makeWrapper
    alsa-lib
    autoPatchelfHook
    cups
    libXdamage
    libX11
    libXScrnSaver
    libXtst
    libxshmfence
    mesa
    nss
    libXrender
    gdk-pixbuf
    gtk3
  ];

  libPath = lib.makeLibraryPath [
    alsa-lib
    gdk-pixbuf
    glib
    gtk3
    libnotify
    libX11
    libXcomposite
    libuuid
    libXcursor
    libXdamage
    libXext
    libXfixes
    libXi
    libXrandr
    libXrender
    libXtst
    nspr
    nss
    libxcb
    pango
    systemd
    libXScrnSaver
    libappindicator-gtk3
    libdbusmenu
  ];

  unpackPhase = ''
    mkdir -p $out/bin
    cd $out
    rpmextract $src
  '';

  installPhase = ''
    runHook preInstall

    wrapProgram $out/opt/${pname}/${pname} \
        --prefix LD_LIBRARY_PATH : ${libPath}:$out/opt/${pname}

    ln -s $out/opt/${pname}/${pname} $out/bin/

    runHook postInstall
  '';


  meta = with lib; {
    description = "A tool to help you control performance, energy, fan and comfort settings on TUXEDO laptops.";
    homepage = "github.com/tuxedocomputers/tuxedo-control-center";
    license = licenses.gpl3Only;
    maintainers = with maintainers; [ ];
  };
}

used the discord expression for reference

[blitz]

Awesome! I think this is an excellent first step. If I have some time, I'll try to get the systemd services running, but I don't mind if anyone beats me to it. :)

[blitz]

@Artturin patchelf seems to cause issues with tccd. I'm hitting this issue: vercel/pkg#321. I've tried to get around patching the binary by adding all dependencies to the LD_LIBRARY_PATH of the wrapper, but this results in weird glibc errors. So I currently assume to package tccd we need a hack like this one.

I wonder this hack can be avoided by building everything from source.

[blitz]

Btw, looking at the code, the prime-select errors are somehwat harmless and probably just prevent nVidia PRIME configuration from working.

[jakefwoods]

Not sure if it's helpful but I had this packaged privately a while ago and working for my clevo-based laptop:

• module: https://github.com/Vodurden/devbox/blob/f06f565286e069ec5c58c222c97e37f0f7c5b551/nix/modules/nixos/tuxedo-control-center.nix
• tuxedo-cc-wmi: https://github.com/Vodurden/devbox/blob/f06f565286e069ec5c58c222c97e37f0f7c5b551/nix/pkgs/tuxedo-cc-wmi/default.nix
• tuxedo-control-center: https://github.com/Vodurden/devbox/blob/f06f565286e069ec5c58c222c97e37f0f7c5b551/nix/pkgs/tuxedo-control-center/default.nix

Using the module looked like this:

  services.tuxedo-control-center = {
    enable = true;
    acProfile = "NixOS";
    batteryProfile = "NixOS";
    profiles."NixOS" = {
      cpuGovernor = "powersave";
      cpuEnergyPerformancePreference = "balance_performance";
      fanProfile = "Silent";
    };
  };

I'm not willing to submit it upstream since I no longer use the module and I think tuxedo control center has been re-organised since I wrote the package, but I figure this might help someone in building a new derivation :)

[blitz]

@Vodurden Oh wow. Very nice! This is very helpful. I'm going to give this a go with the new TCC version. I'm also happy to maintain this once its in nixpkgs.

[blitz]

I started working on this in https://github.com/blitz/nixpkgs/tree/tuxedo-control-center

Still to go:

• updating TCC to the most recent version,
• integrating the module from @Vodurden

[blitz]

TCC is updated to 1.0.14 in my branch (latest version). This leaves the module.

[blitz]

I've added the module. So I think we are "code complete" here. I'll have access to a Tuxedo laptop in 2 weeks to test. If someone wants to check it out in the meantime, rebuild your NixOS with https://github.com/blitz/nixpkgs/tree/tuxedo-control-center and enable hardware.tuxedo-control-center.enable = true;