man8/HPBtaskGPIB

Table of Contents

Name

HPBtaskGPIB - Group 3 GPIB hall probe controller via serial to GPIB converter I/O service

Synopsis

HPBtaskGPIB <argument list>

Description

This program provides I/O service for a Group 3 hall probe controller using a Keithley 500 GPIB to serial converter.

Arguments

Argument processing is done using Unix long argument syntax.

The values of all the parameters listed here are printed on stderr when the program starts, whether or not they were supplied on the command line.

--dbman_host <hn>

The host where dbman is running.

If this option is not specified the default value is "localhost".

The DBMAN_HOST environment variable overrides the default if present and in turn is overridden by this argument.

--local <iopath>

The local device path to use when connecting locally.

Local or remote mode must be specified.

--remote <host>,<port>

The remote host and port to connect to for remote mode. The host can be a name or IP address. The port can be a name, or number.

Remote or local mode must be specified.

--label <label>

A label from the database.

This is a required argument.

--help

Prints the help message and exits.

Argument Usage

The local or remote option must be specified. Other than the options passed to remote, there is no set order required for any of the long options. In remote mode the port number is extracted from /etc/services or can be a numeric value.

Hall probe controller Database RefNames

These RefNames are expected by the program.

ResetSC


This is a command to the program to reinitialize the hall probe controller and resync it with the database.

This is a 1 bit control, nop/reset.

0.0 = nop
1.0 = reset

The control key should be set to Mom.

This parameter should be owned by whatever task HPBtaskGPIB registers as and the permissions set for direct update by users and direct update for the owner.

MfieldR


The field reading.

This parameter should have a range of +/- 20000 or more if the units are in gauss or a range of +/- 2 if the units are in tesla.

The control key doesn’t matter.

This parameter should be owned by whatever task HPBtaskGPIB registers as and the permissions set for none by users and direct update for the owner.

TR - optional


The temperature reading.

This parameter should have a range of +/- 100. The reading is in degrees Celsius.

The control key doesn’t matter.

This parameter should be owned by whatever task HPBtaskGPIB registers as and the permissions set for none by users and direct update for the owner.

RangeSel


Range Selection.

This is a two bit paramater. Valid values are:

0.0 - 0.3 tesla range.
1.0 - 0.6 tesla range.
2.0 - 1.2 tesla range.
3.0 - 3.0 tesla range.

The control key can be set to IncN, DecN, or IDecE. Usually IDecE is used.

This parameter should be owned by whatever task HPBtaskGPIB registers as and the permissions set for direct update by users and direct update for the owner.

HPB controller configuration

The program expects the hall probe controller to be located at GPIB address 1.

The switches inside of the hall probe controller should be set as follows:

SW1-1 - on - SW1-(1-5) GPIB address = 1
SW1-2 - off
SW1-3 - off
SW1-4 - off
SW1-5 - off
SW1-6 - off - dual address mode disabled
SW1-7 - off - talker/listener
SW1-8 - off - not used

SW2-1 - off - service requests disabled
SW2-2 - off - EOI not asserted
SW2-3 - off - terminator = line feed
SW2-4 - off - double terminator = disabled
SW2-5 - on - field units = gauss (this may depend on database)
SW2-6 - on - units symbol = symbol after data
SW2-7 - on - digital filtering (set for user preference)
SW2-8 - off - reset

The field units may be set for gauss or tesla depending on the database configuration. The program will process either type of message.

Digital filtering may be turned on or off depending on user requirements.

Communication port settings

When using com ports on the computer the following settings should be used: no echo, and raw mode. See the examples section for more information.

Note also that the number of stop bits and the character bit length may need to be set.

Similiar settings should be programmed into the terminal server when using remote mode.

I/O polling rates

Polling is normally performed at 1Hz. Fast polling is not supported.

Examples


#
# local port communication example
#
stty -echo < /dev/ttyS0
stty raw < /dev/ttyS0
stty 9600 < /dev/ttyS0
HPBtaskGPIB --dbman_host csdev1 --local /dev/ttyS0 --label "HPB 02-1"
#
# communication using a terminal server
#
HPBtaskGPIB --dbman_host csdev1 --remote csdev11,ETSraw1 --label "HPB 02-1"

Note that the label will need to be quoted for the shell to treat it as a single argument.

Notes

When the program is started or a reset is issued a ^x (control x) is sent to the hall probe controller. This will clear out any scaling, offset, or calibration factors entered into the hall probe controller. It has been found that these things often get scrambled (at least when using the gpib version). Code for setting these factors may be added to the program at some time in the future.

When the program is started it registers with dbman as HPBtask.

This program uses a line feed for the terminator char.

HPBtask(8) now reads the configuration switches to discover the terminator char, the field units, etc. Perhaps someday this program will be improved to do this also.

Manual page revision

$Id: HPBtaskGPIB.8,v 1.6 2007/07/17 16:18:45 kitchen Exp $


Table of Contents