diff --git a/LICENSE b/LICENSE index ef751b2..91ff35d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Keith T. Garner +Copyright (c) 2019-2020 Keith T. Garner Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e6dc9bd..d568f5b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -# BlULd - The Blinkstick User space LED daemon +# bluld - The Blinkstick user space LED daemon The [Blinkstick](https://www.blinkstick.com) family of products are "Smart LED controllers with integrated USB -firmware." They register as USB HID devices so Linux doesn't recognize them as part of the LED class. This daemon will -use the Linux user space LED driver to bridge the gap. +firmware." They register as USB HID devices so Linux doesn't recognize them as part of the LED class. This daemon uses +the Linux user space LED driver to bridge the gap. I use it to bring some "blinking lights" to x86-based router devices running [OpenWRT](https://openwrt.org), -such as the [Protectli](https://protectli.com/6-port/), but it should be generic enough for any Linux machine. +such as the [Protectli](https://protectli.com/6-port/), but it is generic enough for any Linux machine. ## Using `bluld` makes the assumption that only one blinkstick device is connected. At launch time you must give it the number of LEDs on your Blinkstick as well as the colors you would like them to be. You can use friendly color names, or pass a hex -value that MUST be prepented with `#`. (A list of friendly colors that bluld knows is at the bottom of this README.) +value that MUST be prepented with `#`. (A list of friendly colors that bluld knows is at the bottom of this README.) In +the event that blulb cannot understand the color value passed, it will default to red. Example: @@ -19,7 +20,7 @@ Example: # bluld 5 aqua indigo olive yellow #010203 ``` -When `bluld` is running, you should see an entry for each LED in `/sys/class/leds` named `blinkstick:` where +When `bluld` is running, you will see an entry for each LED in `/sys/class/leds` named `blinkstick:` where number is the number of the led, as in `blinkstick:2`. From there, you can use the Blinkstick LEDs like any other registered LED. diff --git a/blinkstick-userspace-led-daemon/include/blinkstick_userspace_led_daemon/RGBColor.hpp b/blinkstick-userspace-led-daemon/include/blinkstick_userspace_led_daemon/RGBColor.hpp index 7a5fd30..f2306b8 100644 --- a/blinkstick-userspace-led-daemon/include/blinkstick_userspace_led_daemon/RGBColor.hpp +++ b/blinkstick-userspace-led-daemon/include/blinkstick_userspace_led_daemon/RGBColor.hpp @@ -1,7 +1,7 @@ // MIT License // -// Copyright (c) 2019 Keith T. Garner +// Copyright (c) 2019-2020 Keith T. Garner // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal diff --git a/blinkstick-userspace-led-daemon/src/BluldRunner.cpp b/blinkstick-userspace-led-daemon/src/BluldRunner.cpp index 185b97a..ab62f9b 100644 --- a/blinkstick-userspace-led-daemon/src/BluldRunner.cpp +++ b/blinkstick-userspace-led-daemon/src/BluldRunner.cpp @@ -1,6 +1,6 @@ // MIT License // -// Copyright (c) 2019 Keith T. Garner +// Copyright (c) 2019-2020 Keith T. Garner // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal diff --git a/blinkstick-userspace-led-daemon/src/RGBColor.cpp b/blinkstick-userspace-led-daemon/src/RGBColor.cpp index 199814f..215677d 100644 --- a/blinkstick-userspace-led-daemon/src/RGBColor.cpp +++ b/blinkstick-userspace-led-daemon/src/RGBColor.cpp @@ -1,7 +1,7 @@ // MIT License // -// Copyright (c) 2019 Keith T. Garner +// Copyright (c) 2019-2020 Keith T. Garner // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal