ivi

README

ivi

Go-based implementation of the Interchangeable Virtual Instrument (IVI) standard.

Overview

The IVI Specifications developed by the IVI Foundation provide standardized APIs for programming test instruments. This package is a partial, Go-based implementation of the IVI Specifications, which are specified for C, COM, and .NET.

The main advantage of the ivi package is not having to learn the SCPI commands for each individual piece of test equipment. For instance, both the Agilent 33220A and the Stanford Research Systems DS345 function generators can be programmed using one standard API. The only requirement for this is having an IVI driver for the desired test equipment.

Currently, ivi doesn't cache state. Every time an attribute is read directly from the instrument. Development focus is currently on fleshing out the APIs and creating a few IVI drivers for each instrument type.

Installation

$ go get github.com/gotmc/ivi

Usage

The ivi package requires receiving an Instrument interface. The following gotmc packages meet the Instrument interface:

• visa — Calls lxi or usbtmc as needed, so that you can identify instruments using a VISA resource address string.
• lxi — Used to control LXI enabled instruments via Ethernet.
• usbtmc — Used to control USBTMC compliant instruments via USB.
• prologix — Used to communicate with instruments using a Prologix GPIB
• controller.

Examples

Examples can be found at https://github.com/gotmc/ivi-examples.

Documentation

Documentation can be found at either:

• https://godoc.org/github.com/gotmc/ivi
• http://localhost:6060/pkg/github.com/gotmc/ivi/ after running $ godoc -http=:6060

Contributing

Contributions are welcome! To contribute please:

1. Fork the repository
2. Create a feature branch
3. Code
4. Submit a pull request

Testing

Prior to submitting a pull request, please run:

$ make check

To update and view the test coverage report:

$ make cover

License

ivi is released under the MIT license. Please see the LICENSE.txt file for more information.

Documentation

Index

• func QueryID(q Querier) (string, error)
• func Set(sw StringWriter, format string, a ...interface{}) error
• type Inherent
  • func NewInherent(inst Instrument, base InherentBase) Inherent
  • func (inherent *Inherent) Clear() error
  • func (inherent *Inherent) Disable() error
  • func (inherent *Inherent) FirmwareRevision() (string, error)
  • func (inherent *Inherent) InstrumentManufacturer() (string, error)
  • func (inherent *Inherent) InstrumentModel() (string, error)
  • func (inherent *Inherent) InstrumentSerialNumber() (string, error)
  • func (inherent *Inherent) Reset() error
• type InherentBase
• type Instrument
• type Querier
• type StringWriter

Functions

func QueryID

func QueryID(q Querier) (string, error)

QueryID queries the identity of the instrument.

func Set

func Set(sw StringWriter, format string, a ...interface{}) error

Set formats according to a format specifier and then writes the resulting string to the given StringWriter interface.

Types

type Inherent

type Inherent struct {
	InherentBase
	// contains filtered or unexported fields
}

Inherent provides the inherent capabilities for all IVI instruments.

func NewInherent

func NewInherent(inst Instrument, base InherentBase) Inherent

NewInherent creates a new Inherent struct using the given Instrument interface and the InherentBase struct.

func (*Inherent) Clear

func (inherent *Inherent) Clear() error

Clear clears the instrument.

func (*Inherent) Disable

func (inherent *Inherent) Disable() error

Disable places the instrument in a quiescent state as quickly as possible. Disable provides the method described in Section 6.4 of IVI-3.2: Inherent Capabilities Specification.

func (*Inherent) FirmwareRevision

func (inherent *Inherent) FirmwareRevision() (string, error)

FirmwareRevision queries the instrument and returns the firmware revision of the instrument. FirmwareRevision is the getter for the read-only inherent attribute Instrument Firmware Revision described in Section 5.18 of IVI-3.2: Inherent Capabilities Specification.

func (*Inherent) InstrumentManufacturer

func (inherent *Inherent) InstrumentManufacturer() (string, error)

InstrumentManufacturer queries the instrument and returns the manufacturer of the instrument. InstrumentManufacturer is the getter for the read-only inherent attribute Instrument Manufacturer described in Section 5.19 of IVI-3.2: Inherent Capabilities Specification.

func (*Inherent) InstrumentModel

func (inherent *Inherent) InstrumentModel() (string, error)

InstrumentModel queries the instrument and returns the model of the instrument. InstrumentModel is the getter for the read-only inherent attribute Instrument Model described in Section 5.20 of IVI-3.2: Inherent Capabilities Specification.

func (*Inherent) InstrumentSerialNumber

func (inherent *Inherent) InstrumentSerialNumber() (string, error)

InstrumentSerialNumber queries the instrument and returns the S/N of the instrument.

func (*Inherent) Reset

func (inherent *Inherent) Reset() error

Reset resets the instrument.

type InherentBase

type InherentBase struct {
	ClassSpecMajorVersion     int
	ClassSpecMinorVersion     int
	ClassSpecRevision         string
	GroupCapabilities         []string
	SupportedInstrumentModels []string
	IDNString                 string
}

InherentBase provides the exported properties for the inherent capabilities of all IVI instruments.

type Instrument

type Instrument interface {
	Read(p []byte) (n int, err error)
	Write(p []byte) (n int, err error)
	StringWriter
	Querier
}

Instrument provides the interface required for all IVI Instruments.

type Querier

type Querier interface {
	Query(s string) (value string, err error)
}

Querier provides the interface to query using a given string and provide the resultant string.

type StringWriter

type StringWriter interface {
	WriteString(s string) (n int, err error)
}

StringWriter provides the interface to write a string.