Add support for Gigabyte Aorus M2 mouse - Closes #2538

This commit is contained in:
morg 2022-12-29 14:35:47 +01:00 committed by Adam Honse
parent 7a1af0854a
commit b6172b71c8
6 changed files with 391 additions and 0 deletions

View file

@ -0,0 +1,80 @@
/*-----------------------------------------*\
| GigabyteAorusMouseController.cpp |
| |
| Driver for Gigabyte Aorus Mouse lighting |
| controller |
| |
| Guimard Morgan (morg) 12/29/2022 |
\*-----------------------------------------*/
#include "GigabyteAorusMouseController.h"
#include <string.h>
GigabyteAorusMouseController::GigabyteAorusMouseController(hid_device* dev_handle, const hid_device_info& info)
{
dev = dev_handle;
location = info.path;
version = "";
wchar_t serial_string[128];
int ret = hid_get_serial_number_string(dev, serial_string, 128);
if(ret != 0)
{
serial_number = "";
}
else
{
std::wstring return_wstring = serial_string;
serial_number = std::string(return_wstring.begin(), return_wstring.end());
}
}
GigabyteAorusMouseController::~GigabyteAorusMouseController()
{
hid_close(dev);
}
std::string GigabyteAorusMouseController::GetDeviceLocation()
{
return("HID: " + location);
}
std::string GigabyteAorusMouseController::GetSerialString()
{
return(serial_number);
}
std::string GigabyteAorusMouseController::GetFirmwareVersion()
{
return(version);
}
void GigabyteAorusMouseController::SetMode(RGBColor color, uint8_t mode_value, uint8_t brightness, uint8_t speed)
{
uint8_t usb_buf[GIGABYTE_AORUS_MOUSE_REPORT_SIZE];
usb_buf[0] = GIGABYTE_AORUS_MOUSE_HARDWARE_CMD;
usb_buf[1] = mode_value;
usb_buf[2] = brightness;
usb_buf[3] = RGBGetRValue(color);
usb_buf[4] = RGBGetGValue(color);
usb_buf[5] = RGBGetBValue(color);
usb_buf[6] = speed;
usb_buf[7] = 0x00;
hid_send_feature_report(dev, usb_buf, GIGABYTE_AORUS_MOUSE_REPORT_SIZE);
}
void GigabyteAorusMouseController::SendDirect(RGBColor color)
{
uint8_t usb_buf[8];
memset(usb_buf, 0x00, GIGABYTE_AORUS_MOUSE_REPORT_SIZE);
usb_buf[0] = GIGABYTE_AORUS_MOUSE_DIRECT_CMD;
usb_buf[2] = RGBGetRValue(color);
usb_buf[3] = RGBGetGValue(color);
usb_buf[4] = RGBGetBValue(color);
hid_send_feature_report(dev, usb_buf, GIGABYTE_AORUS_MOUSE_REPORT_SIZE);
}

View file

@ -0,0 +1,56 @@
/*-----------------------------------------*\
| GigabyteAorusMouseController.h |
| |
| Driver for Gigabyte Aorus Mouse lighting |
| controller - header file |
| |
| Guimard Morgan (morg) 12/29/2022 |
\*-----------------------------------------*/
#pragma once
#include "RGBController.h"
#include <string>
#include <hidapi/hidapi.h>
#define GIGABYTE_AORUS_MOUSE_REPORT_SIZE 8
#define GIGABYTE_AORUS_MOUSE_DIRECT_CMD 0xCD
#define GIGABYTE_AORUS_MOUSE_HARDWARE_CMD 0xCC
enum
{
GIGABYTE_AORUS_MOUSE_DIRECT_MODE_VALUE = 0x00,
GIGABYTE_AORUS_MOUSE_STATIC_MODE_VALUE = 0x01,
GIGABYTE_AORUS_MOUSE_PULSE_MODE_VALUE = 0x02,
GIGABYTE_AORUS_MOUSE_COLOR_CYCLE_MODE_VALUE = 0x03,
GIGABYTE_AORUS_MOUSE_FLASH_MODE_VALUE = 0x04,
GIGABYTE_AORUS_MOUSE_DOUBLE_FLASH_MODE_VALUE = 0x05,
};
enum
{
GIGABYTE_AORUS_MOUSE_SPEED_MIN = 0x16,
GIGABYTE_AORUS_MOUSE_SPEED_MAX = 0x00,
GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN = 0x00,
GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX = 0x64
};
class GigabyteAorusMouseController
{
public:
GigabyteAorusMouseController(hid_device* dev_handle, const hid_device_info& info);
~GigabyteAorusMouseController();
std::string GetSerialString();
std::string GetDeviceLocation();
std::string GetFirmwareVersion();
void SetMode(RGBColor color, uint8_t mode_value, uint8_t brightness, uint8_t speed);
void SendDirect(RGBColor color);
private:
hid_device* dev;
std::string location;
std::string serial_number;
std::string version;
};

View file

@ -0,0 +1,31 @@
#include "Detector.h"
#include "RGBController.h"
#include "hidapi/hidapi.h"
#include "GigabyteAorusMouseController.h"
#include "RGBController_GigabyteAorusMouse.h"
/*-----------------------------------------------------*\
| Vendor ID |
\*-----------------------------------------------------*/
#define HOLTEK_VID 0x1044
/*-----------------------------------------------------*\
| Controller product ids |
\*-----------------------------------------------------*/
#define AORUS_M2_PID 0x7A40
void DetectGigabyteAorusMouseControllers(hid_device_info* info, const std::string& name)
{
hid_device* dev = hid_open_path(info->path);
if(dev)
{
GigabyteAorusMouseController* controller = new GigabyteAorusMouseController(dev, *info);
RGBController_GigabyteAorusMouse* rgb_controller = new RGBController_GigabyteAorusMouse(controller);
rgb_controller->name = name;
ResourceManager::get()->RegisterRGBController(rgb_controller);
}
}
REGISTER_HID_DETECTOR_IPU("Gigabyte Aorus M2", DetectGigabyteAorusMouseControllers, HOLTEK_VID, AORUS_M2_PID, 3, 0xFF01, 0x01);

View file

@ -0,0 +1,185 @@
/*-----------------------------------------*\
| RGBController_GigabyteAorusMouse.cpp |
| |
| Generic RGB Interface for OpenRGB |
| Gigabyte Aorus Mouse lighting |
| USB Driver |
| |
| Guimard Morgan (morg) 12/29/2022 |
\*-----------------------------------------*/
#include "RGBController_GigabyteAorusMouse.h"
#include <thread>
#include <chrono>
/**------------------------------------------------------------------*\
@name Gigabyte Aorus mouse
@category Mouse
@type USB
@save :x:
@direct :white_check_mark:
@effects :white_check_mark:
@detectors DetectGigabyteAorusMouseControllers
@comment
\*-------------------------------------------------------------------*/
RGBController_GigabyteAorusMouse::RGBController_GigabyteAorusMouse(GigabyteAorusMouseController* controller_ptr)
{
controller = controller_ptr;
name = "Gigabyte Aorus";
vendor = "Gigabyte";
type = DEVICE_TYPE_MOUSE;
description = name;
location = controller->GetDeviceLocation();
serial = controller->GetSerialString();
version = controller->GetFirmwareVersion();
mode Direct;
Direct.name = "Direct";
Direct.value = GIGABYTE_AORUS_MOUSE_DIRECT_MODE_VALUE;
Direct.flags = MODE_FLAG_HAS_PER_LED_COLOR | MODE_FLAG_HAS_BRIGHTNESS;
Direct.color_mode = MODE_COLORS_PER_LED;
Direct.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
Direct.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Direct.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
modes.push_back(Direct);
mode Static;
Static.name = "Static";
Static.value = GIGABYTE_AORUS_MOUSE_STATIC_MODE_VALUE;
Static.flags = MODE_FLAG_HAS_MODE_SPECIFIC_COLOR | MODE_FLAG_HAS_BRIGHTNESS;
Static.color_mode = MODE_COLORS_MODE_SPECIFIC;
Static.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
Static.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Static.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Static.colors.resize(1);
modes.push_back(Static);
mode Pulse;
Pulse.name = "Breathing";
Pulse.value = GIGABYTE_AORUS_MOUSE_PULSE_MODE_VALUE;
Pulse.flags = MODE_FLAG_HAS_MODE_SPECIFIC_COLOR | MODE_FLAG_HAS_BRIGHTNESS | MODE_FLAG_HAS_SPEED;
Pulse.color_mode = MODE_COLORS_MODE_SPECIFIC;
Pulse.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
Pulse.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Pulse.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Pulse.speed_min = GIGABYTE_AORUS_MOUSE_SPEED_MIN;
Pulse.speed_max = GIGABYTE_AORUS_MOUSE_SPEED_MAX;
Pulse.speed = GIGABYTE_AORUS_MOUSE_SPEED_MIN / 2;
Pulse.colors.resize(1);
modes.push_back(Pulse);
mode ColorCycle;
ColorCycle.name = "Spectrum Cycle";
ColorCycle.value = GIGABYTE_AORUS_MOUSE_COLOR_CYCLE_MODE_VALUE;
ColorCycle.flags = MODE_FLAG_HAS_BRIGHTNESS | MODE_FLAG_HAS_SPEED;
ColorCycle.color_mode = MODE_COLORS_NONE;
ColorCycle.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
ColorCycle.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
ColorCycle.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
ColorCycle.speed_min = GIGABYTE_AORUS_MOUSE_SPEED_MIN;
ColorCycle.speed_max = GIGABYTE_AORUS_MOUSE_SPEED_MAX;
ColorCycle.speed = GIGABYTE_AORUS_MOUSE_SPEED_MIN / 2;
modes.push_back(ColorCycle);
mode Flash;
Flash.name = "Flashing";
Flash.value = GIGABYTE_AORUS_MOUSE_FLASH_MODE_VALUE;
Flash.flags = MODE_FLAG_HAS_MODE_SPECIFIC_COLOR | MODE_FLAG_HAS_BRIGHTNESS | MODE_FLAG_HAS_SPEED;
Flash.color_mode = MODE_COLORS_MODE_SPECIFIC;
Flash.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
Flash.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Flash.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
Flash.speed_min = GIGABYTE_AORUS_MOUSE_SPEED_MIN;
Flash.speed_max = GIGABYTE_AORUS_MOUSE_SPEED_MAX;
Flash.speed = GIGABYTE_AORUS_MOUSE_SPEED_MIN / 2;
Flash.colors.resize(1);
modes.push_back(Flash);
mode DoubleFlash;
DoubleFlash.name = "Double Flash";
DoubleFlash.value = GIGABYTE_AORUS_MOUSE_DOUBLE_FLASH_MODE_VALUE;
DoubleFlash.flags = MODE_FLAG_HAS_MODE_SPECIFIC_COLOR | MODE_FLAG_HAS_BRIGHTNESS | MODE_FLAG_HAS_SPEED;
DoubleFlash.color_mode = MODE_COLORS_MODE_SPECIFIC;
DoubleFlash.brightness_min = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MIN;
DoubleFlash.brightness_max = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
DoubleFlash.brightness = GIGABYTE_AORUS_MOUSE_BRIGHTNESS_MAX;
DoubleFlash.speed_min = GIGABYTE_AORUS_MOUSE_SPEED_MIN;
DoubleFlash.speed_max = GIGABYTE_AORUS_MOUSE_SPEED_MAX;
DoubleFlash.speed = GIGABYTE_AORUS_MOUSE_SPEED_MIN / 2;
DoubleFlash.colors.resize(1);
modes.push_back(DoubleFlash);
mode Off;
Off.name = "Off";
Off.value = GIGABYTE_AORUS_MOUSE_STATIC_MODE_VALUE;
Off.color_mode = MODE_COLORS_NONE;
modes.push_back(Off);
SetupZones();
}
RGBController_GigabyteAorusMouse::~RGBController_GigabyteAorusMouse()
{
delete controller;
}
void RGBController_GigabyteAorusMouse::SetupZones()
{
zone new_zone;
new_zone.name = "Mouse";
new_zone.type = ZONE_TYPE_LINEAR;
new_zone.leds_min = 1;
new_zone.leds_max = 1;
new_zone.leds_count = 1;
new_zone.matrix_map = nullptr;
zones.emplace_back(new_zone);
leds.resize(1);
leds[0].name = "LED 1";
SetupColors();
}
void RGBController_GigabyteAorusMouse::ResizeZone(int /*zone*/, int /*new_size*/)
{
/*---------------------------------------------------------*\
| This device does not support resizing zones |
\*---------------------------------------------------------*/
}
void RGBController_GigabyteAorusMouse::DeviceUpdateLEDs()
{
controller->SendDirect(colors[0]);
}
void RGBController_GigabyteAorusMouse::UpdateZoneLEDs(int /*zone*/)
{
DeviceUpdateLEDs();
}
void RGBController_GigabyteAorusMouse::UpdateSingleLED(int /*led*/)
{
DeviceUpdateLEDs();
}
void RGBController_GigabyteAorusMouse::DeviceUpdateMode()
{
/*---------------------------------------------------------*\
| Brightness cannot be updated in the direct mode packet |
\*---------------------------------------------------------*/
if(modes[active_mode].value == GIGABYTE_AORUS_MOUSE_DIRECT_MODE_VALUE)
{
controller->SetMode(colors[0], GIGABYTE_AORUS_MOUSE_STATIC_MODE_VALUE, modes[active_mode].brightness, 0);
}
else if(modes[active_mode].color_mode == MODE_COLORS_MODE_SPECIFIC)
{
controller->SetMode(modes[active_mode].colors[0], modes[active_mode].value, modes[active_mode].brightness, modes[active_mode].speed);
}
else
{
controller->SetMode(0, modes[active_mode].value, modes[active_mode].brightness, modes[active_mode].speed);
}
}

View file

@ -0,0 +1,33 @@
/*-----------------------------------------*\
| RGBController_GigabyteAorusMouse.h |
| |
| Generic RGB Interface for OpenRGB |
| Gigabyte Aorus Mouse lighting |
| USB Driver |
| |
| Guimard Morgan (morg) 12/29/2022 |
\*-----------------------------------------*/
#pragma once
#include "RGBController.h"
#include "GigabyteAorusMouseController.h"
class RGBController_GigabyteAorusMouse : public RGBController
{
public:
RGBController_GigabyteAorusMouse(GigabyteAorusMouseController* controller_ptr);
~RGBController_GigabyteAorusMouse();
void SetupZones();
void ResizeZone(int zone, int new_size);
void DeviceUpdateLEDs();
void UpdateZoneLEDs(int zone);
void UpdateSingleLED(int led);
void DeviceUpdateMode();
private:
GigabyteAorusMouseController* controller;
};

View file

@ -116,6 +116,7 @@ INCLUDEPATH +=
Controllers/GaiZongGaiKeyboardController/ \
Controllers/GalaxGPUController/ \
Controllers/GigabyteAorusCPUCoolerController/ \
Controllers/GigabyteAorusMouseController/ \
Controllers/GigabyteRGBFusion2DRAMController/ \
Controllers/GigabyteRGBFusion2SMBusController/ \
Controllers/GigabyteRGBFusion2USBController/ \
@ -404,6 +405,8 @@ HEADERS +=
Controllers/GalaxGPUController/RGBController_GalaxGPU.h \
Controllers/GigabyteAorusCPUCoolerController/ATC800Controller.h \
Controllers/GigabyteAorusCPUCoolerController/RGBController_AorusATC800.h \
Controllers/GigabyteAorusMouseController/GigabyteAorusMouseController.h \
Controllers/GigabyteAorusMouseController/RGBController_GigabyteAorusMouse.h \
Controllers/GigabyteRGBFusion2DRAMController/GigabyteRGBFusion2DRAMController.h \
Controllers/GigabyteRGBFusion2DRAMController/RGBController_GigabyteRGBFusion2DRAM.h \
Controllers/GigabyteRGBFusion2SMBusController/GigabyteRGBFusion2SMBusController.h \
@ -960,6 +963,9 @@ SOURCES +=
Controllers/GigabyteAorusCPUCoolerController/ATC800Controller.cpp \
Controllers/GigabyteAorusCPUCoolerController/GigabyteAorusCPUCoolerControllerDetect.cpp \
Controllers/GigabyteAorusCPUCoolerController/RGBController_AorusATC800.cpp \
Controllers/GigabyteAorusMouseController/GigabyteAorusMouseController.cpp \
Controllers/GigabyteAorusMouseController/GigabyteAorusMouseControllerDetect.cpp \
Controllers/GigabyteAorusMouseController/RGBController_GigabyteAorusMouse.cpp \
Controllers/GigabyteRGBFusion2DRAMController/GigabyteRGBFusion2DRAMController.cpp \
Controllers/GigabyteRGBFusion2DRAMController/GigabyteRGBFusion2DRAMControllerDetect.cpp \
Controllers/GigabyteRGBFusion2DRAMController/RGBController_GigabyteRGBFusion2DRAM.cpp \