Update Python wrapper PyMethodDef

Author: RedFantom

clean.sh

@@ -0,0 +1,2 @@
+rm -rf CMakeFiles CMakeCache.txt _skbuild
+rm record main ambilight record ambilight *.cmake *.so*

libmk/libmk.c

@@ -1,5 +1,4 @@
-/**
- * Author: RedFantom
+/** Author: RedFantom
  * License: GNU GPLv3
  * Copyright (c) 2018-2019 RedFantom
 */
@@ -58,6 +57,17 @@ const unsigned int ISO[] =
 const unsigned char LAYOUT_ANSI = 0;
 const unsigned char LAYOUT_ISO = 1;
 
+const char* LIBMK_MODEL_STRINGS[] = {
+    "MasterKeys Pro L RGB",
+    "MasterKeys Pro S RGB",
+    "MasterKeys Pro L White",
+    "MasterKeys Pro M White",
+    "Unknown Model",
+    "MasterKeys Pro M RGB",
+    "Unknown Model",
+    "MasterKeys Pro S White",
+};
+
 /** Layout matrices
  *
  * These matrices describe the internal addresses of keys within the
@@ -168,6 +178,18 @@ const unsigned char LIBMK_LAYOUT[2][3][LIBMK_MAX_ROWS][LIBMK_MAX_COLS] = {
 };
 
 
+const char* LIBMK_MODEL_STRINGS[] = {
+    "MasterKeys Pro L RGB", // 0
+    "MasterKeys Pro S RGB", // 1
+    "MasterKeys Pro L White", // 2
+    "MasterKeys Pro M White", // 3
+    "Unknown Model", // 4
+    "MasterKeys Pro M RGB", // 5
+    "Unknown Model", // 6
+    "MasterKeys Pro S White",
+};
+
+
 bool libmk_init(void) {
     int result = libusb_init(&Context);
 #ifdef LIBMK_USB_DEBUG

libmk/libmk.h

@@ -127,6 +127,7 @@ typedef enum LibMK_Model {
 } LibMK_Model;
 
 
+<<<<<<< HEAD
 /** @brief Struct describing a supported USB device
  *
  * This struct may be used as a linked list. Holds information required
@@ -144,17 +145,7 @@ typedef struct LibMK_Device {
 
 
 /** @brief Array of strings representing the supported models */
-const char* LIBMK_MODEL_STRINGS[] = {
-    "MasterKeys Pro L RGB", // 0
-    "MasterKeys Pro S RGB", // 1
-    "MasterKeys Pro L White", // 2
-    "MasterKeys Pro M White", // 3
-    "Unknown Model", // 4
-    "MasterKeys Pro M RGB", // 5
-    "Unknown Model", // 6
-    "MasterKeys Pro S White",
-};
-
+const char* LIBMK_MODEL_STRINGS[];
 
 /** @brief Struct describing an opened supported device
  *
@@ -319,14 +310,6 @@ int libmk_reset(LibMK_Handle* handle);
 
 /** @brief Internal function. Return the bDevice USB descriptor property */
 int libmk_get_device_ident(LibMK_Handle* handle);
-<<<<<<< HEAD
-=======
-int libmk_get_firmware_version(LibMK_Handle* handle, LibMK_Firmware** fw);
-int libmk_set_active_profile(LibMK_Handle* handle, char profile);
-int libmk_get_active_profile(LibMK_Handle* handle, char* profile);
-int libmk_save_profile(LibMK_Handle* handle);
-<<<<<<< HEAD
->>>>>>> ce36524... Fix libmk_create_handle
 
 /** @brief Retrieve details on the firmware version of the device
  *
@@ -337,9 +320,9 @@ int libmk_save_profile(LibMK_Handle* handle);
  * @returns LibMK_Result result code, NULL or LibMK_Firmware* in fw
  */
 int libmk_get_firmware_version(LibMK_Handle* handle, LibMK_Firmware** fw);
-=======
+
+
 int libmk_set_control_mode(LibMK_Handle* handle, LibMK_ControlMode mode);
->>>>>>> 748c903... Fix errors during profile control
 
 /** @brief Send a single packet and verify the response
  *
@@ -355,11 +338,7 @@ int libmk_set_control_mode(LibMK_Handle* handle, LibMK_ControlMode mode);
  * pointer.
  */
 int libmk_send_packet(LibMK_Handle* handle, unsigned char* packet);
-<<<<<<< HEAD
-=======
-int libmk_send_recv_packet(LibMK_Handle* handle, unsigned char* packet, bool r);
-unsigned char* libmk_build_packet(unsigned char predef, ...);
->>>>>>> 748c903... Fix errors during profile control
+
 
 /** @brief Exchange a single packet with the keyboard
  *
@@ -374,14 +353,6 @@ unsigned char* libmk_build_packet(unsigned char predef, ...);
  */
 int libmk_exch_packet(LibMK_Handle* handle, unsigned char* packet);
 
-/** @brief Build a packet using the given data
- *
- * @param predef: Amount of predefined bytes in the packet
- * @param ...: bytes that are predefined, starting from index 0
- * @returns Pointer to the allocated array of bytes
- */
-unsigned char* libmk_build_packet(unsigned char predef, ...);
-
 /** @brief Set effect to be active on keyboard
  *
  * @param handle: LibMK_Handle for device to set effect on. If NULL uses
@@ -489,5 +460,29 @@ int libmk_get_active_profile(LibMK_Handle* handle, char* profile);
  */
 int libmk_save_profile(LibMK_Handle* handle);
 
+/** @brief Send a packet specifying whether to expect a response
+ *
+ * @param handle: LibMK_Handle of the device to send the packet to. If
+ *    NULL the global device handle is used.
+ * @param packet: Pointer to array of packet to send.
+ * @param r: Whether to expect a response. If ``false``, the function
+ *    still attempts to read a response to make sure that the buffer is
+ *    empty. If ``true``, performs protocol error checks and yields an
+ *    error if no response was received.
+ * @returns LibMK_Result result code
+ */
+int libmk_send_recv_packet(LibMK_Handle* handle, unsigned char* packet, bool r);
+
+/** @brief Build a new packet of data that can be sent to keyboard
+ *
+ * @param predef: Amount of bytes given in the variable arguments
+ * @param ...: Bytes to from index zero of the packet. The amount of
+ *    bytes given must be equal to the amount specified by ``predef``,
+ *    otherwise this function will segfault.
+ * @returns Pointer to the allocated packet with the set bytes. NULL if
+ *    no memory could be allocated.
+ */
+unsigned char* libmk_build_packet(unsigned char predef, ...);
+
 /** Debugging purposes */
 void libmk_print_packet(unsigned char* packet, char* label);

masterkeys/__init__.py

@@ -78,6 +78,13 @@ class Model:
     MODEL_UNKNOWN = -3
 
 
+class ControlMode:
+    FIRMWARE_CTRL = 0x00
+    EFFECT_CTRL = 0x01
+    CUSTOM_CTRL = 0x02
+    PROFILE_CTRL = 0x03
+
+
 MODEL_STRINGS = {
     0: "MasterKeys Pro L RGB",
     5: "MasterKeys Pro M RGB",
@@ -111,9 +118,9 @@ def set_device(model):
         is supported in the Python library. Only the first found device
         of the specified model is controlled.
     :type model: int
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
-    :raises: TypeError upon invalid argument type
+    :raises: ``TypeError`` upon invalid argument type
     """
     return _mk.set_device(model)
 
@@ -123,7 +130,7 @@ def enable_control():
     """
     Enable control on the device that has been set
 
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
     """
     return _mk.enable_control()
@@ -134,7 +141,7 @@ def disable_control():
     """
     Disable control on the device that has been set and is controlled
 
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
     """
     return _mk.disable_control()
@@ -145,11 +152,11 @@ def set_effect(effect):
     """
     Set the effect to be active on the controlled keyboard
 
-    :param effect: Effect number to set to be active
+    :param effect: Effect number to set to be active (:class:`.Effect`)
     :type effect: int
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
-    :raises: TypeError upon invalid argument type
+    :raises: ``TypeError`` upon invalid argument type
     """
     return _mk.set_effect(effect)
 
@@ -162,10 +169,11 @@ def set_all_led_color(layout):
     :param layout: List of lists of color tuples such as created by
         build_layout_list()
     :type layout: List[List[Tuple[int, int, int], ...], ...]
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
-    :raises: ValueError if the wrong amount of elements is in the list
-    :raises: TypeError if invalid argument type (any element)
+    :raises: ``ValueError`` if the wrong amount of elements is in the
+        list
+    :raises: ``TypeError`` if invalid argument type (any element)
     """
     return _mk.set_all_led_color(layout)
 
@@ -181,7 +189,7 @@ def set_full_led_color(r, g, b):
     :type g: int
     :param b: blue color byte
     :type b: int
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
     """
     return _mk.set_full_led_color(r, g, b)
@@ -202,9 +210,9 @@ def set_ind_led_color(row, col, r, g, b):
     :type g: int
     :param b: blue color byte
     :type b: int
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
-    :raises: TypeError upon invalid argument type
+    :raises: ``TypeError`` upon invalid argument type
     """
     return _mk.set_ind_led_color(row, col, r, g, b)
 
@@ -255,7 +263,7 @@ def set_effect_details(effect, direction=0, speed=0x60, amount=0x00,
     For more details about the parameters, please see the libmk
     documentation.
 
-    :param effect: Effect number
+    :param effect: Effect number (:class:`.Effect`)
     :type effect: int
     :param direction: Direction of the animation of the effect
     :type direction: int
@@ -267,8 +275,57 @@ def set_effect_details(effect, direction=0, speed=0x60, amount=0x00,
     :type foreground: Tuple[int, int, int]
     :param background: Background color of the effect
     :type background: Tuple[int, int, int]
-    :return: Result code
+    :return: Result code (:class:`.ResultCode`)
     :rtype: int
     """
     return _mk.set_effect_details(
         effect, direction, speed, amount, foreground, background)
+
+
+def get_active_profile():
+    # type: () -> int
+    """
+    Return the number of the profile active on the keyboard
+
+    :return: Result code (:class:`.ResultCode`) or profile number
+    :rtype: int
+    """
+    return _mk.get_active_profile()
+
+
+def set_active_profile(profile):
+    # type: (int) -> int
+    """
+    Activate a profile on the keyboard
+
+    :param profile: Number of profile to activate
+    :type profile: int
+    :return: Result code (:class:`.ResultCode`)
+    :rtype: int
+    """
+    return _mk.set_active_profile(profile)
+
+
+def save_profile():
+    # type: () -> int
+    """
+    Save the changes made to the lighting to the active profile
+
+    :return: Result code (:class:`.ResultCode`)
+    :rtype: int
+    """
+    return _mk.save_profile()
+
+
+def set_control_mode(mode):
+    # type: (int) -> int
+    """
+    Change the control mode of the keyboard manually
+
+    :param mode: New control mode to set (:class:`.ControlMode`)
+    :type mode: int  
+    :return: Result code (:class:`.ResultCode`)
+    :rtype: int
+    """
+    return _mk.set_control_mode(mode)
+

masterkeys/masterkeys.c

@@ -323,7 +323,27 @@ static struct PyMethodDef masterkeys_funcs[] = {
         masterkeys_get_device_ident,
         METH_NOARGS,
         "Return the bDevice USB descriptor value"
-    }, {NULL, NULL, 0, NULL}
+    }, {
+        "get_active_profile",
+        masterkeys_get_active_profile,
+        METH_VARARGS,
+        "Return the number of the active profile"
+    }, {
+        "set_active_profile",
+        masterkeys_set_active_profile,
+        METH_VARARGS,
+        "Set the active profile on the keyboard"
+    }, {
+       "save_profile",
+       masterkeys_save_profile,
+       METH_VARARGS,
+       "Save the changes made to the active profile"
+    }, {
+        "set_control_mode",
+        masterkeys_set_control_mode,
+        METH_VARARGS,
+        "Set the control mode of the keyboard"
+    },{NULL, NULL, 0, NULL}
 };