Update OpenRGB QMK common controller files to new standardized header comment

This commit is contained in:
Adam Honse 2024-06-04 11:49:19 -05:00
parent 8bf11c6270
commit d9b88ae1b9
4 changed files with 39 additions and 30 deletions

View file

@ -1,15 +1,17 @@
/*---------------------------------------------------------*\
| QMKOpenRGBBaseController.cpp |
| QMKOpenRGBBaseController.cpp |
| |
| Base class for QMK keyboards using OpenRGB Protocol |
| Common Driver for OpenRGB QMK Keyboard Protocol |
| |
| ChrisM 20th December 2023 |
| ChrisM 20 Dec 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "LogManager.h"
#include "RGBControllerKeyNames.h"
#include "SettingsManager.h"
#include "QMKOpenRGBBaseController.h"
using namespace std::chrono_literals;

View file

@ -1,9 +1,12 @@
/*---------------------------------------------------------*\
| QMKOpenRGBBaseController.cpp |
| QMKOpenRGBBaseController.h |
| |
| Base class for QMK keyboards using OpenRGB Protocol |
| Common Driver for OpenRGB QMK Keyboard Protocol |
| |
| ChrisM 20th December 2023 |
| ChrisM 20 Dec 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
@ -12,7 +15,6 @@
#include "RGBController.h"
#include "RGBControllerKeyNames.h"
#include "SettingsManager.h"
#include "QMKOpenRGBController.h"
typedef std::map<uint8_t, std::string> qmk_keycodes;

View file

@ -1,20 +1,23 @@
/*-------------------------------------------------------------------*\
| QMKOpenRGBController.h |
| |
| Common definitions for QMK OpenRGB Controller |
| |
| Kasper 10th Octobber 2020 |
| Jath03 28th May 2021 |
\*-------------------------------------------------------------------*/
/*---------------------------------------------------------*\
| QMKOpenRGBController.h |
| |
| Driver for OpenRGB QMK Keyboard Protocol |
| |
| Kasper 10 Oct 2020 |
| Jath03 28 May 2021 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <cstring>
#include <map>
#include <hidapi/hidapi.h>
#include "ResourceManager.h"
#include "RGBController.h"
#include "hsv.h"
#include <hidapi/hidapi.h>
#include <cstring>
#include <map>
#define QMK_OPENRGB_PACKET_SIZE 65
#define QMK_OPENRGB_HID_READ_TIMEOUT 50
@ -127,4 +130,4 @@ typedef struct
{
uint8_t x;
uint8_t y;
} point_t;
} point_t;

View file

@ -1,15 +1,18 @@
/*-------------------------------------------------------------------*\
| QMKOpenRGBControllerDetect.cpp |
| |
| Driver for QMK keyboards using OpenRGB Protocol |
| |
| Kasper 10th Octobber 2020 |
| Jath03 28th May 2021 |
\*-------------------------------------------------------------------*/
/*---------------------------------------------------------*\
| QMKOpenRGBControllerDetect.cpp |
| |
| Detector for OpenRGB QMK Keyboard Protocol |
| |
| Kasper 10 Oct 2020 |
| Jath03 28 May 2021 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <iostream>
#include <string>
#include <hidapi/hidapi.h>
#include "Detector.h"
#include "QMKOpenRGBRev9Controller.h"
#include "QMKOpenRGBRevBController.h"
@ -21,7 +24,6 @@
#include "RGBController_QMKOpenRGBRevE.h"
#include "LogManager.h"
#include "SettingsManager.h"
#include <hidapi/hidapi.h>
/*-----------------------------------------------------*\
| Protocol version |