class CueSdk(sdk_path=None)def connect(self)def get_device_count(self)Returns number of connected Corsair devices.
For keyboards, mice, mousemats, headsets and headset stands not more than one device of each type is included in return value in case if there are multiple devices of same type connected to the system. For DIY-devices and coolers actual number of connected devices is included in return value. For memory modules actual number of connected modules is included in return value, modules are enumerated with respect to their logical position (counting from left to right, from top to bottom).
Use get_device_info() to get information about a certain device.
def get_device_info(self, device_index)Returns information about a device based on provided index.
device_index
: zero-based index of device. Should be strictly
less than a value returned by get_device_count()
def get_devices(self)def get_last_error(self)Returns last error that occurred in this thread while using any of SDK functions.
def get_led_colors_by_device_index(self, device_index, led_identifiers)Gets current color for the requested LEDs.
The color should represent the actual state of the hardware LED, which could be a combination of SDK and/or CUE input. This function works for keyboard, mouse, mousemat, headset, headset stand, DIY-devices, memory module and cooler.
device_index
: zero-based index of device. Should be strictly less
than value returned by get_device_count()
led_identifiers
: the list of CorsairLedId values
A dict mapping CorsairLedId keys to the corresponding color
values. Each color is represented as a tuple of ints. For
example:
{
CorsairLedId.K_Escape: (255, 0, 0),
CorsairLedId.K_F1: (128, 0, 128)
}If error occurred, the function returns None
def get_led_id_for_key_name(self, key_name)Retrieves led id for key name taking logical layout into account.
So on AZERTY keyboards if user calls get_led_id_for_key_name('A') he
gets CorsairLedId.K_Q. This id can be used in
set_led_colors_buffer_by_device_index() function
key_name
: key name. ['A'..'Z'] (26 values) are valid values
Proper CorsairLedId or CorsairLedId.Invalid if error
occurred
def get_led_positions_by_device_index(self, device_index)Provides dictionary of keyboard, mouse, headset, mousemat, headset stand, DIY-devices, memory module and cooler LEDs by its index with their positions.
Position could be either physical (only device-dependent) or logical (depend on device as well as CUE settings).
device_index
: zero-based index of device. Should be strictly less
than value returned by get_device_count()
A dict mapping CorsairLedId keys to the corresponding LED
positions. Each position is represented as a tuple of floats.
For example:
{ CorsairLedId.K_Escape: (77.0, 36.0) }If error occurred, the function returns None
def get_property(self, device_index, property_id)def release_control(self)Releases previously requested exclusive control.
def request_control(self)Requests exclusive control over lighting.
By default client has shared control over lighting so there is no need to call request_control() unless a client requires exclusive control.
def set_layer_priority(self, priority)Sets layer priority for this shared client.
By default CUE has priority of 127 and all shared clients have priority of 128 if they don't call this function. Layers with higher priority value are shown on top of layers with lower priority.
priority
: priority of a layer [0..255]
boolean value. True if successful. Use get_last_error() to check the reason of failure. If this function is called in exclusive mode then it will return True
def set_led_colors_buffer_by_device_index(self, device_index, led_colors)Sets specified LEDs to some colors.
This function set LEDs colors in the buffer which is written to the devices via set_led_colors_flush_buffer() or set_led_colors_flush_buffer_async(). Typical usecase is next: set_led_colors_flush_buffer() or set_led_colors_flush_buffer_async() is called to write LEDs colors to the device and follows after one or more calls of set_led_colors_buffer_by_device_index() to set the LEDs buffer. This function does not take logical layout into account.
device_index
: zero-based index of device. Should be strictly less
than value returned by get_device_count()
led_colors
: a dict mapping CorsairLedId keys to the corresponding
color values. Each color is represented as a tuple of ints
(r, g, b). For example:
{ CorsairLedId.K_F1: (255, 0, 0) }def set_led_colors_flush_buffer(self)Writes to the devices LEDs colors buffer which is previously filled by the set_led_colors_buffer_by_device_index() function.
This function executes synchronously, if you are concerned about delays consider using set_led_colors_flush_buffer_async()
def set_led_colors_flush_buffer_async(self)Same as set_led_colors_flush_buffer() but returns control to the caller immediately
def subscribe_for_events(self, handler)Registers a callback that will be called by SDK when some event happened.
If client is already subscribed but calls this function again SDK should use only last callback registered for sending notifications.
handler: Callback function with two arguments: event_id and event_data
boolean value. True if successful. Use get_last_error() to check the reason of failure.
def unsubscribe_from_events(self)Unregisters callback previously registered by subscribe_for_events() call
boolean value. True if successful. Use get_last_error() to check the reason of failure.