mirror of
https://github.com/CalcProgrammer1/OpenRGB.git
synced 2026-01-19 12:37:52 -05:00
a3b023d86c
* Reorganize and clean up RGBController API functions
* Add functions to get protected RGBController member values
* Make NetworkClient, ProfileManager, and ResourceManager friend classes so they can access protected members
* Protected previously-public RGBController members
* Information strings (name, vendor, description, version, serial location)
* Device type
* Active mode
* Flags
* LEDs vector
* LED alternate names vector
* Modes vector
* Colors vector
* Zones vector
* Add CONTROLLER_FLAG_HIDDEN to allow plugins to hide controllers from control GUI
* Add update reason codes to RGBController update callback and signal updates on more RGBController events
* Add loop zone types and segmented zone type
* Add matrix map field to segments
* Rework matrix_map_type from using pointers to vector to prevent memory leaks
* Rework KeyboardLayoutManager to return new matrix_map_type
* Add access mutex to RGBController API
* Add per-zone modes ot RGBController API
* Add JSON description functions to RGBController API
205 lines
9.6 KiB
C++
205 lines
9.6 KiB
C++
/*---------------------------------------------------------*\
|
|
| CorsairLightingNodeController.h |
|
|
| |
|
|
| Driver for Corsair Lighting Node devices |
|
|
| |
|
|
| Adam Honse (calcprogrammer1@gmail.com) 12 Jan 2020 |
|
|
| |
|
|
| This file is part of the OpenRGB project |
|
|
| SPDX-License-Identifier: GPL-2.0-or-later |
|
|
\*---------------------------------------------------------*/
|
|
|
|
#pragma once
|
|
|
|
#include <chrono>
|
|
#include <vector>
|
|
#include <hidapi.h>
|
|
#include "DeviceGuardManager.h"
|
|
#include "RGBController.h"
|
|
|
|
#define CORSAIR_LIGHTING_NODE_WRITE_PACKET_SIZE 65 /* First byte is the report number */
|
|
#define CORSAIR_LIGHTING_NODE_READ_PACKET_SIZE 17 /* First byte is the report number */
|
|
#define CORSAIR_LIGHTING_NODE_READ_TIMEOUT 15 /* Timeout in milliseconds */
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_FIRMWARE = 0x02, /* Get firmware version */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_DIRECT = 0x32, /* Direct mode LED update packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_COMMIT = 0x33, /* Commit changes packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_BEGIN = 0x34, /* Begin effect packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_EFFECT_CONFIG = 0x35, /* Effect mode configuration packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_TEMPERATURE = 0x36, /* Update temperature value packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_RESET = 0x37, /* Reset channel packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_PORT_STATE = 0x38, /* Set port state packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_BRIGHTNESS = 0x39, /* Set brightness packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_LED_COUNT = 0x3A, /* Set LED count packet */
|
|
CORSAIR_LIGHTING_NODE_PACKET_ID_PROTOCOL = 0x3B, /* Set protocol packet */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_DIRECT_CHANNEL_RED = 0x00, /* Red channel for direct update */
|
|
CORSAIR_LIGHTING_NODE_DIRECT_CHANNEL_GREEN = 0x01, /* Green channel for direct update */
|
|
CORSAIR_LIGHTING_NODE_DIRECT_CHANNEL_BLUE = 0x02, /* Blue channel for direct update */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_PORT_STATE_HARDWARE = 0x01, /* Effect hardware control of channel */
|
|
CORSAIR_LIGHTING_NODE_PORT_STATE_SOFTWARE = 0x02, /* Direct software control of channel */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_LED_TYPE_LED_STRIP = 0x0A, /* Corsair LED Strip Type */
|
|
CORSAIR_LIGHTING_NODE_LED_TYPE_HD_FAN = 0x0C, /* Corsair HD-series Fan Type */
|
|
CORSAIR_LIGHTING_NODE_LED_TYPE_SP_FAN = 0x01, /* Corsair SP-series Fan Type */
|
|
CORSAIR_LIGHTING_NODE_LED_TYPE_ML_FAN = 0x02, /* Corsair ML-series Fan Type */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_CHANNEL_1 = 0x00, /* Channel 1 */
|
|
CORSAIR_LIGHTING_NODE_CHANNEL_2 = 0x01, /* Channel 2 */
|
|
CORSAIR_LIGHTING_NODE_NUM_CHANNELS = 0x02, /* Number of channels */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_SPEED_FAST = 0x00, /* Fast speed */
|
|
CORSAIR_LIGHTING_NODE_SPEED_MEDIUM = 0x01, /* Medium speed */
|
|
CORSAIR_LIGHTING_NODE_SPEED_SLOW = 0x02, /* Slow speed */
|
|
};
|
|
|
|
enum
|
|
{
|
|
CORSAIR_LIGHTING_NODE_MODE_RAINBOW_WAVE = 0x00, /* Rainbow Wave mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_COLOR_SHIFT = 0x01, /* Color Shift mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_COLOR_PULSE = 0x02, /* Color Pulse mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_COLOR_WAVE = 0x03, /* Color Wave mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_STATIC = 0x04, /* Static mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_TEMPERATURE = 0x05, /* Temperature mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_VISOR = 0x06, /* Visor mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_MARQUEE = 0x07, /* Marquee mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_BLINK = 0x08, /* Blink mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_SEQUENTIAL = 0x09, /* Sequential mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_RAINBOW = 0x0A, /* Rainbow mode */
|
|
CORSAIR_LIGHTING_NODE_MODE_DIRECT = 0xFFFF /* Dummy mode ID for direct mode */
|
|
};
|
|
|
|
class CorsairLightingNodeController
|
|
{
|
|
public:
|
|
CorsairLightingNodeController(hid_device* dev_handle, const char* path, std::string dev_name);
|
|
~CorsairLightingNodeController();
|
|
|
|
std::string GetFirmwareString();
|
|
std::string GetLocationString();
|
|
std::string GetNameString();
|
|
std::string GetSerialString();
|
|
|
|
unsigned int GetStripsOnChannel(unsigned int channel);
|
|
|
|
void SetBrightness(unsigned char brightness);
|
|
|
|
void SetChannelEffect(unsigned char channel,
|
|
unsigned char num_leds,
|
|
unsigned char mode,
|
|
unsigned char speed,
|
|
unsigned char direction,
|
|
bool random,
|
|
unsigned char red1,
|
|
unsigned char grn1,
|
|
unsigned char blu1,
|
|
unsigned char red2,
|
|
unsigned char grn2,
|
|
unsigned char blu2,
|
|
unsigned char red3,
|
|
unsigned char grn3,
|
|
unsigned char blu3
|
|
);
|
|
|
|
void SetChannelLEDs(unsigned char channel, RGBColor * colors, unsigned int num_colors);
|
|
|
|
void KeepaliveThread();
|
|
|
|
private:
|
|
hid_device* dev;
|
|
std::string firmware_version;
|
|
std::string location;
|
|
std::string name;
|
|
std::thread* keepalive_thread;
|
|
std::atomic<bool> keepalive_thread_run;
|
|
std::chrono::time_point<std::chrono::steady_clock> last_commit_time;
|
|
DeviceGuardManager* guard_manager_ptr;
|
|
|
|
void SendFirmwareRequest();
|
|
|
|
void SendDirect
|
|
(
|
|
unsigned char channel,
|
|
unsigned char start,
|
|
unsigned char count,
|
|
unsigned char color_channel,
|
|
unsigned char* color_data
|
|
);
|
|
|
|
void SendCommit();
|
|
|
|
void SendBegin
|
|
(
|
|
unsigned char channel
|
|
);
|
|
|
|
void SendEffectConfig
|
|
(
|
|
unsigned char channel,
|
|
unsigned char count,
|
|
unsigned char led_type,
|
|
unsigned char mode,
|
|
unsigned char speed,
|
|
unsigned char direction,
|
|
unsigned char change_style,
|
|
unsigned char color_0_red,
|
|
unsigned char color_0_green,
|
|
unsigned char color_0_blue,
|
|
unsigned char color_1_red,
|
|
unsigned char color_1_green,
|
|
unsigned char color_1_blue,
|
|
unsigned char color_2_red,
|
|
unsigned char color_2_green,
|
|
unsigned char color_2_blue,
|
|
unsigned short temperature_0,
|
|
unsigned short temperature_1,
|
|
unsigned short temperature_2
|
|
);
|
|
|
|
void SendTemperature();
|
|
|
|
void SendReset
|
|
(
|
|
unsigned char channel
|
|
);
|
|
|
|
void SendPortState
|
|
(
|
|
unsigned char channel,
|
|
unsigned char state
|
|
);
|
|
|
|
void SendBrightness
|
|
(
|
|
unsigned char channel,
|
|
unsigned char brightness
|
|
);
|
|
|
|
void SendLEDCount();
|
|
|
|
void SendProtocol();
|
|
|
|
int WriteAndRead
|
|
(
|
|
unsigned char *buf,
|
|
int read_timeout_ms = -1
|
|
);
|
|
};
|