Jump to content

Corsair CUE SDK


genius257
 Share

Recommended Posts

Corsair CUE SDK

Provides easy functions to call the Corsair CUE SDK with AutoIt.

Required files can be downloaded from Corsairs hompage

Code tested with a K95 RGB Keyboard. Other devices may not work with the test scripts.

CUE_SDK.au3 Version 0.1.1

CUE_SDK_LFX.au3 Version 0.0.1

Disclaimer: Using the x86 DLL results in crash when calling "CorsairPerformProtocolHandshake". I will fix this in the future if possible.

CUE SDK Example:

#include "CUE_SDK.au3"

#AutoIt3Wrapper_UseX64=Y

$hCUESDKDLL=DllOpen(@AutoItX64?"CUESDK.x64_2015.dll":"CUESDK_2015.dll")

CorsairPerformProtocolHandshake($hCUESDKDLL)
If @error<>0 Then Exit MsgBox(0, @error, "Handshake failed")

$iDeviceCount=CorsairGetDeviceCount($hCUESDKDLL)
MsgBox(0, "CorsairGetDeviceCount", "@error: "&@error&@CRLF&"Return: "&$iDeviceCount)

$tCorsairLedPositions=CorsairGetLedPositions($hCUESDKDLL)
MsgBox(0, "numberOfLed", $tCorsairLedPositions.numberOfLed)

$tCorsairLedColor=DllStructCreate($tagCorsairLedColor)
$tCorsairLedPosition=DllStructCreate($tagCorsairLedPosition, $tCorsairLedPositions.pLedPosition)
For $i=1 To $tCorsairLedPositions.numberOfLed
    $tCorsairLedColor.ledId=$tCorsairLedPosition.ledId
    $tCorsairLedColor.r=Mod($i, 2)?255:0
    $tCorsairLedColor.g=Mod($i, 2)?0:255
    $tCorsairLedColor.b=Mod($i, 2)?255:0
    $bSuccess = CorsairSetLedsColors($hCUESDKDLL, $tCorsairLedColor)
    If $bSuccess=0 Then Exit MsgBox(0, "["&$i&"] : "&$tCorsairLedColor.ledId, _CorsairErrorToString(CorsairGetLastError($hCUESDKDLL)))
    $tCorsairLedPosition=DllStructCreate($tagCorsairLedPosition, DllStructGetPtr($tCorsairLedPosition)+DllStructGetSize($tCorsairLedPosition))
    Sleep(100)
Next
MsgBox(0, "", "pause")

$tCorsairLedColor=DllStructCreate("INT["&(($tCorsairLedPositions.numberOfLed)*4)&"]")
$tCorsairLedPosition=DllStructCreate($tagCorsairLedPosition, $tCorsairLedPositions.pLedPosition)
For $i=1 To $tCorsairLedPositions.numberOfLed
    DllStructSetData($tCorsairLedColor, 1, $tCorsairLedPosition.ledId, 1+(($i-1)*4))
    DllStructSetData($tCorsairLedColor, 1, 255, 2+(($i-1)*4))
    DllStructSetData($tCorsairLedColor, 1, 0, 3+(($i-1)*4))
    DllStructSetData($tCorsairLedColor, 1, 0, 4+(($i-1)*4))
    $tCorsairLedPosition=DllStructCreate($tagCorsairLedPosition, DllStructGetPtr($tCorsairLedPosition)+DllStructGetSize($tCorsairLedPosition))
Next

$bSuccess = CorsairSetLedsColors($hCUESDKDLL, $tCorsairLedColor)
If $bSuccess=0 Then MsgBox(0, "", _CorsairErrorToString(CorsairGetLastError($hCUESDKDLL)))
MsgBox(0, "CorsairSetLedsColors", "@error: "&@error&@CRLF&"Return: "&$bSuccess)
Sleep(1000)

CorsairReleaseControl($hCUESDKDLL, $CAM_ExclusiveLightingControl)
DllClose($hCUESDKDLL)
Exit

Func _CorsairErrorToString($i)
    Switch $i
        Case $CE_Success
            Return "previously called function completed successfully"
        Case $CE_ServerNotFound
            Return "CUE is not running or was shut down or third-party control is disabled in CUE settings(runtime error)"
        Case $CE_NoControl
            Return "some other client has or took over exclusive control (runtime error)"
        Case $CE_ProtocolHandshakeMissing
            Return "developer did not perform protocol handshake(developer error)"
        Case $CE_IncompatibleProtocol
            Return " developer is calling the function that is not supported by the server(either because protocol has broken by server or client or because the function is new and server is too old. Check CorsairProtocolDetails for details) (developer error)"
        Case $CE_InvalidArguments
            Return "developer supplied invalid arguments to the function(for specifics look at function descriptions). (developer error)"
        Case Else
            Return SetError(1, 1, 0)
    EndSwitch
EndFunc

CUE SDK LFX Example:

#include "..\CUE_SDK.au3"
#include "..\CUE_SDK_LFX.au3"

#AutoIt3Wrapper_UseX64=Y
$hCUESDKDLL=DllOpen(@AutoItX64?"CUESDK.x64_2015.dll":"CUESDK_2015.dll")
$hCUESDK_LFXDLL=DllOpen(@AutoItX64?"CUELFX.x64_2013.dll":"CUELFX_2013.dll")

$tHandshake=CorsairPerformProtocolHandshake($hCUESDKDLL)
CorsairRequestControl($hCUESDKDLL, $CAM_ExclusiveLightingControl)
If @error<>0 Or $tHandshake=0 Then Exit MsgBox(0, @error, "Handshake failed")
$iDeviceCount=CorsairGetDeviceCount($hCUESDKDLL)
If @error<>0 Or $iDeviceCount=0 Then Exit MsgBox(0, @error, "No devices")
$tCorsairLedPositions=CorsairGetLedPositions($hCUESDKDLL)
CUELFXSetLedPositions($hCUESDK_LFXDLL, DllStructGetPtr($tCorsairLedPositions))
$tLeds=DllStructCreate("INT["&( $CLK_Application - $CLK_GraveAccentAndTilde + $CLK_Backspace - $CLK_BracketRight + 3 )&"]")
$j=1
For $i=$CLK_GraveAccentAndTilde To $CLK_Application
    DllStructSetData($tLeds, 1, $i, $j)
    $j+=1
Next
For $i=$CLK_BracketRight To $CLK_Backspace
    DllStructSetData($tLeds, 1, $i, $j)
    $j+=1
Next

DllStructSetData($tLeds, 1, $CLK_RightShift, $j)
$j+=1
DllStructSetData($tLeds, 1, $CLK_RightCtrl, $j)
$j+=1
DllStructSetData($tLeds, 1, $CLK_Fn, $j)

$pEffect=CUELFXCreateSpiralRainbowEffect($hCUESDK_LFXDLL, $tLeds, $CLES_Slow, $CLECD_CounterClockwise)
If $pEffect=0 Then Exit MsgBox(0, "", "Failed to create spiral rainbow effect")
$tEffect=DllStructCreate($tagCorsairEffect, $pEffect)

;play
$hTime=TimerInit()
Sleep(100)
$iTime=TimerDiff($hTime)
While 1
    $pFrame=CUELFXGetFrame($hCUESDK_LFXDLL, $tEffect.effectId, $iTime)
    $tFrame=DllStructCreate($tagCorsairFrame, $pFrame)
    If $pFrame>0 And $tFrame.ledsColors Then
        $tCorsairLedColors=DllStructCreate("INT["&$tFrame.Size*4&"]", $tFrame.ledsColors)
        $bSuccess=CorsairSetLedsColors($hCUESDKDLL, $tCorsairLedColors)
    EndIf
    $iTime=TimerDiff($hTime)
    If $iTime>10000 Then ExitLoop
    Sleep(25)
WEnd
CorsairReleaseControl($hCUESDKDLL, $CAM_ExclusiveLightingControl)

DllClose($hCUESDK_LFXDLL)
DllClose($hCUESDKDLL)

Newest version will be posted here. Older versions can be found on GitHub

Edited by genius257
Link to comment
Share on other sites

  • 2 weeks later...
On 7.08.2017 at 10:42 AM, genius257 said:

Required files can be downloaded from Corsairs hompage

Link is down ?

 

Signature beginning:
Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Codefor other useful stuff click the following button:

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST APIErrorLog.au3 UDF - A logging Library * Include Dependency Tree (Tool for analyzing script relations) * Show_Macro_Values.au3 *

 

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 UDF * ADO.au3 UDF SMTP Mailer UDF * Dual Monitor resolution detection * * 2GUI on Dual Monitor System * _SciLexer.au3 UDF * SciTE - Lexer for console pane

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Good coding practices in AutoIt * 

OpenOffice/LibreOffice/XLS Related: WriterDemo.au3 * XLS/MDB from scratch with ADOX

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * IE in TaskSchedulerIE Embedded Control Versioning (use IE9+ and HTML5 in a GUI) * PDF Related:How to get reference to PDF object embeded in IE * IE on Windows 11

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

I also encourage you to check awesome @trancexx code:  * Create COM objects from modules without any demand on user to register anything. * Another COM object registering stuffOnHungApp handlerAvoid "AutoIt Error" message box in unknown errors  * HTML editor

winhttp.au3 related : * https://www.autoitscript.com/forum/topic/206771-winhttpau3-download-problem-youre-speaking-plain-http-to-an-ssl-enabled-server-port/

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2023-04-24

Link to comment
Share on other sites

28 minutes ago, mLipok said:

Link is down ?

The link in the OP is using HTTPS, and the server doesn't have it enabled for it. Use HTTP instead

If I posted any code, assume that code was written using the latest release version unless stated otherwise. Also, if it doesn't work on XP I can't help with that because I don't have access to XP, and I'm not going to.
Give a programmer the correct code and he can do his work for a day. Teach a programmer to debug and he can do his work for a lifetime - by Chirag Gude
How to ask questions the smart way!

I hereby grant any person the right to use any code I post, that I am the original author of, on the autoitscript.com forums, unless I've specifically stated otherwise in the code or the thread post. If you do use my code all I ask, as a courtesy, is to make note of where you got it from.

Back up and restore Windows user files _Array.au3 - Modified array functions that include support for 2D arrays.  -  ColorChooser - An add-on for SciTE that pops up a color dialog so you can select and paste a color code into a script.  -  Customizable Splashscreen GUI w/Progress Bar - Create a custom "splash screen" GUI with a progress bar and custom label.  -  _FileGetProperty - Retrieve the properties of a file  -  SciTE Toolbar - A toolbar demo for use with the SciTE editor  -  GUIRegisterMsg demo - Demo script to show how to use the Windows messages to interact with controls and your GUI.  -   Latin Square password generator

Link to comment
Share on other sites

46 minutes ago, mLipok said:

Link is down ?

 

 

17 minutes ago, BrewManNH said:

The link in the OP is using HTTPS, and the server doesn't have it enabled for it. Use HTTP instead

My bad. I will update immediately.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...