Tables and proper doxygen comments
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Jens True 2021-11-30 10:31:00 +00:00
parent 131450569f
commit 17040eeed4

121
main.c

@ -1,42 +1,45 @@
/**
ledcontroller-3bit
This file is a fork of the LedController code. You will find
the original copyright notice below.
Copyright (C) 2013 andmarios - http://www.andmarios.com
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Original Copyright Notice:
LedController
Copyright (C) 2011 jmrobles - http://robleshermoso.wordpress.com
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
* @file main.c
* ledcontroller-3bit
*
* This file is a fork of the LedController code. You will find
* the original copyright notice below.
*
* @copyright
* Copyright (C) 2013 andmarios - http://www.andmarios.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* @copyright
* Original Copyright Notice:
*
* LedController
* Copyright (C) 2011 jmrobles - http://robleshermoso.wordpress.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdio.h>
@ -44,28 +47,32 @@
#include <errno.h>
#include <string.h>
#define VID 0x1294
#define PID 0x1320
#define VID 0x1294 /**< USB Vendor ID */
#define PID 0x1320 /**< USB Product ID */
static struct libusb_device_handle *devh = NULL;
/**
The device has a RGB LED, which has two states for each "sub-LED",
on and off.
The "sub-LEDs" are red, green and blue.
Obviously there are 8 possible combinations for their state.
It seems there aren't bits mapped to each sub-LED, but instead
3-bit values mapped to the 8 combinations.
R G B Color Value
0 0 0 off 0x0
0 0 1 blue 0x1
1 0 0 red 0x2
0 1 0 green 0x3
0 1 1 aqua 0x4
1 0 1 purple 0x5
1 1 0 yellow 0x6 (more of a mustard - green color)
1 1 1 white 0x7 (a very blue-ish white)
* The device has a RGB LED, which has two states for each "sub-LED",
* on and off.
* The "sub-LEDs" are red, green and blue.
*
* Obviously there are 8 possible combinations for their state.
* It seems there aren't bits mapped to each sub-LED, but instead
* 3-bit values mapped to the 8 combinations.
*
* | R | G | B | Color | Value | Comment |
* | - | - | - | ------ | ----- | ------------------------------- |
* | 0 | 0 | 0 | off | 0x0 | |
* | 0 | 0 | 1 | blue | 0x1 | |
* | 1 | 0 | 0 | red | 0x2 | |
* | 0 | 1 | 0 | green | 0x3 | |
* | 0 | 1 | 1 | aqua | 0x4 | |
* | 1 | 0 | 1 | purple | 0x5 | |
* | 1 | 1 | 0 | yellow | 0x6 | more of a mustard - green color |
* | 1 | 1 | 1 | white | 0x7 | a very blue-ish white |
*
* @param argc POSIX number of parameters
* @param argv Array of parameters
*/
int main(int argc, char **argv) {
int ret;