corectl

CHICKEN egg for controlling LEDs on the project 0001 keyboard

git clone https://git.8pit.net/corectl.git

 1# corectl
 2
 3CHICKEN egg for controlling LEDs on the [project 0001][project 0001] keyboard.
 4
 5## Installation
 6
 7Requires [libusb-1.0][libusb website] to be installed. Afterwards just run:
 8
 9	$ chicken-install
10
11This should install both the `corectl` CHICKEN egg and the `corectl`
12command line tool.
13
14## Usage
15
16The command-line tool is inspired by the proprietary
17[`CoreController.exe`][core controller] and allows you to turn on/off or
18restore the original state of all six LEDs. Example usage:
19
20	$ corectl LED0:on LED2:off LED5:restore
21
22The CHICKEN egg can simply be imported from `csi(1)` and can be used to
23conveniently program the LEDs. As an example, take a look at the LED
24pattern generator in `contrib/led-pattern.scm`.
25
26## License
27
28This program is free software: you can redistribute it and/or modify it
29under the terms of the GNU General Public License as published by the
30Free Software Foundation, either version 3 of the License, or (at your
31option) any later version.
32
33This program is distributed in the hope that it will be useful, but
34WITHOUT ANY WARRANTY; without even the implied warranty of
35MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
36Public License for more details.
37
38You should have received a copy of the GNU General Public License along
39with this program. If not, see <http://www.gnu.org/licenses/>.
40
41[project 0001]: https://core-mechanics.com/produkt/project-0001/
42[libusb website]: https://libusb.info/
43[core controller]: https://penclic.se/wp-content/uploads/2020/09/Core-Mechanics-Project-0001-LED-control.txt