Skip to content

Commit

Permalink
update readme and copyrights
Browse files Browse the repository at this point in the history
  • Loading branch information
ktgeek committed May 15, 2021
1 parent 8c865a6 commit e869c05
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
# 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:

```
# 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:<number>` where
When `bluld` is running, you will see an entry for each LED in `/sys/class/leds` named `blinkstick:<number>` 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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion blinkstick-userspace-led-daemon/src/BluldRunner.cpp
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion blinkstick-userspace-led-daemon/src/RGBColor.cpp
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit e869c05

Please sign in to comment.