ngscopeclient 0.1-dev+51fbda87c
HIDInstrument.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopehal *
4* *
5* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
38#ifndef HIDInstrument_h
39#define HIDInstrument_h
40
45class HIDInstrument : public virtual SCPIInstrument, public BinaryDriver
46{
47public:
48 HIDInstrument(SCPITransport* transport);
49 virtual ~HIDInstrument();
50
51
52protected:
53
55 std::recursive_mutex m_hidMutex;
56
57 size_t Converse(uint8_t reportNumber, size_t responseReportSize, const std::vector<uint8_t>& sendData, std::vector<uint8_t>* receiveData);
58 void SendReport(uint8_t reportNumber, const std::vector<uint8_t>& data);
59 size_t ReadReport(size_t reportSize, std::vector<uint8_t>* data);
60
61};
62
63#endif
Helper class for binary driver: provides methods for handling binary data.
Definition: BinaryDriver.h:46
Base class for instruments using USB HID communication protocol.
Definition: HIDInstrument.h:46
std::recursive_mutex m_hidMutex
Mutex to make sure several requests don't collide before we received the corresponding response.
Definition: HIDInstrument.h:55
void SendReport(uint8_t reportNumber, const std::vector< uint8_t > &data)
Send a HID report.
Definition: HIDInstrument.cpp:72
An SCPI-based oscilloscope.
Definition: SCPIInstrument.h:38
Abstraction of a transport layer for moving SCPI data between endpoints.
Definition: SCPITransport.h:47