Base class for instruments using USB HID communication protocol. More...
#include <HIDInstrument.h>
Inheritance diagram for HIDInstrument:
Collaboration diagram for HIDInstrument:
Public Member Functions | |
| HIDInstrument (SCPITransport *transport) | |
 Public Member Functions inherited from SCPIInstrument | |
| SCPIInstrument (SCPITransport *transport, bool identify=true) | |
| virtual std::string | GetTransportConnectionString () |
| Gets the connection string for our transport. More... | |
| virtual std::string | GetTransportName () |
| Gets the name of our transport. More... | |
| virtual std::string | GetName () const |
| virtual std::string | GetVendor () const |
| virtual std::string | GetSerial () const |
| virtual std::string | GetDriverName () const =0 |
| Public Member Functions inherited from Instrument | |
| virtual unsigned int | GetInstrumentTypes () const =0 |
| Returns a bitfield describing the set of instrument types that this instrument supports. More... | |
| virtual std::string | GetName () const =0 |
| virtual std::string | GetVendor () const =0 |
| virtual std::string | GetSerial () const =0 |
| virtual std::string | GetTransportConnectionString ()=0 |
| Gets the connection string for our transport. More... | |
| virtual std::string | GetTransportName ()=0 |
| Gets the name of our transport. More... | |
| virtual uint32_t | GetInstrumentTypesForChannel (size_t i) const =0 |
| Returns a bitfield describing the set of instrument types that a given channel supports. More... | |
| size_t | GetChannelCount () const |
| Gets the number of channels (of any type) this instrument has. | |
| InstrumentChannel * | GetChannel (size_t i) const |
| Gets a given channel on the instrument. More... | |
| virtual std::string | GetChannelDisplayName (size_t i) |
| Gets the hardware display name for a channel. This is an arbitrary user-selected string. More... | |
| virtual void | SetChannelDisplayName (size_t i, std::string name) |
| Sets the hardware display name for a channel. This is an arbitrary user-selected string. More... | |
| InstrumentChannel * | GetChannelByDisplayName (const std::string &name) |
| Gets a channel given the display name. | |
| InstrumentChannel * | GetChannelByHwName (const std::string &name) |
| Gets a channel given the hardware name. | |
| virtual bool | AcquireData ()=0 |
| Pull data from the instrument. More... | |
| virtual void | FlushConfigCache () |
| Instruments are allowed to cache configuration settings to reduce round trip queries to the device. More... | |
| virtual YAML::Node | SerializeConfiguration (IDTable &table) const |
| Serializes this instrument's configuration to a YAML node. More... | |
| virtual void | LoadConfiguration (int version, const YAML::Node &node, IDTable &idmap) |
| Load instrument and channel configuration from a save file. More... | |
| virtual void | PreLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &warnings) |
| Parse a limited subset of instrument configuration but do not apply it. More... | |
| Public Member Functions inherited from SCPIDevice | |
| SCPIDevice (SCPITransport *transport, bool identify=true) | |
| SCPITransport * | GetTransport () const |
Protected Member Functions | |
| size_t | Converse (uint8_t reportNumber, size_t responseReportSize, const std::vector< uint8_t > &sendData, std::vector< uint8_t > *receiveData) |
| void | SendReport (uint8_t reportNumber, const std::vector< uint8_t > &data) |
| Send a HID report. More... | |
| size_t | ReadReport (size_t reportSize, std::vector< uint8_t > *data) |
| Protected Member Functions inherited from SCPIInstrument | |
| void | DoSerializeConfiguration (YAML::Node &node, IDTable &table) |
| Protected Member Functions inherited from BinaryDriver | |
| void | PushUint16 (std::vector< uint8_t > *data, uint16_t value, bool littleEndian=true) |
| Helper function to push a uint16 to a std::vector of bytes, as two consecutive bytes (either little-endian or big-endian according to littleEndian parameter) More... | |
| uint16_t | ReadUint16 (const std::vector< uint8_t > &data, uint8_t index, bool littleEndian=true) |
| Bounds-checked read of a 16-bit value from a byte vector. More... | |
| uint8_t | ReadUint8 (const std::vector< uint8_t > &data, uint8_t index) |
| Bounds-checked read of an 8-bit value from a byte vector. More... | |
| uint16_t | CalculateCRC (const uint8_t *buff, size_t len) |
Protected Attributes | |
| std::recursive_mutex | m_hidMutex |
| Mutex to make sure several requests don't collide before we received the corresponding response. | |
| Protected Attributes inherited from Instrument | |
| std::list< sigc::slot< void(YAML::Node &, IDTable &)> > | m_serializers |
| List of methods which need to be called to serialize this node's configuration. | |
| std::list< sigc::slot< void(int, const YAML::Node &, IDTable &)> > | m_loaders |
| List of methods which need to be called to deserialize this node's configuration. | |
| std::list< sigc::slot< void(int, const YAML::Node &, IDTable &, ConfigWarningList &)> > | m_preloaders |
| List of methods which need to be called to pre-load this node's configuration. | |
| std::vector< InstrumentChannel * > | m_channels |
| Set of all channels on this instrument. | |
| Protected Attributes inherited from SCPIDevice | |
| SCPITransport * | m_transport |
| std::string | m_vendor |
| std::string | m_model |
| std::string | m_serial |
| std::string | m_fwVersion |
Additional Inherited Members | |
| Public Types inherited from Instrument | |
| enum | InstrumentTypes { INST_OSCILLOSCOPE = 0x01 , INST_DMM = 0x02 , INST_PSU = 0x04 , INST_FUNCTION = 0x08 , INST_RF_GEN = 0x10 , INST_LOAD = 0x20 , INST_BERT = 0x40 , INST_MISC = 0x80 , INST_SWITCH_MATRIX = 0x100 } |
| Public Attributes inherited from Instrument | |
| std::string | m_nickname |
| Optional user-selected nickname of the instrument. More... | |
Detailed Description
Base class for instruments using USB HID communication protocol.
Member Function Documentation
◆ SendReport()
|
protected |
The documentation for this class was generated from the following files:
- lib/scopehal/HIDInstrument.h
- lib/scopehal/HIDInstrument.cpp
