https://github.com/gotmc/prologix
Go package for the Prologix GPIB controllers
https://github.com/gotmc/prologix
gpib gpib-controllers gpib-device gpib-ethernet prologix-controller prologix-web scpi scpi-commands scpi-instruments scpi-lab-instruments test-automation test-equipment usbtmc
Last synced: 4 months ago
JSON representation
Go package for the Prologix GPIB controllers
- Host: GitHub
- URL: https://github.com/gotmc/prologix
- Owner: gotmc
- License: mit
- Created: 2020-01-07T03:00:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T19:34:29.000Z (almost 2 years ago)
- Last Synced: 2024-09-22T09:17:49.569Z (over 1 year ago)
- Topics: gpib, gpib-controllers, gpib-device, gpib-ethernet, prologix-controller, prologix-web, scpi, scpi-commands, scpi-instruments, scpi-lab-instruments, test-automation, test-equipment, usbtmc
- Language: Go
- Homepage:
- Size: 78.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# prologix
Go package to communicate with either a [Prologix][prologix-web] GPIB-ETHERNET
(GPIB-LAN) controller or a GPIB-USB (HPIB-USB) controller.
[![GoDoc][godoc badge]][godoc link]
[![Go Report Card][report badge]][report card]
[![License Badge][license badge]][LICENSE.txt]
## Overview
[Prologix][prologix-web] offers two GPIB controllers that enable a computer to
communicate over GPIB using either an Ethernet or USB interface. Both the
[GPIB-ETHERNET controller][gpib-ethernet] and the [GPIB-USB
controller][gpib-usb] can operate either in controller mode or device mode. In
controller mode, the GPIB-ETHERNET or GPIB-USB is the Controller-In-Charge
(CIC) on the GPIB bus. In device mode, the GPIB-ETHERNET or GPIB-USB acts a
GPIB device that is either a talker or a listener.
For more information, please see the User Manual and FAQ for either the
[GPIB-ETHERNET controller][gpib-ethernet] or the [GPIB-USB
controller][gpib-usb].
## Status
- **GPIB-USB Direct Driver:** Not implemented
- **GPIB Controller Mode:** Implemented. Provide an io.ReadWriter from a serial
port to use the Prologix GPIB-USB Controller as a Virtual COM Port (VCP) or
provide an io.ReadWriter from a network connection to use the Proglogix
GPIB-ETHERNET Controller.
- **GPIB Device Mode:** Not implemented
## IVI Support
The [prologix][] package can be used in conjunction with the [ivi][] package,
which is a Go-based implementation of the Interchangeable Virtual Instrument
(IVI) standard. The [IVI Specifications][ivi-specs] developed by the IVI
Foundation provide standardized APIs for programming test instruments.
The main advantage of using the [ivi][] package is not having to learn the
[SCPI][] commands for each individual piece of test equipment. For instance,
both the Agilent 33220A function generator and the Stanford Research Systems
DS345 function generator can be programmed using one standard API with IVI.
## Methods for Communication
The Prologix GPIB controller strips all unescaped LF (`\n`, ASCII 10), CR
(`\r`, ASCII 13), ESC (ASCII 27), and `+` (ASCII 43) characters. Therefore, to
send binary data including one of those characters, they must be escaped.
- `Read(p []byte) (n int, err error)` — Use for reading binary or text data
from the instrument or Prologix controller.
- `Write(p []byte) (n int, err error)` — Use to send binary data to the
instrument. The CR, LF, ESC, and `+` characters will be automatically
escaped.
- `WriteString(s string) (n int, err error` — Use to send ASCII data to the
instrument or commands to the Prologix controller.
- `Command(format string, a ...interface{}) error` — Use to send a SCPI command
to the instrument that has no response. A newline character will
automatically be appended to the SCPI command sent to the instrument.
- `Query(cmd string) (string, error)` — Use to send a SCPI query command to the
instrument and receive a string response. A newline character will
automatically be appended to the SCPI command sent to the instrument. If the
Prologix controller is not in auto read-after-write mode, then a `++read eos`
will also be sent before reading.
## GPIB-USB
The GPIB-USB controller communicates with a computer either directly using the
D2XX driver or as a Virtual COM Port (VCP) using the FTDI FT245R driver.
### GPIB-USB VCP Driver Installation
The appropriate VCP driver for your operating system can be downloaded from the
[FTDI VCP Drivers webpage][ftdi-vcp-drivers]. Alternatively, on macOS you can use
[Homebrew][] to install the VCP driver as follows:
```bash
$ brew cask install ftdi-vcp-driver
```
### GPIB-USB D2XX Direct Driver Installation
The appropriate D2XX Direct Driver for your operating system can be downloaded
from the [FTDI D2XX Direct Drivers webpage][ftdi-d2xx-drivers]. Alternatively,
on macOS you can use [Homebrew][] to install the D2XX direct driver as follows:
```bash
$ brew install libftdi
```
## Contributing
To contribute, please fork the repository, create a feature branch, and then
submit a [pull request][].
## License
[prologix][prologix] is released under the MIT license. Please see the
[LICENSE.txt][] file for more information.
[ftdi-d2xx-drivers]: https://www.ftdichip.com/Drivers/D2XX.htm
[ftdi-vcp-drivers]: https://www.ftdichip.com/Drivers/VCP.htm
[godoc badge]: https://godoc.org/github.com/gotmc/prologix?status.svg
[godoc link]: https://godoc.org/github.com/gotmc/prologix
[gpib-ethernet]: http://prologix.biz/gpib-ethernet-controller.html
[gpib-usb]: http://prologix.biz/gpib-usb-controller.html
[homebrew]: https://brew.sh/
[ivi]: https://github.com/gotmc/ivi
[ivi-specs]: http://www.ivifoundation.org/
[LICENSE.txt]: https://github.com/gotmc/prologix/blob/master/LICENSE.txt
[license badge]: https://img.shields.io/badge/license-MIT-blue.svg
[prologix]: https://github.com/gotmc/prologix
[prologix-web]: http://prologix.biz/
[pull request]: https://help.github.com/articles/using-pull-requests
[report badge]: https://goreportcard.com/badge/github.com/gotmc/prologix
[report card]: https://goreportcard.com/report/github.com/gotmc/prologix
[scpi]: http://www.ivifoundation.org/scpi/