HID.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ANTIKERNEL                                                                                                           *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef HID_h
#define HID_h
 
#include "../log/log.h"
#include <string>
#ifdef __APPLE__
#include <hidapi.h>
#else
#include <hidapi/hidapi.h>
#endif
 
struct HidDeviceDescriptor
{
    unsigned short vendorId;
    unsigned short productId;
    std::string serialNumber;
    std::string description;
};
 
 
class HID
{
public:
 
    HID();
    bool Connect(unsigned short vendorId, unsigned short productId, const char* serialNumber = NULL);
    void Close();
    virtual ~HID();
 
    int Read(unsigned char* data, int len);
    int Write(const unsigned char* data, int len);
 
    hid_device* GetHandle() const
    { return m_handle; }
 
    const std::string& GetManufacturerName() const
    { return m_manufacturerName; }
 
    const std::string& GetProductName() const
    { return m_productName; }
 
    const std::string& GetSerialNumber() const
    { return m_serialNumber; }
 
    bool IsValid() const
    { return (m_handle != nullptr); }
 
    static std::vector<HidDeviceDescriptor> EnumerateDevices();
 
protected:
    hid_device* m_handle;
    std::string m_manufacturerName;
    std::string m_productName;
    std::string m_serialNumber;
};
 
#endif