106 lines
3.9 KiB
C++
106 lines
3.9 KiB
C++
/**
|
|
* @file
|
|
*
|
|
* @author Mamadou Babaei <mamadou@senseglove.com>
|
|
*
|
|
* @section LICENSE
|
|
*
|
|
* (The MIT License)
|
|
*
|
|
* Copyright (c) 2020 - 2022 SenseGlove
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
* @section DESCRIPTION
|
|
*
|
|
* Base class for Device Models containing the minimum amount of data gathered
|
|
* through Communications Protocol. Used for shared functionality.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
#include "Containers/Array.h"
|
|
#include "Containers/UnrealString.h"
|
|
#include "HAL/Platform.h"
|
|
|
|
#include "SGKismet/SGBlueprintFunctionLibrary.h"
|
|
|
|
#include "SGDeviceModelKismetLibrary.generated.h"
|
|
|
|
class USGDeviceModel;
|
|
|
|
/**
|
|
* Base class containing the minimum amount of data for device models.
|
|
*/
|
|
UCLASS(meta=(ScriptName = "SesneGloveDeviceModelKismetLibrary"))
|
|
class SENSEGLOVECOREKISMET_API USGDeviceModelKismetLibrary final : public USGBlueprintFunctionLibrary
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
/**
|
|
* Empty constructor to be used by child classes.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Device Model", meta=(WorldContext="WorldContextObject"))
|
|
static USGDeviceModel* MakeDeviceModel(UObject* WorldContextObject);
|
|
|
|
/**
|
|
*
|
|
*/
|
|
UFUNCTION(BlueprintCallable, DisplayName="Make Device Model", Category="SenseGlove | Core | Device Model",
|
|
meta=(WorldContext="WorldContextObject"))
|
|
static USGDeviceModel* MakeDeviceModel_I_HV_FV_SFV(
|
|
UObject* WorldContextObject,
|
|
const FString& Id, const FString& HardwareVersion, int32 FirmwareVersion, int32 SubFirmwareVersion);
|
|
|
|
/**
|
|
* Parse a 32-bit integer value into a set of booleans (010010011) that indicate which (optional) functions this device has.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Device Model")
|
|
static TArray<bool> ParseFunctions(int32 Value, int32 Size);
|
|
|
|
UFUNCTION(BlueprintCallable, Category="SenseGlove | Core | Device Model")
|
|
static void ParseFirmware(const FString& RawFirmware, int32& OutMainVersion, int32& OutSubVersion);
|
|
|
|
/**
|
|
* Retrieve the Unique identifier of this device.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Device Model")
|
|
static FString GetDeviceId(const USGDeviceModel* DeviceModel);
|
|
|
|
/**
|
|
* Retrieve the Hardware (sub) version of this Sense Glove Device.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Device Model")
|
|
static FString GetHardwareVersion(const USGDeviceModel* DeviceModel);
|
|
|
|
/**
|
|
* Firmware version running on the device's MicroController. (as v4.12, this is the 4).
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Device Model")
|
|
static int32 GetFirmwareVersion(const USGDeviceModel* DeviceModel);
|
|
|
|
/**
|
|
* Sub firmware version running on the device's microcontroller (as v4.12, this is the 12).
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category="SenseGlove | Core | Device Model")
|
|
static int32 GetSubFirmwareVersion(const USGDeviceModel* DeviceModel);
|
|
};
|