Create libmk_get_device_ident function and remove IntEnum

Author: RedFantom

.gitignore

@@ -76,6 +76,7 @@ CMakeCache.txt
 *CMakeTmp*
 *CMakeFiles*
 *CMakeCache.txt
+install_manifest.txt
 
 # Python packages
 /*.egg-info
@@ -84,5 +85,6 @@ CMakeCache.txt
 *.pyc
 
 # Executables
-record
-main
+/record
+/main
+/ambilight

.travis.yml

@@ -15,7 +15,7 @@ addons:
     - python-dev
     - python3-dev
 install:
-  - sudo python -m pip install -U pip scikit-build enum
+  - sudo python -m pip install -U pip scikit-build
 before_script:
   - mkdir cmake-build
 script:

libmk/libmk.c

@@ -32,8 +32,8 @@
  * The variables are required so that if the library is loaded into a
  * different language (like Python), interaction is easier.
 */
-static LibMK_Handle* DeviceHandle;
 static libusb_context* Context;
+static LibMK_Handle* DeviceHandle;
 
 
 typedef enum LibMK_Model LibMK_Model;
@@ -410,6 +410,16 @@ LibMK_Model libmk_ident_model(char* product) {
 }
 
 
+int libmk_get_device_ident(LibMK_Handle* handle) {
+    /** Return the bDevice attribute of a LibMK_Handle struct */
+    if (handle == NULL)
+        handle = DeviceHandle;
+    if (handle == NULL)
+        return 0x0000;
+    return DeviceHandle->bDevice;
+}
+
+
 int libmk_enable_control(LibMK_Handle* handle) {
     /** Enable LED control for a keyboard by sending the enable packet
      *

libmk/libmk.h

@@ -117,10 +117,7 @@ typedef struct LibMK_Device {
 
 
 typedef struct LibMK_Handle {
-    /** Struct describing an opened device
-     *
-     *
-     */
+    /** Struct describing an opened device */
     LibMK_Model model;
     int bVendor;
     int bDevice;
@@ -139,7 +136,6 @@ typedef struct LibMK_Effect_Details {
     unsigned char background[3];
 } LibMK_Effect_Details;
 
-
 /** Library management and initialization */
 bool libmk_init();
 int libmk_exit();
@@ -169,6 +165,7 @@ int libmk_disable_control(LibMK_Handle* handle);
 int libmk_claim_interface(LibMK_Handle* handle);
 int libmk_send_control_packet(LibMK_Handle* handle);
 int libmk_reset(LibMK_Handle* handle);
+int libmk_get_device_ident(LibMK_Handle* handle);
 
 
 /** Communication */

masterkeys/CMakeLists.txt

@@ -1,6 +1,7 @@
 # Author: RedFantom
 # License: GNU GPLv3
 # Copyright (c) 2018 RedFantom
+project(masterkeys VERSION 0.1.0 DESCRIPTION "Wrapper around libmk")
 find_package(PythonInterp REQUIRED)
 find_package(PythonLibs REQUIRED)
 find_package(PythonExtensions)

masterkeys/__init__.py

@@ -21,36 +21,36 @@
     Set the device to use with the library. Only a single device is
     supported. If multiple devices of the same model are connected, the
     first encountered is set to control.
-    :param model: enum Model of device to set
-    :return: enum Result code
+    :param model: Model number of device to set
+    :return: result code (SUCCESS or ERR*)
     :raises: TypeError upon invalid argument type
 
 int enable_control()
     Send the control packet to the keyboard set to control.
-    :return: enum Result code
+    :return: result code (SUCCESS or ERR*)
 
 int disable_control()
     Send the packet to release control to the keyboard set to control.
-    :return: enum Result code
+    :return: result code (SUCCESS or ERR*)
 
 int set_effect(effect)
     Set one of the built-in LED effects on the keyboard.
-    :param effect: enum Effect to enable
-    :return: enum Result code
+    :param effect: Effect number (EFF*)
+    :return: result code (SUCCESS or ERR*)
     :raises: TypeError upon invalid argument type
 
 int set_full_led_color(r, g, b)
     Set the color of all the LEDs on the keyboard to a single color.
     :param r: Red color value, 0-255 (two symbol HEX)
     :param g: Green color value
     :param b: Blue color value
-    :return: enum Result code
+    :return: result code (SUCCESS or ERR*)
     :raises: TypeError upon invalid argument type or count
 
 int set_all_led_color(layout)
     Set the color of all the LEDs on the keyboard from a list of lists
     :param layout: List of lists of tuples ([row][col][index])
-    :return: enum Result code
+    :return: result code (SUCCESS or ERR*)
     :raises: TypeError if invalid type in the argument
     :raises: ValueError if invalid amount of elements in the argument
 
@@ -59,79 +59,71 @@
     conjunction with the set_full_led_color function.
     :param row, col: Coordinates of LED to set color of
     :param r, g, b: Color values
-    :return: enum Result code
+    :return: result code (SUCCESS or ERR*)
     :raises: TypeError upon invalid argument type
 """
-from enum import Enum
 from .masterkeys import *
 
 
 MAX_ROWS = 7
 MAX_COLS = 24
 
-
-class Result(Enum):
-    """Describes error codes that are used in libmk"""
-    # Success codes
-    SUCCESS = 0
-
-    # Device Errors
-    ERR_INVALID_DEV = 1
-    ERR_DEV_NOT_CONNECTED = 2
-    ERR_DEV_NOT_SET = 3
-    ERR_UNKNOWN_LAYOUT = 14
-    ERR_DEV_NOT_CLOSED = 15
-    ERR_DEV_RESET_FAILED = 16
-
-    # Interface Errors
-    ERR_IFACE_CLAIM_FAILED = 4
-    ERR_IFACE_RELEASE_FAILED = 5
-    ERR_DEV_CLOSE_FAILED = 6
-    ERR_DEV_OPEN_FAILED = 7
-
-    # Kernel Driver Errors
-    ERR_KERNEL_DRIVER = 8
-
-    # Communication Errors
-    ERR_DEV_LIST = 9
-    ERR_TRANSFER = 10
-    ERR_DESCR = 11  # Descriptor
-    ERR_SEND = 12
-
-    # Protocol Errors
-    ERR_PROTOCOL = 13
-
-
-class Effect(Enum):
-    """Describes built-in LED Effect numbers"""
-    EFF_FULL_ON = 0
-    EFF_BREATH = 1
-    EFF_BREATH_CYCLE = 2
-    EFF_SINGLE = 3
-    EFF_WAVE = 4
-    EFF_RIPPLE = 5
-    EFF_CROSS = 6
-    EFF_RAIN = 7
-    EFF_STAR = 8
-    EFF_SNAKE = 9
-    EFF_REC = 10
-    EFF_SPECTRUM = 11
-    EFF_RAPID_FIRE = 12
-
-
-class Model(Enum):
-    """Describes models supported by this library"""
-    RGB_L = 0
-    RGB_M = 5
-    RGB_S = 1
-
-    WHITE_L = 2
-    WHITE_M = 3
-    WHITE_S = 7
-
-    NOT_SET = -1
-    ANY = -2
-    UNKNOWN = -3
+# Success codes
+SUCCESS = 0
+
+# Device Errors
+ERR_INVALID_DEV = 1
+ERR_DEV_NOT_CONNECTED = 2
+ERR_DEV_NOT_SET = 3
+ERR_UNKNOWN_LAYOUT = 14
+ERR_DEV_NOT_CLOSED = 15
+ERR_DEV_RESET_FAILED = 16
+
+# Interface Errors
+ERR_IFACE_CLAIM_FAILED = 4
+ERR_IFACE_RELEASE_FAILED = 5
+ERR_DEV_CLOSE_FAILED = 6
+ERR_DEV_OPEN_FAILED = 7
+
+# Kernel Driver Errors
+ERR_KERNEL_DRIVER = 8
+
+# Communication Errors
+ERR_DEV_LIST = 9
+ERR_TRANSFER = 10
+ERR_DESCR = 11  # Descriptor
+ERR_SEND = 12
+
+# Protocol Errors
+ERR_PROTOCOL = 13
+
+# Effects
+EFF_FULL_ON = 0
+EFF_BREATH = 1
+EFF_BREATH_CYCLE = 2
+EFF_SINGLE = 3
+EFF_WAVE = 4
+EFF_RIPPLE = 5
+EFF_CROSS = 6
+EFF_RAIN = 7
+EFF_STAR = 8
+EFF_SNAKE = 9
+EFF_REC = 10
+EFF_SPECTRUM = 11
+EFF_RAPID_FIRE = 12
+
+# Models
+MODEL_RGB_L = 0
+MODEL_RGB_M = 5
+MODEL_RGB_S = 1
+
+MODEL_WHITE_L = 2
+MODEL_WHITE_M = 3
+MODEL_WHITE_S = 7
+
+MODEL_NOT_SET = -1
+MODEL_ANY = -2
+MODEL_UNKNOWN = -3
 
 
 def set_all_led_color_dict(keys):

masterkeys/masterkeys.c

@@ -228,6 +228,12 @@ static PyObject* masterkeys_set_effect_details(PyObject* self, PyObject* args) {
 }
 
 
+static PyObject* masterkeys_get_device_ident(PyObject* self, PyObject* args) {
+    /** Return the bDevice value for the controlled keyboard */
+    return PyInt_FromLong(libmk_get_device_ident(NULL));
+}
+
+
 static struct PyMethodDef masterkeys_funcs[] = {
     {
         "detect_devices",
@@ -276,6 +282,11 @@ static struct PyMethodDef masterkeys_funcs[] = {
         masterkeys_set_effect_details,
         METH_VARARGS,
         "Set the effect on the keyboard with specific arguments"
+    }, {
+        "get_device_ident",
+        masterkeys_get_device_ident,
+        METH_NOARGS,
+        "Return the bDevice USB descriptor value"
     }, {NULL, NULL, 0, NULL}
 };