Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos lcdproc: module for lcdd/lcdproc #39137

Merged
merged 1 commit into from Apr 28, 2018
Merged

Conversation

peterhoeg
Copy link
Member

Motivation for this change

A basic module for reporting system info on an attached LCD.

The client and server parts are split up to allow it to run properly over the network.

I only have access to one piece of hardware so I cannot say how/if it will work with others.

The USB group handling is not very pretty in case the user selects a group that doesn't exist.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-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/)
  • Fits CONTRIBUTING.md.

usbVid = mkOption {
type = str;
default = "";
description = "The vendor ID of the USB device to claim.";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful for end-users if a command was added that shows how to figure out these usb ids.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - added. I've also just come to the realization that writing docbook by hand is nasty....

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the wiki we have some hints to improve editor setups: https://nixos.wiki/wiki/Docbook_Editor_Configuration

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would not help in this case though.

Set group-write permissions on a USB device.
</para>
<para>
A USB connected LCD panel will most likely require having its permissions modified for lcdd to write to it. Enabling this option sets group-write permissions on the device identified by <option>services.hardware.lcd.usbVid</option> and <option>services.hardware.lcd.usbPid</option>. In order to find the values, you can run the <command>lsusb</command> command. Example output:</para><para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: Can you add line breaks here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants