Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Python wrapper for the CUE SDK

Project Description

cue_sdk

Python wrapper for the CUE SDK

On PyPi

Installation

Use pip

$ pip install cue_sdk

Usage example

>>> from cue_sdk import *
# Load CUE DLL. Provide path to DLL yourself.
>>> Corsair = CUESDK("CUESDK.x64_2013.dll")
# Gives us exclusive access to controling the lighting and turns everything off.
>>> Corsair.RequestControl(CAM.ExclusiveLightingControl)
True
# Sets the color of the H key to white.
>>> Corsair.SetLedsColors(CorsairLedColor(CLK.H, 255, 255, 255))
True
# Sets the color of the A and B key to green
>>> Corsair.SetLedsColors([CorsairLedColor(CLK.A, 0, 255, 0), CorsairLedColor(CLK.B, 0, 255, 0)])
True
# Define a callback function for SetLedsColorsAsync
>>> def example_callback(context, result, error):
...     assert context == "test123"
...     print(context, result, error)
...
# Asynchronously set the color of the E key to white. Pass in a callback and an arbitrary context.
>>> Corsair.SetLedsColorsAsync(CorsairLedColor(CLK.E, 255, 255, 255), example_callback, "test123")
True
# (Note: The >>> appears before the result because it's async.)
>>> test123 True CE.Success
# Returns number of Corsair devices.
>>> Corsair.GetDeviceCount()
1
# Takes zero-based index of device and returns a namedtuple with the device info.
>>> Corsair.GetDeviceInfo(0)
CorsairDeviceInfo(type=<CDT.Keyboard: 2>, model='K70 RGB', physicalLayout=<CPL.US: 1>, logicalLayout=<CLL.NA: 2>, capsMask=<CDC.Lighting: 1>)
# Returns a named tuple with the led positions + count of the keyboard.
>>> Corsair.GetLedPositions(0)
CorsairLedPositions(numberOfLed=111, pLedPosition=(CorsairLedPosition(ledId=<CLK.Escape: 1>, top=29.0, left=7.0, height=13.0, width=13.0), ...))
# Returns the led id (CLK enum) for the key name. Relative to logical layout (e.g. on an AZERTY keyboard it will return Q, not A)
>>> Corsair.GetLedIdForKeyName('a')
<CLK.A: 38>
# Performs protocol handshake and returns details. Already called when the CUE class is initialized, no need to call for it yourself.
>>> Corsair.PerformProtocolHandshake()
CorsairProtocolDetails(sdkVersion='1.15.28', serverVersion='1.16.42', sdkProtocolVersion=2, serverProtocolVersion=2, breakingChanges=False)
# Protocol details are stored here when called handshake is performed on init.
>>> Corsair.ProtocolDetails
CorsairProtocolDetails(sdkVersion='1.15.28', serverVersion='1.16.42', sdkProtocolVersion=2, serverProtocolVersion=2, breakingChanges=False)
# Release control back to CUE.
>>> Corsair.ReleaseControl(CAM.ExclusiveLightingControl)
True
Release History

Release History

This version
History Node

2.1.0

History Node

2.0

History Node

1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
cue_sdk-2.1.0-py2.py3-none-any.whl (10.4 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jul 20, 2016
cue_sdk-2.1.0.zip (14.8 kB) Copy SHA256 Checksum SHA256 Source Jul 20, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting