OpenRGB/Controllers/SteelSeriesController/SteelSeriesAerox3Controller.cpp

/*-------------------------------------------------------------------*\
|  SteelSeriesAerox3Controller.cpp                                    |
|                                                                     |
|  OpenRGB controller driver for the Steelseries Aerox3 Wired         |
|                                                                     |
|  Chris M (Dr_No)         9th June 2022                              |
\*-------------------------------------------------------------------*/

#include "SteelSeriesAerox3Controller.h"
#include "LogManager.h"

SteelSeriesAerox3Controller::SteelSeriesAerox3Controller(hid_device* dev_handle, steelseries_type proto_type, const char* path)
    : SteelSeriesMouseController(dev_handle, proto_type, path)
{
    SendInit();
}

SteelSeriesAerox3Controller::~SteelSeriesAerox3Controller()
{
    hid_close(dev);
}

void SteelSeriesAerox3Controller::SendInit()
{
    /*-----------------------------------------------------------------*\
    | This sets sensitivity and allows software mode?? max 5 uint8      |
    |   buffer[2]        = Count eg. 0 thru 5                           |
    |   buffer[4] to [8] = dpi / 50 range = 0x04 - 0xC7 eg. 400 = 0x08  |
    \*-----------------------------------------------------------------*/
    uint8_t buffer[STEELSERIES_AEORX3_PACKET_SIZE] = { 0x00, 0x2D };

    hid_send_feature_report(dev, buffer, STEELSERIES_AEORX3_PACKET_SIZE);
}

std::string SteelSeriesAerox3Controller::GetFirmwareVersion()
{
    uint8_t result      = 0;
    const uint8_t CMD   = 0x90;
    const uint8_t sz    = 16;
    char version[sz];

    uint8_t buffer[STEELSERIES_AEORX3_PACKET_SIZE] = { 0x00, CMD, 0x00 };

    hid_send_feature_report(dev, buffer, STEELSERIES_AEORX3_PACKET_SIZE);
    do
    {
        result = hid_read_timeout(dev, buffer, STEELSERIES_AEORX3_PACKET_SIZE, STEELSERIES_AEORX3_TIMEOUT);
        LOG_DEBUG("[%s] Reading version buffer: Bytes Read %d Buffer %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X", device_name, result,
                  buffer[0], buffer[1], buffer[2], buffer[3], buffer[4], buffer[5], buffer[6], buffer[7], buffer[8], buffer[9], buffer[10]);
    } while(result > 0 && buffer[0] != CMD);

    if(buffer[0] == CMD)
    {
        /*-----------------------------------------------------------------*\
        | Read the version from the second character                        |
        \*-----------------------------------------------------------------*/
        memcpy(version, &buffer[1], sz);
        std::string tmp = std::string(version);
        LOG_DEBUG("[%s] Version: %s as string %s", device_name, version, tmp.c_str());

        return tmp;
    }
    else
    {
        LOG_DEBUG("[%s] Unable to get version: giving up!", device_name);
        return "";
    }
}

steelseries_mouse SteelSeriesAerox3Controller::GetMouse()
{
    return aerox_3;
}

void SteelSeriesAerox3Controller::SetLightEffectAll(uint8_t /*effect*/)
{
    /*-----------------------------------------------------------------*\
    | Not used by this device                                           |
    \*-----------------------------------------------------------------*/
}

void SteelSeriesAerox3Controller::SetColor
    (
    unsigned char       zone_id,
    unsigned char       red,
    unsigned char       green,
    unsigned char       blue,
    unsigned char       brightness
    )
{
    uint8_t buffer[STEELSERIES_AEORX3_PACKET_SIZE] = { 0x00, 0x21 };

    buffer[0x02]        = 1 << zone_id;
    uint8_t offset      = 3 + zone_id * 3;

    buffer[offset]      = red;
    buffer[offset + 1]  = green;
    buffer[offset + 2]  = blue;

    hid_write(dev, buffer, STEELSERIES_AEORX3_PACKET_SIZE);

    if(brightness != current_brightness)
    {
        SetBrightness(brightness);
        current_brightness = brightness;
    }
}

void SteelSeriesAerox3Controller::SetBrightness(uint8_t brightness)
{
    uint8_t buffer[STEELSERIES_AEORX3_PACKET_SIZE]  = { 0x00, 0x23, brightness };

    hid_write(dev, buffer, STEELSERIES_AEORX3_PACKET_SIZE);
}

void SteelSeriesAerox3Controller::Save()
{
    /*---------------------------------------------------------------------------------*\
    | Save packet was not confirmed as working but packet is verified as correct.       |
    |   https://github.com/flozz/rivalcfg/blob/master/rivalcfg/devices/aerox3.py#L141   |
    \*---------------------------------------------------------------------------------*/
    uint8_t buffer2[STEELSERIES_AEORX3_PACKET_SIZE]  = { 0x00, 0x11, 0x00 };

    hid_write(dev, buffer2, STEELSERIES_AEORX3_PACKET_SIZE);
}