S3 Removed

.drone.yml

@@ -1,18 +0,0 @@
-kind: pipeline
-name: default
-steps:
-  - name: build
-    image: gcc
-    commands:
-    - apt-get -y update
-    - apt-get -y install libusb-1.0
-    - make
-  - name: release
-    image: plugins/gitea-release
-    settings:
-      api_key: a7f3afc9f77e721951e48b4af66d7565700b7a2e
-      base_url: https://code.jcktrue.dk
-      files:
-        - ledcontroller
-    when:
-      event: tag

.gitignore

@@ -1,3 +1,4 @@
 *~
 *.swp
 ledcontroller
+docs/

.vscode/c_cpp_properties.json

@@ -0,0 +1,17 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "/usr/include/libusb-1.0"
+            ],
+            "defines": [],
+            "compilerPath": "/usr/bin/gcc",
+            "cStandard": "gnu17",
+            "cppStandard": "gnu++14",
+            "intelliSenseMode": "linux-gcc-x64"
+        }
+    ],
+    "version": 4
+}

.woodpecker.yml

@@ -0,0 +1,17 @@
+pipeline:
+  build:
+    image: gcc
+    commands:
+    - apt-get -y update
+    - apt-get -y install libusb-1.0
+    - make
+
+  check:
+    image: neszt/cppcheck-docker
+    commands:
+    - cppcheck *.c
+
+  docs:
+    image: corentinaltepe/doxygen
+    commands:
+    - doxygen

Doxyfile

@@ -0,0 +1,7 @@
+PROJECT_NAME     = "ledcontroller-3bit"
+OUTPUT_DIRECTORY = "docs/"
+INPUT            = "README.md" "main.c"
+RECURSIVE        = YES
+WARNINGS         = YES
+GENERATE_LATEX   = NO
+USE_MDFILE_AS_MAINPAGE = README.md

Makefile

@@ -1,9 +1,11 @@
-
-
 all: ledcontroller
 
 ledcontroller:  main.c
 	gcc -o $@ $^ `pkg-config libusb-1.0 --cflags --libs`
 
+docs:
+	doxygen
+
 clean:
-	rm ledcontroller
+	rm -f ledcontroller
+	rm -rf docs

README.md

@@ -7,12 +7,10 @@ A Linux command line utility to control usb mail notifiers identified as:
     Bus 001 Device 010: ID 1294:1320 RISO KAGAKU CORP.
 
 
-Inside the scripts folder you will find some simple bash scripts you can use to control the notifier.
-For example the script `mled-cputemp` will make it respond to your CPU's temperature.
-
 ### Get and compile: ###
 
     $ git clone https://github.com/andmarios/ledcontroller-3bit.git
+    $ sudo apt-get install libusb-1.0-0-dev build-essential pkg-config
     $ cd ledcontroller-3bit/
     $ make
 
@@ -33,7 +31,7 @@ For example the script `mled-cputemp` will make it respond to your CPU's tempera
 
 ## Requisites: ##
 
-+ libusb:1 or libusb-1.0-dev, depending on your distribution
++ libusb:1, libusb-1.0-dev or libusb-1.0-0-dev, depending on your distribution
 + a system which can compile binaries (package build-essentials for Debian based distributions)
 
 ## Hardware ##
@@ -42,7 +40,6 @@ I think [this is my notifier](http://www.andmarios.com/links/mail-usb-notifier)
 
 ---
 
-
 ## Copyright ##
 
 This code (files `main.c` and `Makefile`) is a fork of the ledcontroller code by jmrobles (<http://robleshermoso.wordpress.com>).

main.c

@@ -1,137 +1,158 @@
-/*
-    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 notices below.
+ * 
+ * @copyright Copyright (C) 2013 andmarios - http://www.andmarios.com \n
+ * 
+ * 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. \n
+ * 
+ * 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. \n
+ * 
+ * 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: \n
+ * 
+ * LedController \n
+ * Copyright (C) 2011  jmrobles - http://robleshermoso.wordpress.com \n
+ * 
+ * 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. \n
+ * 
+ * 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. \n
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. \n
 */
 
-
 #include <stdio.h>
 #include <libusb.h>
 #include <errno.h>
 #include <string.h>
 
-#define VID 0x1294
-#define PID 0x1320
-
+#define USB_VID 0x1294          /**< USB Vendor ID */
+#define USB_PID 0x1320          /**< USB Product ID */
+#define USB_EP  0x2             /**< USB EndPoint */
 
 static struct libusb_device_handle *devh = NULL;
-
-int main(int argc, char **argv)
+/**
+ * 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 
+ * @return Error code (0 on success)
+ */
+int main(int argc, char **argv) {
+    if (argc != 2)
     {
-    int ret;
-    unsigned char code = 0;
-    if (argc != 2) {
-	printf
-	    ("Syntax: %s blue | red | green | aqua | purple | yellow | white |  off\n",
-	     argv[0]);
+        printf("Syntax: %s blue | red | green | aqua | purple | yellow | white | off\n", argv[0]);
         return -1;
-
     }
 
-/*
-    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)
-*/
-    if (strcmp(argv[1], "blue") == 0) {
-	code = 1;
-    } else if (strcmp(argv[1], "red") == 0) {
-	code = 2;
-    } else if (strcmp(argv[1], "green") == 0) {
-	code = 3;
-    } else if (strcmp(argv[1], "aqua") == 0) {
-	code = 4;
-    } else if (strcmp(argv[1], "purple") == 0) {
-	code = 5;
-    } else if (strcmp(argv[1], "yellow") == 0) {
-	code = 6;
-    } else if (strcmp(argv[1], "white") == 0) {
-	code = 7;
-    } else {
+    unsigned char color_code = 0;
+    if (strcmp(argv[1], "off") == 0)
+    {
+        color_code = 0;
+    }
+    else if (strcmp(argv[1], "blue") == 0)
+    {
+        color_code = 1;
+    }
+    else if (strcmp(argv[1], "red") == 0)
+    {
+        color_code = 2;
+    }
+    else if (strcmp(argv[1], "green") == 0)
+    {
+        color_code = 3;
+    }
+    else if (strcmp(argv[1], "aqua") == 0)
+    {
+        color_code = 4;
+    }
+    else if (strcmp(argv[1], "purple") == 0)
+    {
+        color_code = 5;
+    }
+    else if (strcmp(argv[1], "yellow") == 0)
+    {
+        color_code = 6;
+    }
+    else if (strcmp(argv[1], "white") == 0)
+    {
+        color_code = 7;
+    }
+    else
+    {
         puts("Invalid color");
         return -1;
     }
 
     libusb_init(NULL);
-    devh = libusb_open_device_with_vid_pid(NULL, VID, PID);
-    if (devh == NULL) {
+    devh = libusb_open_device_with_vid_pid(NULL, USB_VID, USB_PID);
+    if (devh == NULL)
+    {
         puts("Device not found");
         return -1;
     }
 
-    if (libusb_kernel_driver_active(devh, 0)) {
+    if (libusb_kernel_driver_active(devh, 0))
+    {
         puts("Detach driver from kernel");
-	ret = libusb_detach_kernel_driver(devh, 0);
-	if (ret < 0) {
+        int ret = libusb_detach_kernel_driver(devh, 0);
+        if (ret < 0)
+        {
             puts("Could not detach driver");
             return -1;
         }
     }
 
     char data[5];
-    data[0] = code;
+    data[0] = color_code;
     data[1] = 0x4;
     data[2] = 0x4;
     data[3] = 0x4;
     data[4] = 0x4;
 
-    int dummy;
     libusb_claim_interface(devh, 0);
-    ret = libusb_interrupt_transfer(devh, 0x2, data, 5, &dummy, 0);
-    if (ret < 0) {
+    int ret = libusb_interrupt_transfer(devh, USB_EP, data, 5, NULL, 0);
+    if (ret < 0)
+    {
         perror("libusb error");
         return -1;
     }
 
-
     return 0;
 }