SCPIHIDTransport.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* 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 SCPIHIDTransport_h
#define SCPIHIDTransport_h
 
#include "../xptools/HID.h"
 
class SCPIHIDTransport : public SCPITransport
{
public:
    SCPIHIDTransport(const std::string& args);
    virtual ~SCPIHIDTransport();
 
    virtual std::string GetConnectionString() override;
 
    virtual bool SendCommand(const std::string& cmd) override;
    virtual std::string ReadReply(bool endOnSemicolon = true, std::function<void(float)> progress = nullptr) override;
    virtual size_t ReadRawData(size_t len, unsigned char* buf, std::function<void(float)> progress = nullptr) override;
    virtual void SendRawData(size_t len, const unsigned char* buf) override;
 
    virtual bool IsCommandBatchingSupported() override;
    virtual bool IsConnected() override;
 
    const std::string& GetManufacturerName()
    { return m_manufacturerName; }
 
    const std::string& GetProductName()
    { return m_productName; }
 
    const std::string& GetSerialNumber()
    { return m_serialNumber; }
 
    //This is intentionally not virtual since it's a static method used by enumeration
    //cppcheck-suppress duplInheritedMember
    static std::string GetTransportName();
 
    //This is intentionally not virtual since it's a static method used by enumeration
    //cppcheck-suppress duplInheritedMember
    static std::vector<TransportEndpoint> EnumTransportEndpoints();
 
    TRANSPORT_INITPROC(SCPIHIDTransport)
 
protected:
    HID m_hid;
 
    std::string m_serialNumber;
    unsigned int m_vendorId;
    unsigned int m_productId;
    std::string m_manufacturerName;
    std::string m_productName;
 
    // Transport mutex
    std::recursive_mutex m_transportMutex;
 
};
 
#endif