Lib.rs

› Hardware support
#color #cli #x11 #logitech #cli-command #command-line-tool #g213

bin+lib g213_colours

A utility to set the G213 keyboard backlight. Based on https://github.com/SebiTimeWaster/G213Colors.

Owned by shahzadnaeem.

10 releases

0.3.6 Mar 30, 2024
0.3.4 Apr 17, 2023
0.2.2 Apr 11, 2023
0.1.0 Apr 11, 2023

#153 in Hardware support

MIT license

41KB
895 lines

Logitech G213 Keyboard USB Backlight Utility

Crates.io Build Status MIT licensed

Introduction

A Rust version of G213Colors

See Commands section below for supported commands.

The last successful command is saved to ~/.g213-cols.json. This will be used if g213-cols is subsequently called with no arguments. This allows the state of the keyboard to be quickly restored.

Installing

As g213-cols needs to be run as root to control the G213 keyboard via USB, the following steps need to be followed to install it correctly.

You will need to ensure you have set up sudo access for some of the following commands.

  • Step 1 - Installing - standard cargo install

    • cargo install g213_colours will install g213-cols in ~/.cargo/bin
      • Development
        • Clone the github repository and change directory to it
        • cargo install --path .

  • Step 2 - Creating a setuid root version

    • NOTE: g213-cols must be copied to and run from a different location. Otherwise further cargo install steps may fail.
    • Copy the above g213-cols binary to a location in your PATH - eg ~/bin
      • sudo cp ~/.cargo/bin/g213-cols ~/bin
      • sudo strip ~/bin/g213-cols
      • sudo chown root.root ~/bin/g213-cols
      • sudo chmod u+s ~/bin/g213-cols - now this command will run as root

Commands

See X11 colour names for all supported colour names - eg alice blue, lawn green, DarkCyan etc.

Choosing an invalid colour will result in RED being used. You can also use 'random' for a random colour.

Command
Set whole keyboard colour
g213-cols colour sets the default 'white'
g213-cols colour ffff00 sets the specified hex colour, eg yellow
NOTE: 3 digit hex colour conversion - 1af -> 11aaff
g213-cols colour lawn green sets the named X11 colour
g213-cols colour "alice blue" sets the named X11 colour - as a single argument
g213-cols colour dark_slate_blue sets the named X11 colour - underscores become spaces
g213-cols colour random sets a random colour
Set the colour of a specific keyboard region - 1 to 5
g213-cols region 2 [colour] sets the region to the [colour] as defined above
Set the colours of all 5 keyboard regions
g213-cols regions [colour colour ...] sets the regions to the [colours] as defined above
last supplied colour is repeated to set all 5 regions
Set 'breathe' mode
g213-cols breathe 1000 [colour] sets the breathe time (in ms) for the [colour]
Set 'cycle' mode
g213-cols cycle 1000 sets the cycle time (in ms) all colours
Use last successful saved command
g213-cols Runs the last successful saved command from ~/.g213-cols.json
Show saved command
g213-cols saved Display the last successful saved command
Show keyboard info
g213-cols info Show USB info for keyboard
List X11 colours
g213-cols list [name] Show X11 colours that contain optional [name] or all colours

Abbreviations

Command Abbreviation
colour c
region r
regions rs
breathe b
cycle cy
saved s
info i
list l
help h or ?

Todo

  • Help is terrible - but it's all here

Ideas - for others 😄

  • Support other Logitech keyboards
  • Support other manufacturers

Dependencies

~2–13MB
~116K SLoC