bitbox-bridge: add systemd service and udev rule for linux distributions #391415

izelnakri · 2025-03-20T00:37:46Z

Things done

Add udev rule to enable computer <> device communication.
Add a systemd service.

In the next PR(not this one), I plan to create nixos module to introduce programs.bitbox-bridge.enable and services.bitbox-bridge.enable with few options. These changes in this PR I suspect is needed for all linux distributions other than NixOS that allows users to install bitbox-bridge via nix or home-manager.

Built on platform(s)
- x86_64-linux
- aarch64-linux
- x86_64-darwin
- aarch64-darwin
Tested basic functionality of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

izelnakri · 2025-03-20T20:21:24Z

@SuperSandro2000 @HeitorAugustoLN @ethancedwards8 @JohnRTitor This PR is ready for a review, afterwards I plan to create another PR where I'll add services.bitbox-bridge functionality for:

services.bitbox-bridge.enable
services.bitbox-bridge.port
services.bitbox-bridge.runOnMount

Thus I appreciate if we could review/merge this PR as early as possible, at your convenience ;)

HeitorAugustoLN · 2025-03-20T20:24:02Z

pkgs/by-name/bi/bitbox-bridge/package.nix

@@ -34,6 +34,13 @@ rustPlatform.buildRustPackage (finalAttrs: {
    libudev-zero
  ];

+  postInstall = lib.optionals stdenv.hostPlatform.isLinux ''


Suggested change

postInstall = lib.optionals stdenv.hostPlatform.isLinux ''

postInstall = lib.optionalString stdenv.hostPlatform.isLinux ''

@HeitorAugustoLN changes made, thanks for pointing it out! ;)

JohnRTitor · 2025-03-21T17:14:08Z

pkgs/by-name/bi/bitbox-bridge/package.nix

@@ -34,6 +34,13 @@ rustPlatform.buildRustPackage (finalAttrs: {
    libudev-zero
  ];

+  postInstall = lib.optionalString stdenv.hostPlatform.isLinux ''
+    mkdir -p $out/lib/systemd/user
+    substitute ${./bitbox-bridge.service} $out/lib/systemd/user/bitbox-bridge.service \


Installing systemd service manually is a bad idea. Please use the module system. systemd.user.services suboptions should be what you are looking for.

Another option would be is to use the upstream systemd service file and patch it during postPatch.

https://github.com/BitBoxSwiss/bitbox-bridge/blob/63385207a0fb37f9bd7f0ff351214981a9b76d75/bitbox-bridge/release/linux/bitbox-bridge.service

Installing systemd service manually is a bad idea. Please use the module system. systemd.user.services suboptions should be what you are looking for.

I'm planning to do this as I mentioned in a separate PR. This PR adds this functionality for the ones who don't use NixOS. What would be your specific solution for implementing this functionality with systemd.user.services for people who don't use NixOS(archlinux with home-manager or MacOS etc.) How would that solution look like specifically?

This PR adds this functionality for the ones who don't use NixOS

I suppose you are right, but instead of having the same copy in two places, we can just copy the upstream one at install time, see below.

JohnRTitor · 2025-03-21T17:15:01Z

pkgs/by-name/bi/bitbox-bridge/package.nix

+    mkdir -p $out/lib/systemd/user
+    substitute ${./bitbox-bridge.service} $out/lib/systemd/user/bitbox-bridge.service \
+      --subst-var-by bitbox-bridge $out/bin/bitbox-bridge
+    install -Dt $out/lib/udev/rules.d ${./rules.d}/*


De we have to maintain the udev rules ourselves, on Nixpkgs? Does upstream not provide these in their repo?

EDIT: Looks like we can copy these from the src. https://github.com/BitBoxSwiss/bitbox-bridge/blob/63385207a0fb37f9bd7f0ff351214981a9b76d75/bitbox-bridge/release/linux/hid-digitalbitbox.rules

I wasn't sure how to copy it from the src in nix. What would be the specific reference in nix for the .rules file here?

Perhaps something like this?

https://github.com/JohnRTitor/nixpkgs/blob/f7d7dea5d6d953214ec01e073e959532af7869cd/pkgs/applications/system/coolercontrol/coolercontrol-liqctld.nix#L25

And do it for both systemd and udev rules.

@JohnRTitor done, thanks for the reference!

JohnRTitor · 2025-03-22T14:55:16Z

pkgs/by-name/bi/bitbox-bridge/package.nix

+  postInstall = lib.optionalString stdenv.hostPlatform.isLinux ''
+    mkdir -p $out/lib/systemd/user
+    substitute ${src}/bitbox-bridge/release/linux/bitbox-bridge.service $out/lib/systemd/user/bitbox-bridge.service \
+      --replace /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge


Suggested change

--replace /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge

--replace-fail /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge

HeitorAugustoLN · 2025-03-22T18:07:00Z

pkgs/by-name/bi/bitbox-bridge/package.nix

+    substitute ${src}/bitbox-bridge/release/linux/bitbox-bridge.service $out/lib/systemd/user/bitbox-bridge.service \
+      --replace-fail /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge
+    install -Dm644 ${src}/bitbox-bridge/release/linux/hid-digitalbitbox.rules $out/lib/udev/rules.d/50-hid-digitalbitbox.rules


Why not just this instead?

Suggested change

substitute ${src}/bitbox-bridge/release/linux/bitbox-bridge.service $out/lib/systemd/user/bitbox-bridge.service \

--replace-fail /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge

install -Dm644 ${src}/bitbox-bridge/release/linux/hid-digitalbitbox.rules $out/lib/udev/rules.d/50-hid-digitalbitbox.rules

substitute bitbox-bridge/release/linux/bitbox-bridge.service $out/lib/systemd/user/bitbox-bridge.service \

--replace-fail /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge

install -Dm644 bitbox-bridge/release/linux/hid-digitalbitbox.rules $out/lib/udev/rules.d/50-hid-digitalbitbox.rules

Ahh ok I'll try this then we might be able to remove the rec as well

HeitorAugustoLN · 2025-03-22T18:10:32Z

pkgs/by-name/bi/bitbox-bridge/package.nix

@@ -7,7 +7,7 @@
  libudev-zero,
 }:

-rustPlatform.buildRustPackage (finalAttrs: {
+rustPlatform.buildRustPackage (finalAttrs: rec {


There is no need for rec while using finalAttrs

Suggested change

rustPlatform.buildRustPackage (finalAttrs: rec {

rustPlatform.buildRustPackage (finalAttrs: {

Nope, the rec is required for the src reference below.

finalAttrs.src does the same, and it is also not needed, you can operate on the $src directly without needing to reference its derivation

JohnRTitor · 2025-03-22T20:02:53Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 391415

`x86_64-linux`

✅ 1 package built:

bitbox-bridge

github-project-automation bot added this to CUDA Team Mar 20, 2025

github-project-automation bot moved this to New in CUDA Team Mar 20, 2025

github-actions bot added 8.has: documentation This PR adds or changes documentation 6.topic: policy discussion Discuss policies to work in and around Nixpkgs labels Mar 20, 2025

izelnakri force-pushed the package-bitbox-bridge branch from d0ba5fd to f8093d7 Compare March 20, 2025 00:38

nix-owners bot requested a review from tensor5 March 20, 2025 00:46

HeitorAugustoLN reviewed Mar 20, 2025

View reviewed changes

izelnakri force-pushed the package-bitbox-bridge branch from f8093d7 to 9ab4423 Compare March 20, 2025 20:35

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Mar 20, 2025

izelnakri force-pushed the package-bitbox-bridge branch from 9ab4423 to d5b0ef3 Compare March 20, 2025 20:40

JohnRTitor reviewed Mar 21, 2025

View reviewed changes

izelnakri force-pushed the package-bitbox-bridge branch from d5b0ef3 to d20f551 Compare March 22, 2025 14:20

JohnRTitor reviewed Mar 22, 2025

View reviewed changes

JohnRTitor removed the 6.topic: policy discussion Discuss policies to work in and around Nixpkgs label Mar 22, 2025

izelnakri force-pushed the package-bitbox-bridge branch from d20f551 to f1c281e Compare March 22, 2025 17:55

HeitorAugustoLN reviewed Mar 22, 2025

View reviewed changes

bitbox-bridge: add systemd service & udev rule for linux distros

da388d3

izelnakri force-pushed the package-bitbox-bridge branch from f1c281e to da388d3 Compare March 22, 2025 18:36

JohnRTitor merged commit 593a86b into NixOS:master Mar 22, 2025
26 of 27 checks passed

github-project-automation bot moved this from New to ✅ Done in CUDA Team Mar 22, 2025

izelnakri mentioned this pull request Mar 24, 2025

nixos/bitbox-bridge: init #392817

Merged

6 tasks

	postInstall = lib.optionals stdenv.hostPlatform.isLinux ''
	postInstall = lib.optionalString stdenv.hostPlatform.isLinux ''

	--replace /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge
	--replace-fail /opt/bitbox-bridge/bin/bitbox-bridge $out/bin/bitbox-bridge

	rustPlatform.buildRustPackage (finalAttrs: rec {
	rustPlatform.buildRustPackage (finalAttrs: {

Uh oh!

bitbox-bridge: add systemd service and udev rule for linux distributions #391415

bitbox-bridge: add systemd service and udev rule for linux distributions #391415

Uh oh!

Conversation

izelnakri commented Mar 20, 2025

Things done

Uh oh!

izelnakri commented Mar 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JohnRTitor Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

izelnakri Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JohnRTitor commented Mar 22, 2025

nixpkgs-review result

x86_64-linux

Uh oh!

Uh oh!

Uh oh!

JohnRTitor Mar 21, 2025 •

edited

Loading

izelnakri Mar 21, 2025 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux`