TiproHidDevice.h

Go to the documentation of this file.

#ifndef _TIPRO_TIPROHIDAPI_TIPROHIDDEVICE_H_
#define _TIPRO_TIPROHIDAPI_TIPROHIDDEVICE_H_

#include <mutex>
#include "hidapi.h"
#include "TiproBus.h"


typedef unsigned char UCHAR;

class TiproHidDevice
{
public:
    
    enum ETErrCode
    {
        // compatible with EErrCode from CHid -> converted in ConvertErr() function
        terrNone,                                       // 0x00
        terrWrongParameter,                             // 0x01
        terrInvalidHandleValue,                         // 0x02
        terrDeviceNotOpened,                            // 0x03
        terrGetFeature,                                 // 0x04
        terrSetFeature,                                 // 0x05
        terrUnknown,                                    // 0x06
        // CTiproHid specific errors
        terrCmdNotSupportedAtFWLevel,                   // 0x07
        terrFWLevelNotAvailable,                        // 0x08
        terrFWLevelChangeFailed,                        // 0x09
        terrWTCDelayExpired,                            // 0x0A
        terrWrongSignatureBytes,                        // 0x0B
        terrResponseTimoutExpired,                      // 0x0C
        // Firmware exchange errors
        terrExchStatusVoid,                             // 0x0D
        terrExchStatusReqTO,                            // 0x0E
        terrExchStatusReqReject,                        // 0x0F
        terrExchStatusReqFail,                          // 0x10
        terrExchStatusReqSucc,                          // 0x11
        terrExchStatusAnsPend,                          // 0x12
        terrExchStatusAnsTO,                            // 0x13
        terrExchStatusAnsReject,                        // 0x14
        terrExchStatusAnsFail,                          // 0x15
        terrExchStatusAnsOK,                            // 0x16
        terrExchStatusFWBug                             // 0x17
    };

    //20190904
    static const UCHAR FRCMD_RESET              = 0x00;
    static const UCHAR FRCMD_TMC_IF_DISABLE     = 0x01;
    static const UCHAR FRCMD_TMC_IF_ENABLE      = 0x02;
    static const UCHAR FRCMD_TMC_IF_V2_ENABLE   = 0x03;
    static const UCHAR FRCMD_LEVEL1_CMD         = 0x04;
    static const UCHAR FRCMD_CLR_SERIAL_NO      = 0x05;
    static const UCHAR FRCMD_OPT_IF             = 0x06;
    static const UCHAR FRCMD_FW_LEVEL           = 0x07;
    static const UCHAR FRCMD_MID_EXCH           = 0x08;


    TiproBus g_TiproBus;
    
    virtual int Open();
    
    virtual int Close();
    
    TiproHidDevice();
    
    TiproHidDevice(const char path[]);
    
    virtual ~TiproHidDevice();
    
    TiproHidDevice(const TiproHidDevice& other);
    
    virtual TiproHidDevice& operator= (const TiproHidDevice& other);
    
    virtual int SendCommandToConnectedDeviceEx(const UCHAR nCommand, const UCHAR nDest, const UCHAR *pParameters, const int nLen, UCHAR *pResponse, int *nResponseLen);
    
    virtual int HIDEnumerateModules();//201907from tiprohidapiwindows
    
    virtual const char* GetPath();
    
    virtual hid_device* GetHidDevice();
    
    virtual int Reset();
    
    virtual int GetIndexedStringDescriptor(int lStrIx, wchar_t *pString, int lBufferLen);
    
    virtual int GetManufacturerString(wchar_t *pString, int lBufferLen);
    
    virtual int GetProductString(wchar_t *pString, int lBufferLen);
    
    virtual int GetSerialNumberString(wchar_t *pString, int lBufferLen);
    
    virtual int GetModuleVersion(int nIndex, unsigned char *nVerMaj, unsigned char *nVerMin, unsigned char *nVerBuild);
    
    virtual int GetModuleVersionEx(int nIndex, unsigned char *nVerMaj, unsigned char *nVerMin, unsigned char *nVerBuild, unsigned char *nModuleType, unsigned char *nModuleID);
    
    virtual int GetControllerInfo(int *nVerMaj, int *nVerMin, int *nVerBuild,int *nVerCustom, int *nFWLevel);
    
private:
    static const unsigned int REPORT_LEN = 65; //Report length. It should be to communicate with the device
    std::string _path = ""; //Device path
    hid_device *_device = NULL; //Device object
    unsigned int _report_length = 0; //Report length
    unsigned short _signature = 0; //Signature
    std::mutex door; //Mutex lock
    
    hid_device* HidOpenPath();
    
    int HidClose();
    
    int HidSendFeatureReport(const unsigned char *data, size_t length);
    
    int HidGetFeatureReport(unsigned char *data, size_t length);
    
    int SendCommand(const unsigned char data_send[], size_t length_send, unsigned char data_receive[], size_t& length_receive);//20190909
    
    int SetFwLevel(int fwlevel);
    
    
};

#endif