A miscellaneous instrument which provides access to an Antikernel Labs GPIO bridge. More...

#include <AntikernelLabsGPIO.h>

Inheritance diagram for AntikernelLabsGPIO:

[legend]

Collaboration diagram for AntikernelLabsGPIO:

[legend]

Public Member Functions
	AntikernelLabsGPIO (SCPITransport *transport)
	Initialize the driver.

virtual uint32_t	GetInstrumentTypes () const override
	Returns a bitfield describing the set of instrument types that this instrument supports.

virtual uint32_t	GetInstrumentTypesForChannel (size_t i) const override
	Returns a bitfield describing the set of instrument types that a given channel supports.

virtual bool	AcquireData () override
	Pull data from the instrument.

	MISC_INITPROC (AntikernelLabsGPIO)

Public Member Functions inherited from SCPIInstrument
	SCPIInstrument (SCPITransport *transport, bool identify=true)

virtual std::string	GetTransportConnectionString () override
	Gets the connection string for our transport.

virtual std::string	GetTransportName () override
	Gets the name of our transport.

virtual std::string	GetName () const override

virtual std::string	GetVendor () const override

virtual std::string	GetSerial () const override

virtual std::string	GetDriverName () const =0

virtual void	BackgroundProcessing () override
	Run various background processing typically done by a second thread (e.g. InstrumentThread)

Public Member Functions inherited from Instrument
virtual bool	IsOffline ()
	Checks if the instrument is currently online.

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.

virtual std::string	GetChannelDisplayName (size_t i)
	Gets the hardware display name for a channel. This is an arbitrary user-selected string.

virtual void	SetChannelDisplayName (size_t i, std::string name)
	Sets the hardware display name for a channel. This is an arbitrary user-selected string.

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 void	FlushConfigCache ()
	Instruments are allowed to cache configuration settings to reduce round trip queries to the device.

virtual YAML::Node	SerializeConfiguration (IDTable &table) const
	Serializes this instrument's configuration to a YAML node.

virtual void	LoadConfiguration (int version, const YAML::Node &node, IDTable &idmap)
	Load instrument and channel configuration from a save file.

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.

Public Member Functions inherited from SCPIDevice
	SCPIDevice (SCPITransport *transport, bool identify=true, unsigned int identify_timeout_us=5000000)

	SCPIDevice (const SCPIDevice &rhs)=delete

SCPIDevice &	operator= (const SCPIDevice &rhs)=delete

SCPITransport *	GetTransport () const

Static Public Member Functions
static std::vector< SCPIInstrumentModel >	GetDriverSupportedModels ()

static std::string	GetDriverNameInternal ()
	Returns the constant driver name.

Static Public Member Functions inherited from SCPIMiscInstrument
static void	DoAddDriverClass (const std::string &name, MiscCreateProcType proc)

static void	EnumDrivers (std::vector< std::string > &names)

static std::shared_ptr< SCPIMiscInstrument >	CreateInstrument (const std::string &driver, SCPITransport *transport)

Static Public Member Functions inherited from SCPIInstrument
static void	DoAddDriverClass (const std::string &name, GetTransportsProcType proc)

static std::vector< SCPIInstrumentModel >	GetSupportedModels (const std::string &driver)

static std::vector< SCPIInstrumentModel >	GetDriverSupportedModels ()

Protected Member Functions
void	DoPreLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &list)
	Validate instrument and channel configuration from a save file.

Protected Member Functions inherited from SCPIInstrument
void	DoSerializeConfiguration (YAML::Node &node, IDTable &table)

Protected Attributes
bool	m_cachedConfigValid

uint32_t	m_cachedTris

uint32_t	m_cachedOut

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 SCPIMiscInstrument
typedef std::shared_ptr< SCPIMiscInstrument >(*	MiscCreateProcType) (SCPITransport *)

Public Types inherited from SCPIInstrument
typedef std::vector< SCPIInstrumentModel >(*	GetTransportsProcType) ()

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.

Protected Types inherited from SCPIMiscInstrument
typedef std::map< std::string, MiscCreateProcType >	MiscCreateMapType

Protected Types inherited from SCPIInstrument
typedef std::map< std::string, GetTransportsProcType >	GetTransportMapType

Static Protected Attributes inherited from SCPIMiscInstrument
static MiscCreateMapType	m_misccreateprocs

Static Protected Attributes inherited from SCPIInstrument
static GetTransportMapType	m_getTransportProcs

Detailed Description

A miscellaneous instrument which provides access to an Antikernel Labs GPIO bridge.

Constructor & Destructor Documentation

◆ AntikernelLabsGPIO()

AntikernelLabsGPIO::AntikernelLabsGPIO ( SCPITransport * transport )

Initialize the driver.

Parameters

transport SCPITransport pointing at the instrument

Member Function Documentation

◆ AcquireData()

bool AntikernelLabsGPIO::AcquireData ( )

overridevirtual

Pull data from the instrument.

Returns: True if waveform was acquired, false if connection lost or other serious error

Implements Instrument.

◆ GetInstrumentTypes()

uint32_t AntikernelLabsGPIO::GetInstrumentTypes ( ) const

overridevirtual

Returns a bitfield describing the set of instrument types that this instrument supports.

Not all types may be available on a given channel.

Implements Instrument.

◆ GetInstrumentTypesForChannel()

uint32_t AntikernelLabsGPIO::GetInstrumentTypesForChannel ( size_t i ) const

overridevirtual

Returns a bitfield describing the set of instrument types that a given channel supports.

Parameters

i	Channel index

Implements Instrument.

The documentation for this class was generated from the following files:

lib/scopehal/AntikernelLabsGPIO.h
lib/scopehal/AntikernelLabsGPIO.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AntikernelLabsGPIO()

Member Function Documentation

◆ AcquireData()

◆ GetInstrumentTypes()

◆ GetInstrumentTypesForChannel()