lxi's Introduction

lxi

Go-based implementation of the LAN eXtensions for Instrumentation (LXI) standard.

Overview

This packages enables controlling LXI compatible test equipment (e.g., oscilloscopes, function generators, multimeters, etc.) over Ethernet. While this package can be used by itself to send Standard Commands for Programmable Instruments (SCPI) commands to a piece of test equipment, it also serves to provide an Instrument interface for both the ivi and visa packages. The ivi package provides standardized APIs for programming test instruments following the Interchangeable Virtual Instrument (IVI) standard.

Installation

$ go get github.com/gotmc/lxi

Documentation

Documentation can be found at either:

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

Contributing

Contributions are welcome! To contribute please:

Fork the repository
Create a feature branch
Code
Submit a pull request

Testing

Prior to submitting a pull request, please run the tests using either GNU Make:

$ make check
$ make lint

or you can use Just:

$ just check
$ just lint

To update and view the test coverage report using Make run:

$ make cover

or you can use Just:

$ just cover

License

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

lxi's People

Contributors

Stargazers

Watchers

lxi's Issues

make bufio.Reader a member of lxi.Device

Hello,

I would suggest to make the bufio.Reader instantiated in the Query method a member of the Device struct.

There are multiple potential problems with the existing code.

The reader may read more data than the line, if possible. This data will be lost.
The reader allocates buffers for buffering data and the reader object. This creates pressure on the GC.

By making the Reader a member of the Device struct, it becomes persistant as well as its buffers and the data it contains. Is it still possible to use the Read methods and even read bytes per bytes, but efficiently.

Change the Device into this:

type Device struct {
	conn net.Conn
	rdr *bufio.Reader
}

The NewDevice function becomes:

func NewDevice(address string) (*Device, error) {
	v, err := NewVisaResource(address)
	if err != nil {
		return nil, err
	}
	tcpAddress := fmt.Sprintf("%s:%d", v.hostAddress, v.port)
	c, err := net.Dial("tcp", tcpAddress)
	if err != nil {
		return nil, err
	}
	return &Device{conn: c, rdr: bufio.NewReader(c)}, nil
}

Note that the convention is to return a nil Device in case of error.

The Read function becomes:

// Read reads from the network connection into the given byte slice.
func (d *Device) Read(p []byte) (n int, err error) {
	return d.rdr.Read(p)
}

The Close function becomes:

// Close closes the underlying network connection.
func (d *Device) Close() error {
	d.rdr = nil
	c := d.conn
	d.conn = nil
	return c.Close()
}

And Query becomes:

func (d *Device) Query(cmd string) (string, error) {
	err := d.Command(cmd)
	if err != nil {
		return "", err
	}
	return d.rdr.ReadString('\n')
}

Recommend Projects

gotmc / lxi Goto Github PK

lxi's Introduction

lxi

Overview

Installation

Documentation

Contributing

Testing

License

lxi's People

Contributors

Stargazers

Watchers

Forkers

lxi's Issues

make bufio.Reader a member of lxi.Device

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent