OpenRGB/Controllers/LogitechController/LogitechG910Controller.h

/*-----------------------------------------*\
|  LogitechG910Controller.h                 |
|                                           |
|  Definitions and types for Logitech G910  |
|  Orion Spectrum keyboard light controller |
|                                           |
|  Adam Honse (CalcProgrammer1) 6/11/2020   |
\*-----------------------------------------*/

#include "RGBController.h"

#include <string>
#include <hidapi/hidapi.h>

#pragma once

enum
{
    LOGITECH_G910_ZONE_MODE_KEYBOARD     = 0x00,
    LOGITECH_G910_ZONE_MODE_LOGO         = 0x01,
};

enum
{
    LOGITECH_G910_ZONE_DIRECT_KEYBOARD   = 0x01,
    LOGITECH_G910_ZONE_DIRECT_GKEYS      = 0x04,
    LOGITECH_G910_ZONE_DIRECT_LOGO       = 0x10,
    LOGITECH_G910_ZONE_DIRECT_INDICATORS = 0x40,
};

enum
{
    LOGITECH_G910_MODE_OFF               = 0x00,
    LOGITECH_G910_MODE_STATIC            = 0x01,
    LOGITECH_G910_MODE_BREATHING         = 0x02,
    LOGITECH_G910_MODE_CYCLE             = 0x03,
    LOGITECH_G910_MODE_WAVE              = 0x04,
};

/*---------------------------------------------------------------------------------------------*\
| Speed is 1000 for fast and 20000 for slow.                                                    |
| Values are multiplied by 100 later to give lots of GUI steps.                                 |
\*---------------------------------------------------------------------------------------------*/
enum
{
    LOGITECH_G910_SPEED_SLOWEST          = 0xC8,     /* Slowest speed                       */
    LOGITECH_G910_SPEED_NORMAL           = 0x32,     /* Normal speed                        */
    LOGITECH_G910_SPEED_FASTEST          = 0x0A,     /* Fastest speed                       */
};

class LogitechG910Controller
{
public:
    LogitechG910Controller(hid_device* dev_handle_0x11, hid_device* dev_handle_0x12);
    ~LogitechG910Controller();

    std::string GetSerialString();

    void        Commit();
    
    void        SetDirect
                    (
                    unsigned char       zone,
                    unsigned char       frame_count,
                    unsigned char *     frame_data
                    );

    void        SetMode
                    (
                    unsigned char       mode,
                    unsigned short      speed,
                    unsigned char       red,
                    unsigned char       green,
                    unsigned char       blue
                    );

private:
    hid_device* dev_pkt_0x11;
    hid_device* dev_pkt_0x12;

    void        SendDirectFrame
                    (
                    unsigned char       zone,
                    unsigned char       frame_count,
                    unsigned char *     frame_data
                    );

    void        SendMode
                    (
                    unsigned char       zone,
                    unsigned char       mode,
                    unsigned short      speed,
                    unsigned char       red,
                    unsigned char       green,
                    unsigned char       blue
                    );

    void        SendCommit();
};