Merge branch 'hdiapi-implementation'

SkyPortal.uplugin

@@ -21,6 +21,5 @@
 			"LoadingPhase": "PostDefault"
 		}
 	],
-	"IsExperimentalVersion": false,
 	"Sealed": true
 }

Source/SkyPortal/Private/SkyPortalSubsystem.cpp

@@ -1,16 +1,434 @@
+// A lot of this code is made because of the work of https://github.com/capull0/SkyDumper and https://github.com/silicontrip/SkyReader
+
 #include "SkyPortalSubsystem.h"
 #include "Engine/Engine.h"
 
+DEFINE_LOG_CATEGORY(LogHIDApi);
+DEFINE_LOG_CATEGORY(LogSkyportalIO);
+
 void USkyPortalSubsystem::Initialize(FSubsystemCollectionBase& Collection)
 {
+
 	Super::Initialize(Collection);
 	// Custom initialization logic
-	UE_LOG(LogTemp, Warning, TEXT("SkyPortalSubsystem Initialized"));
+	UE_LOG(LogTemp, Log, TEXT("SkyPortalSubsystem Initialized"));
+
+	// Initialize HIDAPI
+	/*May be not needed
+	int res = hid_init();
+	if (res == 0)
+	{
+		UE_LOG(LogHIDApi, Log, TEXT("HIDAPI initialized successfully."));
+
+	}
+	else
+	{
+		UE_LOG(LogHIDApi, Error, TEXT("Failed to initialize HIDAPI."));
+		HidError = hid_error(NULL);
+		UE_LOG(LogHIDApi, Error, TEXT("%s"), *HidError);
+	}
+	*/
+
 }
 
 void USkyPortalSubsystem::Deinitialize()
 {
-	// Custom cleanup logic
-	UE_LOG(LogTemp, Warning, TEXT("SkyPortalSubsystem Deinitialized"));
+	// Disconnect portal
+	if (PortalDevice) {
+		hid_close(PortalDevice);
+	}
+	hid_exit();
+
+
+	UE_LOG(LogTemp, Log, TEXT("SkyPortalSubsystem Deinitialized"));
 	Super::Deinitialize();
 }
+
+// Antenna up / activate
+void USkyPortalSubsystem::ActivatePortal(int active)
+{
+	RWBlock req, res;
+
+	memset(req.buf, 0, rw_buf_size);
+	req.buf[1] = 'A';
+	req.buf[2] = active;
+	do { Write(&req); } while (CheckResponse(&res, 'A'));
+
+}
+
+// Start portal
+void USkyPortalSubsystem::RestartPortal()
+{
+	RWBlock req, res;
+
+	memset(req.buf, 0, rw_buf_size);
+	req.buf[1] = 'R';
+
+	do { Write(&req); } while (CheckResponse(&res, 'R'));
+
+}
+
+
+/*
+Number of endpoints : 2
+found an IN End Point 0 with attributes interrupt and address 0x1
+found an OUT End Point 1 with attributes interrupt and address 0x1
+*/
+bool USkyPortalSubsystem::OpenPortalHandle() {
+
+	//reset
+	if (PortalDevice) {
+		hid_close(PortalDevice);
+	}
+
+	/*
+		Declare two pointers to hold information about HID devices.
+		"list" will point to the head of the linked list of devices,
+		"attributes" will be used to iterate through the list.
+	*/
+	struct hid_device_info* list, * attributes;
+
+	list = hid_enumerate(0x0, 0x0);
+	// If `list` is NULL, that means no devices were found or there was an error.
+	// In this case, print an error message and terminate the program.
+	if (!list) {
+		UE_LOG(LogHIDApi, Error, TEXT("No devices found"));
+		// Get the error message from the HIDAPI
+		HidError = hid_error(NULL);
+		UE_LOG(LogHIDApi, Error, TEXT("%s"), *HidError);
+		return false;
+	}
+	attributes = list;
+
+
+
+
+	// Iterate through the linked list of devices
+	int vendorCount = sizeof(VendorIds) / sizeof(VendorIds[0]);
+	int productCount = sizeof(ProductIds) / sizeof(ProductIds[0]);
+
+	while (attributes) {
+		// Check if the devices match any of vendor_id and product_id 
+		for (int i = 0; i < vendorCount; i++) {
+			for (int j = 0; j < productCount; j++) {
+				if (attributes->vendor_id == VendorIds[i] && attributes->product_id == ProductIds[j]) {
+					UE_LOG(LogHIDApi, Display, TEXT("Portal found"));
+					UE_LOG(LogHIDApi, Log, TEXT("Vendor ID: 0x%x, Product ID: 0x%x"), attributes->vendor_id, attributes->product_id);
+
+					PortalDevice = hid_open(attributes->vendor_id, attributes->product_id, NULL);
+					if (PortalDevice) {
+						UE_LOG(LogHIDApi, Display, TEXT("Successful connection to Portal."));
+
+						// Free the device list
+						hid_free_enumeration(list);
+						//bPortalConnected = true;
+						return true;
+					}
+
+					break;
+				}
+			}
+		}
+
+		// Move to the next device in the list
+		attributes = attributes->next;
+	}
+
+	// Free the device list
+	hid_free_enumeration(list);
+	UE_LOG(LogHIDApi, Error, TEXT("No Portals found"));
+	return false;
+}
+//{ Region Color & light functions
+void USkyPortalSubsystem::ChangePortalColor(const FLinearColor& Color)
+{
+
+	unsigned char r = FMath::Clamp(Color.R * 100, 0.0f, 100.0f);
+	unsigned char g = FMath::Clamp(Color.G * 100, 0.0f, 100.0f);
+	unsigned char b = FMath::Clamp(Color.B * 100, 0.0f, 100.0f);
+
+	RWBlock req;
+
+	memset(req.buf, 0, rw_buf_size);
+
+	req.buf[1] = 'C';
+	req.buf[2] = r; // R
+	req.buf[3] = g; // G
+	req.buf[4] = b; // B
+
+	// no response for this one.
+	Write(&req);
+}
+void USkyPortalSubsystem::ChangePortalColorside(const FLinearColor& Color, const EPortalSide PortalSide, const float BlendTime )
+{
+	if (PortalSide == EPortalSide::TRAP) {
+		UE_LOG(LogSkyportalIO, Error, TEXT("This function should only be called for the left or right side of the portal"));
+		return;
+	}
+	unsigned char r = FMath::Clamp(Color.R * 100, 0.0f, 100.0f);
+	unsigned char g = FMath::Clamp(Color.G * 100, 0.0f, 100.0f);
+	unsigned char b = FMath::Clamp(Color.B * 100, 0.0f, 100.0f);
+
+	RWBlock req, res;
+
+	memset(req.buf, 0, rw_buf_size);
+
+	req.buf[1] = 'J';
+	switch (PortalSide) {
+	case EPortalSide::LEFT:
+		req.buf[2] = 0x00;
+	case EPortalSide::RIGHT:
+		req.buf[2] = 0x02;
+	case EPortalSide::BOTH:
+		req.buf[2] = 0x01; //maybe that doesnt work, will give it a try
+	}
+	
+	req.buf[3] = r; // R
+	req.buf[4] = g; // G
+	req.buf[5] = b; // B
+
+	//Convert the time in millisecond into two bytes
+	uint16_t _time = BlendTime;
+	uint8_t _time_low = _time & 0xFF;       // Get the low byte by masking the least significant 8 bits
+	uint8_t _time_high = (_time >> 8) & 0xFF; // Get the high byte extracted by shifting the bits 8 positions to the right and masking the result
+	req.buf[6] = _time_low;
+	req.buf[7] = _time_high;
+
+	do { Write(&req); } while (CheckResponse(&res, 'J'));
+
+}
+//}
+
+
+// write function need to be different on windows, as hid_write doesn't work with the way windows handle I/O
+#if PLATFORM_WINDOWS
+
+#include <Windows.h>
+
+#define HID_CTL_CODE(id)    \
+        CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_NEITHER, FILE_ANY_ACCESS)
+#define HID_IN_CTL_CODE(id)  \
+        CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_IN_DIRECT, FILE_ANY_ACCESS)
+#define IOCTL_HID_SET_OUTPUT_REPORT             HID_IN_CTL_CODE(101)
+
+struct hid_device_ {
+	HANDLE device_handle;
+	BOOL blocking;
+	USHORT output_report_length;
+	unsigned char* write_buf;
+	size_t input_report_length;
+	USHORT feature_report_length;
+	unsigned char* feature_buf;
+	wchar_t* last_error_str;
+	BOOL read_pending;
+	char* read_buf;
+	OVERLAPPED ol;
+	OVERLAPPED write_ol;
+	struct hid_device_info* device_info;
+};
+
+
+void USkyPortalSubsystem::Write(RWBlock* pb)
+{
+	if (!ensure(PortalDevice)) {
+		UE_LOG(LogSkyportalIO, Error, TEXT("No Portal found"));
+		return;
+	}
+	BOOL res;
+
+	OVERLAPPED ol;
+	memset(&ol, 0, sizeof(ol));
+
+	DWORD bytes_returned;
+
+	res = DeviceIoControl(PortalDevice->device_handle,
+		IOCTL_HID_SET_OUTPUT_REPORT,
+		(unsigned char*)pb->buf, 0x21,
+		(unsigned char*)pb->buf, 0x21,
+		&bytes_returned, &ol);
+	ensureMsgf(res, TEXT("Unable to write to Portal"));
+}
+
+#else
+void USkyPortalSubsystem::Write(RWBlock *pb) {
+
+		if (!ensure(PortalDevice)) {
+			UE_LOG(LogSkyportalIO, Error, TEXT("No Portal found"));
+			return;
+		}
+
+		pb->buf[0] = 0; // Use report 0
+
+
+		ensureMsgf(hid_write(PortalDevice, pb->buf, 0x21) != -1, TEXT("Unable to write to Portal, %s"), hid_error(PortalDevice));
+		UE_LOG(LogSkyportalIO, Error, TEXT("Unable to write to Portal. error:\n %s"), hid_error(PortalDevice));
+}
+#endif
+
+
+void USkyPortalSubsystem::Sleep(int sleepMs) {
+	FPlatformProcess::Sleep(sleepMs * 0.0001);
+}
+
+// TODO: Refacto this function to handle better the response/output from the portal
+bool USkyPortalSubsystem::CheckResponse(RWBlock *res, char expect)
+{
+	if (!PortalDevice) {
+		return false;
+	}
+
+	int b = hid_read_timeout(PortalDevice, res->buf, rw_buf_size, TIMEOUT);
+
+	if (b < 0) {
+		UE_LOG(LogSkyportalIO, Error, TEXT("Unable to read Skylander from Portal.\n"));
+		return false;
+	}
+
+	res->BytesTransferred = b;
+
+	/* this is here to debug the different responses from the portal.
+	#if DEBUG
+		SkylanderIO* skio;
+		skio = new SkylanderIO();
+		printf("<<<\n");
+		skio->fprinthex(stdout, res->buf, 0x21);
+		delete skio;
+	#endif
+	*/
+
+	// found wireless USB but portal is not connected
+	if (res->buf[0] == 'Z')
+	{
+		UE_LOG(LogSkyportalIO, Error, TEXT("found wireless USB but portal is not connected"));
+		return false;
+	}
+
+	// Status says no skylander on portal	
+	if (res->buf[0] == 'Q' && res->buf[1] == 0) {
+		UE_LOG(LogSkyportalIO, Warning, TEXT("Status says no skylander on portal"));
+	}
+
+	if (res->buf[0] == 'R' && res->buf[1] == 0) {
+		UE_LOG(LogSkyportalIO, Warning, TEXT("Status says no skylander on portal"));
+	}
+
+	return   (res->buf[0] != expect);
+}
+
+
+
+bool USkyPortalSubsystem::WriteBlock(unsigned int block, unsigned char data[0x10], int skylander) {
+	RWBlock req, res; //request and response buffer
+	unsigned char verify[0x10]; // A 16-byte array used to verify the data that was written to the portal.
+
+	UE_LOG(LogSkyportalIO, Verbose, TEXT("Trying to write the current block :%X\n"), block);
+
+	// Trying to write 3 times
+	for (int retries = 0; retries < 3; retries++) {
+		// Write request
+		// W	57 10 <block number> <0x10 bytes of data>
+		memset(req.buf, 0, rw_buf_size);//Reset request buffer
+		req.buf[1] = 'W';
+		req.buf[2] = 0x10 + skylander;
+		req.buf[3] = (unsigned char)block;
+		memcpy(req.buf + 4, data, 0x10);
+
+		do { Write(&req); } while (CheckResponse(&res, 'W'));
+
+		Sleep(100); //Wait 0.1 seconds for write to take effect
+
+		memset(verify, 0xCD, sizeof(verify)); // 0xCD is a placeholder value
+		ReadBlock(block, verify, skylander);
+
+		if (memcmp(data, verify, sizeof(verify))) {
+			UE_LOG(LogSkyportalIO, Error, TEXT("verification of the written block failed"));
+			continue; //retry
+		}
+		UE_LOG(LogSkyportalIO, Verbose, TEXT("block successfully written"));
+		return true;
+	}
+	UE_LOG(LogSkyportalIO, Fatal, TEXT("failed to write block"));
+	return false;
+}
+
+
+bool USkyPortalSubsystem::ReadBlock(unsigned int block, unsigned char data[0x10], int skylander) {
+	RWBlock req, res; //request and response buffers
+	unsigned char followup;
+
+	UE_LOG(LogSkyportalIO, Verbose, TEXT("PortalIO:ReadBlock :%X"), block);
+
+
+	// Checking if the block is not out of range
+	if (!ensure(block < 0x40)) {
+		UE_LOG(LogSkyportalIO, Error, TEXT("PortalIO:ReadBlock failed, block out of range"));
+		return false;  // Early return instead of throwing an exception
+	}
+
+	// Send query request
+
+	// Trying to read data 15x
+	for (int attempt = 0; attempt < 15; attempt++)
+	{
+		int i = 0;
+
+		memset(req.buf, 0, rw_buf_size); // Clear the request buffer (initialize all bytes to zero)
+		req.buf[1] = 'Q';
+		followup = 0x10 + skylander;
+		req.buf[2] = followup;
+		if (block == 0) {
+			req.buf[2] = followup + 0x10; // may not be needed
+		}
+		req.buf[3] = (unsigned char)block;
+
+		memset(&(res.buf), 0, rw_buf_size); // Clear the response buffer to prepare for incoming data
+
+
+		do { Write(&req); } while (CheckResponse(&res, 'Q'));
+
+		if (res.buf[0] == 'Q' && res.buf[2] == (unsigned char)block) {
+			// Got our query back
+			if (res.buf[1] == followup) {
+				// got the query back with no error
+				memcpy(data, res.buf + 3, 0x10);
+				UE_LOG(LogSkyportalIO, Verbose, TEXT("PortalIO:ReadBlock success"));
+				return true;
+			}
+		}
+
+
+	} // retries
+
+	UE_LOG(LogSkyportalIO, Fatal, TEXT("PortalIO:ReadBlock failed after retries"));
+	ensureMsgf(false, TEXT("PortalIO: Failed to read block after multiple retries"));
+	return false;
+}
+
+bool USkyPortalSubsystem::ConnectPortal()
+{
+
+	bPortalConnected = OpenPortalHandle();
+	if (bPortalConnected) {
+		RestartPortal();
+		ActivatePortal(1);
+
+		Sleep(500);
+		ChangePortalColor(FLinearColor(0xC8, 0xC8, 0xC8));
+
+		UE_LOG(LogSkyportalIO, Log, TEXT("Portal Status: %d\n"), PortalStatus());
+	}
+	return bPortalConnected;
+}
+
+
+
+unsigned char USkyPortalSubsystem::PortalStatus()
+{
+	RWBlock req, res;
+
+	memset(req.buf, 0, rw_buf_size);
+	req.buf[1] = 'S';
+	do { Write(&req); } while (CheckResponse(&res, 'S'));
+
+	return res.buf[1];
+}

Source/SkyPortal/Public/SkyPortalSubsystem.h

@@ -2,15 +2,113 @@
 
 #include "CoreMinimal.h"
 #include "Subsystems/EngineSubsystem.h"
+#include "hidapi.h"
+
+
 #include "SkyPortalSubsystem.generated.h"
 
-UCLASS()
-class SKYPORTAL_API USkyPortalSubsystem : public UEngineSubsystem
+
+UENUM(BlueprintType)
+enum EPortalSide {
+	LEFT UMETA(DisplayName = "Left side"),
+	RIGHT UMETA(DisplayName = "Right side"),
+	BOTH UMETA(DisplayName = "Both left and right"),
+	TRAP UMETA(DisplayName = "Trap")
+};
+
+
+
+/* Macro Definitions */
+#define rw_buf_size  0x21
+#define TIMEOUT 30000
+#define DEBUG true
+
+DECLARE_LOG_CATEGORY_EXTERN(LogHIDApi, Log, All);
+DECLARE_LOG_CATEGORY_EXTERN(LogSkyportalIO, Log, All);
+
+/* Subsystem */
+UCLASS(MinimalAPI)
+class USkyPortalSubsystem : public UEngineSubsystem
 {
 	GENERATED_BODY()
 
+	//Portal ref used in the subsystem
+	hid_device* PortalDevice;
+
 public:
 	// Override initialization and deinitialization methods
 	virtual void Initialize(FSubsystemCollectionBase& Collection) override;
 	virtual void Deinitialize() override;
+
+	
+
+	// Connect to Portal, return false if portal is not found
+	UFUNCTION(BlueprintCallable, CallInEditor, meta = (Category = "SkyPortal"))
+	SKYPORTAL_API bool ConnectPortal();
+
+	
+
+	UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
+	bool bPortalConnected = false;
+
+	FString HidError;
+
+
+	/* Portal Actions*/
+
+	// Change portal color, ideally should be called just at the start. For gameplay usage, use ChangePortalColorside()
+	UFUNCTION(BlueprintCallable, CallInEditor, meta = (AutoCreateRefTerm = "Color", Category = "SkyPortal|Cosmetic"))
+	SKYPORTAL_API void ChangePortalColor(const FLinearColor& Color = FLinearColor::Green);
+
+
+
+	/**
+	 * Change the color of the portal, can separate side and even trap ligth
+	 * @param	PortalSide	The actors to record
+	 * @param BlendTime Blend between current color and NextColor
+	 */
+	UFUNCTION(BlueprintCallable, CallInEditor, meta = (AutoCreateRefTerm = "NextColor", Category = "SkyPortal|Cosmetic"))
+	SKYPORTAL_API void ChangePortalColorside(const FLinearColor& NextColor = FLinearColor::Green,const EPortalSide PortalSide = EPortalSide::BOTH,const float BlendTime=100.0f);
+
+
+	unsigned char PortalStatus();
+
+
+
+
+private:
+
+
+	typedef struct {
+		unsigned char buf[rw_buf_size]; int BytesTransferred;
+	} RWBlock;
+
+
+	static void Sleep(int sleepMs);
+
+	void ActivatePortal(int active);
+
+	void RestartPortal();
+
+
+	// Block/byte related data write/read functions
+	bool OpenPortalHandle();
+	bool ReadBlock(unsigned int block, unsigned char data[0x10], int skylander);
+	bool WriteBlock(unsigned int, unsigned char[0x10], int);
+	bool CheckResponse(RWBlock *, char);
+	void Write(RWBlock *);
+
+
+protected:
+
+	//Constants
+	const int VendorIds[4] = { 0x12ba, 0x54c, 0x1430, 0x1430 };
+	const int ProductIds[4] = { 0x150, 0x967, 0x1f17 };
+	
+
+
+	/////Defaults values, should not be used
+	//const int VendorId = 5168;
+	//const int ProductId = 336;
 };
+

Source/SkyPortal/SkyPortal.Build.cs

@@ -1,16 +1,51 @@
 // Copyright Epic Games, Inc. All Rights Reserved.
 
+using System.IO;
 using UnrealBuildTool;
 
 public class SkyPortal : ModuleRules
 {
     public SkyPortal(ReadOnlyTargetRules Target) : base(Target)
     {
-        PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs;
+        bPrecompile = true;
+        // Add the path to the hidapi include directory
+        PublicIncludePaths.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "include"));
+
+        // Check platform-specific settings
+        if (Target.Platform == UnrealTargetPlatform.Win64)
+        {
+            // Add the path to the library (for Windows platform)
+            PublicSystemLibraryPaths.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "lib", "Windows"));
+
+            // Link against the hidapi.lib (static library)
+            PublicAdditionalLibraries.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "lib", "Windows", "hidapi.lib"));
+
+            // Add runtime library path for the .dll (dynamic library)
+            PublicRuntimeLibraryPaths.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "bin", "Windows"));
+
+            // Copy the DLL to the output folder, if using dynamic linking
+            RuntimeDependencies.Add("$(BinaryOutputDir)/hidapi.dll", Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "bin", "Windows", "hidapi.dll"));
+        }
+        else if (Target.Platform == UnrealTargetPlatform.Mac)
+        {
+            PublicSystemLibraryPaths.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "lib", "Mac"));
+            PublicAdditionalLibraries.Add("hidapi.a");
+
+            // Handle Mac-specific dynamic linking
+            RuntimeDependencies.Add("$(BinaryOutputDir)/hidapi.dylib", Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "bin", "Mac", "hidapi.dylib"));
+        }
+        else if (Target.Platform == UnrealTargetPlatform.Linux)
+        {
+            PublicSystemLibraryPaths.Add(Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "lib", "Linux"));
+            PublicAdditionalLibraries.Add("hidapi.a");
+
+            RuntimeDependencies.Add("$(BinaryOutputDir)/hidapi.so", Path.Combine(PluginDirectory, "ThirdParty", "hidapi", "bin", "Linux", "hidapi.so"));
+        }
+
 
         PublicIncludePaths.AddRange(
             new string[] {
-				// ... add public include paths required here ...
+
     }
             );
 

ThirdParty/hidapi/include/hidapi.h

@@ -0,0 +1,628 @@
+/*******************************************************
+ HIDAPI - Multi-Platform library for
+ communication with HID devices.
+
+ Alan Ott
+ Signal 11 Software
+
+ libusb/hidapi Team
+
+ Copyright 2023, All Rights Reserved.
+
+ At the discretion of the user of this library,
+ this software may be licensed under the terms of the
+ GNU General Public License v3, a BSD-Style license, or the
+ original HIDAPI license as outlined in the LICENSE.txt,
+ LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
+ files located at the root of the source distribution.
+ These files may also be found in the public source
+ code repository located at:
+        https://github.com/libusb/hidapi .
+********************************************************/
+
+/** @file
+ * @defgroup API hidapi API
+ */
+
+#ifndef HIDAPI_H__
+#define HIDAPI_H__
+
+#include <wchar.h>
+
+/* #480: this is to be refactored properly for v1.0 */
+#ifdef _WIN32
+   #ifndef HID_API_NO_EXPORT_DEFINE
+      #define HID_API_EXPORT __declspec(dllexport)
+   #endif
+#endif
+#ifndef HID_API_EXPORT
+   #define HID_API_EXPORT /**< API export macro */
+#endif
+/* To be removed in v1.0 */
+#define HID_API_CALL /**< API call macro */
+
+#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL /**< API export and call macro*/
+
+/** @brief Static/compile-time major version of the library.
+
+	@ingroup API
+*/
+#define HID_API_VERSION_MAJOR 0
+/** @brief Static/compile-time minor version of the library.
+
+	@ingroup API
+*/
+#define HID_API_VERSION_MINOR 14
+/** @brief Static/compile-time patch version of the library.
+
+	@ingroup API
+*/
+#define HID_API_VERSION_PATCH 0
+
+/* Helper macros */
+#define HID_API_AS_STR_IMPL(x) #x
+#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x)
+#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3)
+
+/** @brief Coverts a version as Major/Minor/Patch into a number:
+	<8 bit major><16 bit minor><8 bit patch>.
+
+	This macro was added in version 0.12.0.
+
+	Convenient function to be used for compile-time checks, like:
+	@code{.c}
+	#if HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
+	@endcode
+
+	@ingroup API
+*/
+#define HID_API_MAKE_VERSION(mj, mn, p) (((mj) << 24) | ((mn) << 8) | (p))
+
+/** @brief Static/compile-time version of the library.
+
+	This macro was added in version 0.12.0.
+
+	@see @ref HID_API_MAKE_VERSION.
+
+	@ingroup API
+*/
+#define HID_API_VERSION HID_API_MAKE_VERSION(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
+
+/** @brief Static/compile-time string version of the library.
+
+	@ingroup API
+*/
+#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
+
+/** @brief Maximum expected HID Report descriptor size in bytes.
+
+	Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
+
+	@ingroup API
+*/
+#define HID_API_MAX_REPORT_DESCRIPTOR_SIZE 4096
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+		/** A structure to hold the version numbers. */
+		struct hid_api_version {
+			int major; /**< major version number */
+			int minor; /**< minor version number */
+			int patch; /**< patch version number */
+		};
+
+		struct hid_device_;
+		typedef struct hid_device_ hid_device; /**< opaque hidapi structure */
+
+		/** @brief HID underlying bus types.
+
+			@ingroup API
+		*/
+		typedef enum {
+			/** Unknown bus type */
+			HID_API_BUS_UNKNOWN = 0x00,
+
+			/** USB bus
+			   Specifications:
+			   https://usb.org/hid */
+			HID_API_BUS_USB = 0x01,
+
+			/** Bluetooth or Bluetooth LE bus
+			   Specifications:
+			   https://www.bluetooth.com/specifications/specs/human-interface-device-profile-1-1-1/
+			   https://www.bluetooth.com/specifications/specs/hid-service-1-0/
+			   https://www.bluetooth.com/specifications/specs/hid-over-gatt-profile-1-0/ */
+			HID_API_BUS_BLUETOOTH = 0x02,
+
+			/** I2C bus
+			   Specifications:
+			   https://docs.microsoft.com/previous-versions/windows/hardware/design/dn642101(v=vs.85) */
+			HID_API_BUS_I2C = 0x03,
+
+			/** SPI bus
+			   Specifications:
+			   https://www.microsoft.com/download/details.aspx?id=103325 */
+			HID_API_BUS_SPI = 0x04,
+		} hid_bus_type;
+
+		/** hidapi info structure */
+		struct hid_device_info {
+			/** Platform-specific device path */
+			char *path;
+			/** Device Vendor ID */
+			unsigned short vendor_id;
+			/** Device Product ID */
+			unsigned short product_id;
+			/** Serial Number */
+			wchar_t *serial_number;
+			/** Device Release Number in binary-coded decimal,
+			    also known as Device Version Number */
+			unsigned short release_number;
+			/** Manufacturer String */
+			wchar_t *manufacturer_string;
+			/** Product string */
+			wchar_t *product_string;
+			/** Usage Page for this Device/Interface
+			    (Windows/Mac/hidraw only) */
+			unsigned short usage_page;
+			/** Usage for this Device/Interface
+			    (Windows/Mac/hidraw only) */
+			unsigned short usage;
+			/** The USB interface which this logical device
+			    represents.
+
+			    Valid only if the device is a USB HID device.
+			    Set to -1 in all other cases.
+			*/
+			int interface_number;
+
+			/** Pointer to the next device */
+			struct hid_device_info *next;
+
+			/** Underlying bus type
+			    Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
+			*/
+			hid_bus_type bus_type;
+		};
+
+
+		/** @brief Initialize the HIDAPI library.
+
+			This function initializes the HIDAPI library. Calling it is not
+			strictly necessary, as it will be called automatically by
+			hid_enumerate() and any of the hid_open_*() functions if it is
+			needed.  This function should be called at the beginning of
+			execution however, if there is a chance of HIDAPI handles
+			being opened by different threads simultaneously.
+
+			@ingroup API
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(NULL) to get the failure reason.
+		*/
+		int HID_API_EXPORT HID_API_CALL hid_init(void);
+
+		/** @brief Finalize the HIDAPI library.
+
+			This function frees all of the static data associated with
+			HIDAPI. It should be called at the end of execution to avoid
+			memory leaks.
+
+			@ingroup API
+
+			@returns
+				This function returns 0 on success and -1 on error.
+		*/
+		int HID_API_EXPORT HID_API_CALL hid_exit(void);
+
+		/** @brief Enumerate the HID Devices.
+
+			This function returns a linked list of all the HID devices
+			attached to the system which match vendor_id and product_id.
+			If @p vendor_id is set to 0 then any vendor matches.
+			If @p product_id is set to 0 then any product matches.
+			If @p vendor_id and @p product_id are both set to 0, then
+			all HID devices will be returned.
+
+			@ingroup API
+			@param vendor_id The Vendor ID (VID) of the types of device
+				to open.
+			@param product_id The Product ID (PID) of the types of
+				device to open.
+
+			@returns
+				This function returns a pointer to a linked list of type
+				struct #hid_device_info, containing information about the HID devices
+				attached to the system,
+				or NULL in the case of failure or if no HID devices present in the system.
+				Call hid_error(NULL) to get the failure reason.
+
+			@note The returned value by this function must to be freed by calling hid_free_enumeration(),
+			      when not needed anymore.
+		*/
+		struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id);
+
+		/** @brief Free an enumeration Linked List
+
+			This function frees a linked list created by hid_enumerate().
+
+			@ingroup API
+			@param devs Pointer to a list of struct_device returned from
+			            hid_enumerate().
+		*/
+		void  HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs);
+
+		/** @brief Open a HID device using a Vendor ID (VID), Product ID
+			(PID) and optionally a serial number.
+
+			If @p serial_number is NULL, the first device with the
+			specified VID and PID is opened.
+
+			@ingroup API
+			@param vendor_id The Vendor ID (VID) of the device to open.
+			@param product_id The Product ID (PID) of the device to open.
+			@param serial_number The Serial Number of the device to open
+			                     (Optionally NULL).
+
+			@returns
+				This function returns a pointer to a #hid_device object on
+				success or NULL on failure.
+				Call hid_error(NULL) to get the failure reason.
+
+			@note The returned object must be freed by calling hid_close(),
+			      when not needed anymore.
+		*/
+		HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number);
+
+		/** @brief Open a HID device by its path name.
+
+			The path name be determined by calling hid_enumerate(), or a
+			platform-specific path name can be used (eg: /dev/hidraw0 on
+			Linux).
+
+			@ingroup API
+			@param path The path name of the device to open
+
+			@returns
+				This function returns a pointer to a #hid_device object on
+				success or NULL on failure.
+				Call hid_error(NULL) to get the failure reason.
+
+			@note The returned object must be freed by calling hid_close(),
+			      when not needed anymore.
+		*/
+		HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path);
+
+		/** @brief Write an Output report to a HID device.
+
+			The first byte of @p data[] must contain the Report ID. For
+			devices which only support a single report, this must be set
+			to 0x0. The remaining bytes contain the report data. Since
+			the Report ID is mandatory, calls to hid_write() will always
+			contain one more byte than the report contains. For example,
+			if a hid report is 16 bytes long, 17 bytes must be passed to
+			hid_write(), the Report ID (or 0x0, for devices with a
+			single report), followed by the report data (16 bytes). In
+			this example, the length passed in would be 17.
+
+			hid_write() will send the data on the first OUT endpoint, if
+			one exists. If it does not, it will send the data through
+			the Control Endpoint (Endpoint 0).
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data The data to send, including the report number as
+				the first byte.
+			@param length The length in bytes of the data to send.
+
+			@returns
+				This function returns the actual number of bytes written and
+				-1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int  HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length);
+
+		/** @brief Read an Input report from a HID device with timeout.
+
+			Input reports are returned
+			to the host through the INTERRUPT IN endpoint. The first byte will
+			contain the Report number if the device uses numbered reports.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data A buffer to put the read data into.
+			@param length The number of bytes to read. For devices with
+				multiple reports, make sure to read an extra byte for
+				the report number.
+			@param milliseconds timeout in milliseconds or -1 for blocking wait.
+
+			@returns
+				This function returns the actual number of bytes read and
+				-1 on error.
+				Call hid_error(dev) to get the failure reason.
+				If no packet was available to be read within
+				the timeout period, this function returns 0.
+		*/
+		int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds);
+
+		/** @brief Read an Input report from a HID device.
+
+			Input reports are returned
+			to the host through the INTERRUPT IN endpoint. The first byte will
+			contain the Report number if the device uses numbered reports.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data A buffer to put the read data into.
+			@param length The number of bytes to read. For devices with
+				multiple reports, make sure to read an extra byte for
+				the report number.
+
+			@returns
+				This function returns the actual number of bytes read and
+				-1 on error.
+				Call hid_error(dev) to get the failure reason.
+				If no packet was available to be read and
+				the handle is in non-blocking mode, this function returns 0.
+		*/
+		int  HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length);
+
+		/** @brief Set the device handle to be non-blocking.
+
+			In non-blocking mode calls to hid_read() will return
+			immediately with a value of 0 if there is no data to be
+			read. In blocking mode, hid_read() will wait (block) until
+			there is data to read before returning.
+
+			Nonblocking can be turned on and off at any time.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param nonblock enable or not the nonblocking reads
+			 - 1 to enable nonblocking
+			 - 0 to disable nonblocking.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int  HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock);
+
+		/** @brief Send a Feature report to the device.
+
+			Feature reports are sent over the Control endpoint as a
+			Set_Report transfer.  The first byte of @p data[] must
+			contain the Report ID. For devices which only support a
+			single report, this must be set to 0x0. The remaining bytes
+			contain the report data. Since the Report ID is mandatory,
+			calls to hid_send_feature_report() will always contain one
+			more byte than the report contains. For example, if a hid
+			report is 16 bytes long, 17 bytes must be passed to
+			hid_send_feature_report(): the Report ID (or 0x0, for
+			devices which do not use numbered reports), followed by the
+			report data (16 bytes). In this example, the length passed
+			in would be 17.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data The data to send, including the report number as
+				the first byte.
+			@param length The length in bytes of the data to send, including
+				the report number.
+
+			@returns
+				This function returns the actual number of bytes written and
+				-1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+
+		int HID_API_EXPORT HID_API_CALL hid_set_output_report(hid_device* device, const unsigned char* data, size_t length);
+
+
+		int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length);
+
+		/** @brief Get a feature report from a HID device.
+
+			Set the first byte of @p data[] to the Report ID of the
+			report to be read.  Make sure to allow space for this
+			extra byte in @p data[]. Upon return, the first byte will
+			still contain the Report ID, and the report data will
+			start in data[1].
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data A buffer to put the read data into, including
+				the Report ID. Set the first byte of @p data[] to the
+				Report ID of the report to be read, or set it to zero
+				if your device does not use numbered reports.
+			@param length The number of bytes to read, including an
+				extra byte for the report ID. The buffer can be longer
+				than the actual report.
+
+			@returns
+				This function returns the number of bytes read plus
+				one for the report ID (which is still in the first
+				byte), or -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length);
+
+		/** @brief Get a input report from a HID device.
+
+			Since version 0.10.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 10, 0)
+
+			Set the first byte of @p data[] to the Report ID of the
+			report to be read. Make sure to allow space for this
+			extra byte in @p data[]. Upon return, the first byte will
+			still contain the Report ID, and the report data will
+			start in data[1].
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param data A buffer to put the read data into, including
+				the Report ID. Set the first byte of @p data[] to the
+				Report ID of the report to be read, or set it to zero
+				if your device does not use numbered reports.
+			@param length The number of bytes to read, including an
+				extra byte for the report ID. The buffer can be longer
+				than the actual report.
+
+			@returns
+				This function returns the number of bytes read plus
+				one for the report ID (which is still in the first
+				byte), or -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length);
+
+		/** @brief Close a HID device.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+		*/
+		void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev);
+
+		/** @brief Get The Manufacturer String from a HID device.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param string A wide string buffer to put the data into.
+			@param maxlen The length of the buffer in multiples of wchar_t.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen);
+
+		/** @brief Get The Product String from a HID device.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param string A wide string buffer to put the data into.
+			@param maxlen The length of the buffer in multiples of wchar_t.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen);
+
+		/** @brief Get The Serial Number String from a HID device.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param string A wide string buffer to put the data into.
+			@param maxlen The length of the buffer in multiples of wchar_t.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen);
+
+		/** @brief Get The struct #hid_device_info from a HID device.
+
+			Since version 0.13.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 13, 0)
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+
+			@returns
+				This function returns a pointer to the struct #hid_device_info
+				for this hid_device, or NULL in the case of failure.
+				Call hid_error(dev) to get the failure reason.
+				This struct is valid until the device is closed with hid_close().
+
+			@note The returned object is owned by the @p dev, and SHOULD NOT be freed by the user.
+		*/
+		struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_get_device_info(hid_device *dev);
+
+		/** @brief Get a string from a HID device, based on its string index.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param string_index The index of the string to get.
+			@param string A wide string buffer to put the data into.
+			@param maxlen The length of the buffer in multiples of wchar_t.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+				Call hid_error(dev) to get the failure reason.
+		*/
+		int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen);
+
+		/** @brief Get a report descriptor from a HID device.
+
+			Since version 0.14.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 14, 0)
+
+			User has to provide a preallocated buffer where descriptor will be copied to.
+			The recommended size for preallocated buffer is @ref HID_API_MAX_REPORT_DESCRIPTOR_SIZE bytes.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param buf The buffer to copy descriptor into.
+			@param buf_size The size of the buffer in bytes.
+
+			@returns
+				This function returns non-negative number of bytes actually copied, or -1 on error.
+		*/
+		int HID_API_EXPORT_CALL hid_get_report_descriptor(hid_device *dev, unsigned char *buf, size_t buf_size);
+
+		/** @brief Get a string describing the last error which occurred.
+
+			This function is intended for logging/debugging purposes.
+
+			This function guarantees to never return NULL.
+			If there was no error in the last function call -
+			the returned string clearly indicates that.
+
+			Any HIDAPI function that can explicitly indicate an execution failure
+			(e.g. by an error code, or by returning NULL) - may set the error string,
+			to be returned by this function.
+
+			Strings returned from hid_error() must not be freed by the user,
+			i.e. owned by HIDAPI library.
+			Device-specific error string may remain allocated at most until hid_close() is called.
+			Global error string may remain allocated at most until hid_exit() is called.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open(),
+			  or NULL to get the last non-device-specific error
+			  (e.g. for errors in hid_open() or hid_enumerate()).
+
+			@returns
+				A string describing the last error (if any).
+		*/
+		HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *dev);
+
+		/** @brief Get a runtime version of the library.
+
+			This function is thread-safe.
+
+			@ingroup API
+
+			@returns
+				Pointer to statically allocated struct, that contains version.
+		*/
+		HID_API_EXPORT const  struct hid_api_version* HID_API_CALL hid_version(void);
+
+
+		/** @brief Get a runtime version string of the library.
+
+			This function is thread-safe.
+
+			@ingroup API
+
+			@returns
+				Pointer to statically allocated string, that contains version string.
+		*/
+		HID_API_EXPORT const char* HID_API_CALL hid_version_str(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

ThirdParty/hidapi/include/hidapi_winapi.h

@@ -0,0 +1,74 @@
+/*******************************************************
+ HIDAPI - Multi-Platform library for
+ communication with HID devices.
+
+ libusb/hidapi Team
+
+ Copyright 2022, All Rights Reserved.
+
+ At the discretion of the user of this library,
+ this software may be licensed under the terms of the
+ GNU General Public License v3, a BSD-Style license, or the
+ original HIDAPI license as outlined in the LICENSE.txt,
+ LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
+ files located at the root of the source distribution.
+ These files may also be found in the public source
+ code repository located at:
+        https://github.com/libusb/hidapi .
+********************************************************/
+
+/** @file
+ * @defgroup API hidapi API
+ *
+ * Since version 0.12.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
+ */
+
+#ifndef HIDAPI_WINAPI_H__
+#define HIDAPI_WINAPI_H__
+
+#include <stdint.h>
+
+#include <guiddef.h>
+
+#include "hidapi.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+		/** @brief Get the container ID for a HID device.
+
+			Since version 0.12.0, @ref HID_API_VERSION >= HID_API_MAKE_VERSION(0, 12, 0)
+
+			This function returns the `DEVPKEY_Device_ContainerId` property of
+			the given device. This can be used to correlate different
+			interfaces/ports on the same hardware device.
+
+			@ingroup API
+			@param dev A device handle returned from hid_open().
+			@param container_id The device's container ID on return.
+
+			@returns
+				This function returns 0 on success and -1 on error.
+		*/
+		int HID_API_EXPORT_CALL hid_winapi_get_container_id(hid_device *dev, GUID *container_id);
+
+		/**
+		 * @brief Reconstructs a HID Report Descriptor from a Win32 HIDP_PREPARSED_DATA structure.
+		 *  This reconstructed report descriptor is logical identical to the real report descriptor,
+		 *  but not byte wise identical.
+		 *
+		 * @param[in]  hidp_preparsed_data Pointer to the HIDP_PREPARSED_DATA to read, i.e.: the value of PHIDP_PREPARSED_DATA,
+		 *   as returned by HidD_GetPreparsedData WinAPI function.
+		 * @param      buf       Pointer to the buffer where the report descriptor should be stored.
+		 * @param[in]  buf_size  Size of the buffer. The recommended size for the buffer is @ref HID_API_MAX_REPORT_DESCRIPTOR_SIZE bytes.
+		 *
+		 * @return Returns size of reconstructed report descriptor if successful, -1 for error.
+		 */
+		int HID_API_EXPORT_CALL hid_winapi_descriptor_reconstruct_pp_data(void *hidp_preparsed_data, unsigned char *buf, size_t buf_size);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif