/*	**************************************************************  */
/*
 *	Module GP3
 *	This module contains I/O functions for the Group3 teslameter.                 
 *
 *	Zachary Wolf
 *	1/24/00
 */ 

/*	**************************************************************  */

/*	INCLUDES  */
#include <utility.h>
#include <gpib.h>
#include <formatio.h>
#include <ansi_c.h>
#include "gp3.h"

/*	**************************************************************  */

/*  PRIVATE FUNCTIONS  */
int gp3_open_dev(int gpib_board_addr, int gpib_dev_addr);
void gp3_close_dev(int dev_ID);
int gp3_check_dev_open(int dev_ID);
int gp3_out(int dev_ID, char* buf);
int gp3_in(int dev_ID, char* buf);
int gp3_get_errors(int dev_ID);
void gp3_message(char* msg);
void gp3_error(char* msg);

/*	**************************************************************  */

/*  PRIVATE DEVICE TABLE  */
/*
 *	This table allows several devices of the same type to be
 *	used in the system.
 *  dev_addr, contains the GPIB addresses of opened devices
 *  dev_descr, contains the device descriptors of opened devices
 *  dev_count, contains the number of devices open of this type
 */
static int dev_addr[GP3_MAX_NUM_DEV + 1];
static int dev_descr[GP3_MAX_NUM_DEV + 1];
static int dev_count;

/*	**************************************************************  */

/*  PRIVATE GLOBAL VARIABLES  */
/*
 *  cmd, buffer for GPIB I/O strings
 *  msg, buffer for message strings to Standard I/O
 */
static char cmd[GP3_MAX_CMD + 1];
static char msg[GP3_MAX_CMD + 1];

/*	**************************************************************  */

/*	PUBLIC FUNCTIONS  */

/*	**************************************************************  */
/*
 *  gp3_init
 *  This function opens the device, queries for ID, and
 *  initializes the device to a known state.
 *
 *	Input:
 *	gpib_board_addr, address of the GPIB board the device is connected to (0, 1, ...)
 *	gpib_dev_addr, GPIB address of the device (1 to 30, 0 is reserved)
 *
 *	Output:
 *	dev_ID, identifier for future references to the device
 *
 *	Zachary Wolf
 *	1/24/00
 */

void gp3_init(int gpib_board_addr, int gpib_dev_addr, int* ID)
{
    /* Declare variables */
    int dev_ID;
    int err;
    int i;
    
    /* Message */
    gp3_message("");
    gp3_message("Initializing the Group3 Teslameter...");

    /* Check input parameters */
    if (gpib_board_addr < 0 || gpib_board_addr > 10)
    {
    	Fmt(msg, "%s<gpib_board_addr = %i, out of range", gpib_board_addr);
    	gp3_error(cmd);
    	return;
    }
    if (gpib_dev_addr < 1 || gpib_dev_addr > 30)
    {
    	Fmt(msg, "%s<gpib_dev_addr = %i, out of range", gpib_dev_addr);
    	gp3_error(msg);
    	return;
    }
    
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	*ID = 1;
    	return;
    #endif
    
    /* Open the GP3 */
    dev_ID = gp3_open_dev(gpib_board_addr, gpib_dev_addr);
    if (dev_ID <= 0)
    {
        gp3_error("GP3 was not opened");
        return;
    }
    
    /* Put the teslameter in a known default state */
    gp3_default_setup(dev_ID);

	/* Return the device ID */
    *ID = dev_ID;
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_default_setup
 *  This function sets up the teslameter in a default state.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	1/25/00
 */

void gp3_default_setup(int dev_ID)
{
	/* Declare variables */
	int i;
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > GP3_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	gp3_error(msg);
    	return;
    }
    
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = gp3_check_dev_open(dev_ID);
    if (dev_open != 1)
    {
    	gp3_error("Device not open");
    	return;
    }
    
    /* Reset the teslameter */
    Fmt(cmd, "%s<%c", 24);		/* CTRL X */
    gp3_out(dev_ID, cmd);
    Delay(3.);
    gp3_in(dev_ID, msg);
    printf("%s\n", msg);
    
    /* Set up the teslameter */
    gp3_out(dev_ID, "GD");		/* Put the DTM in DC measurement mode */
    gp3_out(dev_ID, "GC");		/* Measure continuously */
    gp3_out(dev_ID, "D0");		/* Turn off digital filtering */
    gp3_out(dev_ID, "NN");		/* Use the normal display mode */
    gp3_out(dev_ID, "SM0");		/* Send readings only when requested */
    gp3_out(dev_ID, "SU0");		/* Do not send units */
    gp3_out(dev_ID, "UFT");		/* Set the units to Tesla */
    
    /* Check for errors */
    err = gp3_get_errors(dev_ID);
    if (err != 0)
    {
        gp3_error("The teslameter has an error");
        gp3_close_dev(dev_ID);
        return;
    }
    
    /* Display status information */
    gp3_out(dev_ID, "IG");
    gp3_in(dev_ID, msg);
    printf("Status: %s", msg);
    gp3_out(dev_ID, "IN");
    gp3_in(dev_ID, msg);
    printf("  %s", msg);
    gp3_out(dev_ID, "IR");
    gp3_in(dev_ID, msg);
    printf("  %s\n", msg);
    
    /* Check for errors */
    err = gp3_get_errors(dev_ID);
    if (err != 0)
    {
        gp3_error("The teslameter has an error");
        gp3_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_set_range
 *  This function sets the range of the teslameter.
 *
 *	Input:
 *	dev_ID, device identifier
 *	range, range (0 = .3 T, 1 = .6 T, 2 = 1.2 T, 3 = 3.0 T)
 *
 *	Zachary Wolf
 *	1/24/00
 */

void gp3_set_range(int dev_ID, int range)
{
	/* Declare variables */
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > GP3_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	gp3_error(msg);
    	return;
    }
   if (range < 0 || range > 3)
    {
    	Fmt(msg, "%s<range = %i, out of range, adjusted, continuing...", range);
		gp3_message(msg);
		if (range < 0) range = 0;
		if (range > 3) range = 3;
    }
    
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = gp3_check_dev_open(dev_ID);
    if (dev_open != 1)
    {
    	gp3_error("GP3 not open");
    	return;
    }

    /* Set the range to the requested value */
    Fmt(cmd, "%s<R%i[w1]", range);
    gp3_out(dev_ID, cmd);
    Delay(2.);
    
    /* Check for errors */
    err = gp3_get_errors(dev_ID);
    if (err != 0)
    {
        gp3_error("The teslameter has an error");
        gp3_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_zero
 *  This function zeros all ranges of the teslameter.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	1/24/00
 */

void gp3_zero(int dev_ID)
{
	/* Declare variables */
	int err;
	int dev_open;
	int num_scan;
	int init_range, range;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > GP3_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	gp3_error(msg);
    	return;
    }
   
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = gp3_check_dev_open(dev_ID);
    if (dev_open != 1)
    {
    	gp3_error("Device not open");
    	return;
    }
    
    /* Get the initial range so the teslameter can be left with that range setting */
	gp3_out(dev_ID, "IR");
	gp3_in(dev_ID, msg);
	num_scan = Scan(msg, "%s>%i", &init_range);
    if (num_scan != 1)
    {
        gp3_message("The Group3 teslameter has an error during zeroing.");
        gp3_message("The range may change.");
        gp3_message(msg);
        init_range = 3;
    }

    /* Zero the teslameter on each range */
    for (range = 0; range <= 3; range++)
    {
    	gp3_set_range(dev_ID, range);
    	gp3_out(dev_ID, "Z");
    	Delay(2.);
    }
    
    /* Leave the teslameter with its original range setting */
    gp3_set_range(dev_ID, init_range);
    
    /* Check for errors */
    err = gp3_get_errors(dev_ID);
    if (err != 0)
    {
        gp3_error("The teslameter has an error");
        gp3_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_get_B
 *  This function gets the field reading from the teslameter.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	B, field reading (T)
 *
 *	Zachary Wolf
 *	1/24/00
 */

void gp3_get_B(int dev_ID, double* B)
{
	/* Declare variables */
	int dev_open;
	int err;
	int num_scan;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > GP3_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	gp3_error(msg);
    	return;
    }
    
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = gp3_check_dev_open(dev_ID);
    if (dev_open != 1)
    {
    	gp3_error("GP3 not open");
    	return;
    }

    /* Get the field reading */
    gp3_out(dev_ID, "F");
    gp3_in(dev_ID, msg);
    num_scan = Scan(msg, "%s>%f", B);
    if (num_scan != 1)
    {
    	printf("GP3 problem getting field reading: %s\n", msg);
    	printf("Returning B = 0. T\n");
    	printf("%c", 7);
    	*B = 0.;
    }
    
    /* Check for errors */
    err = gp3_get_errors(dev_ID);
    if (err != 0)
    {
        gp3_error("The teslameter has an error");
        gp3_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_exit
 *  This function configures the GP3 for program exit and
 *	closes the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	1/24/00
 */

void gp3_exit(int dev_ID)
{
	/* Declare variables */
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > GP3_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	gp3_error(msg);
    	return;
    }
    
    /* Exit here if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = gp3_check_dev_open(dev_ID);
    if (dev_open != 1)
    {
    	return;		 /* OK, already closed */
    }

	/* Close the device */
    gp3_close_dev(dev_ID);
    
    /* Done */
    return;
}

/*	**************************************************************  */

/*	PRIVATE FUNCTIONS  */

/*	**************************************************************  */
/*
 *	gp3_open_dev
 *	This function opens the device and returns an identifier for
 *	future references to the device.
 *
 *	Input:
 *	gpib_board_addr, address of the GPIB board the device is connected to
 *	gpib_dev_addr, GPIB address of the device (1 to 30, 0 is reserved)
 *
 *	Output:
 *	dev_ID, device identifier for future references to the device (-1 if there is a problem)
 *
 *	Zachary Wolf
 *	12/20/99
 */

int gp3_open_dev(int gpib_board_addr, int gpib_dev_addr)
{
	/* Declare variables */
    int i;
    int dev_ID;
    int descr;
    int err;

    /* Check input parameters */
    if (gpib_board_addr < 0 || gpib_board_addr > 10)
    {
    	Fmt(msg, "%s<gpib_board_addr = %i, out of range", gpib_board_addr);
    	gp3_error(cmd);
    	return -1;
    }
    if (gpib_dev_addr < 1 || gpib_dev_addr > 30)
    {
    	Fmt(msg, "%s<gpib_dev_addr = %i, out of range", gpib_dev_addr);
    	gp3_error(msg);
    	return -1;
    }

	/* Initialization */
    dev_ID = 0;

    /* Check to see if the device is already in the device table */
    for (i = 1; i <= GP3_MAX_NUM_DEV; i++)
    {
        if (dev_addr[i] == gpib_dev_addr)
        {
            dev_ID = i;
            return dev_ID;
        }
    }
    
    /* Find an ID for the device */
	for (i = 1; i <= GP3_MAX_NUM_DEV; i++)
	{
		if (dev_addr[i] == 0)
		{
			dev_ID = i;
			break;
		}
	}
     
    /* If an entry could not be opened in the device table, return an error */
    if (dev_ID <= 0)
    {
    	gp3_error("The device could not be opened");
        return  -1;
    }
    
    /* Open the device */
    /* Terminate write with LF EOI */
    /* Terminate read on LF, remove LF in read routine */
	descr = ibdev(gpib_board_addr, gpib_dev_addr, 0, T10s, 1, 0x1C0A);
	if (descr <= 0)
	{
		gp3_error("The device could not be opened");
		return  -1;
	}
    
    /* Open successful, save results */
    dev_addr[dev_ID] = gpib_dev_addr;
    dev_descr[dev_ID] = descr;
    dev_count++;
    
    /* Clear the device */
    err = ibclr(dev_descr[dev_ID]);
    if (err & 0x8000)
    {
    	gp3_error("Problem clearing device");
    }
    
    /* Return the device ID */
    return dev_ID;
}

/*	**************************************************************  */
/*
 *	gp3_close_dev
 *  This function closes the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	12/20/99
 */

void gp3_close_dev(int dev_ID)
{
	/* Close the device */
    if (dev_descr[dev_ID] != 0)
    {
        ibonl(dev_descr[dev_ID], 0);
        dev_descr[dev_ID] = 0;
        dev_addr[dev_ID] = 0;
        dev_count--;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	gp3_check_dev_open
 *  This function checks to see if the specified device is open.
 *	If the device has been opened, a 1 is returned, 0 otherwise.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	status, 1 if device is open, 0 otherwise
 *
 *	Zachary Wolf
 *	12/20/99
 */

int gp3_check_dev_open(int dev_ID)
{
	/* See if the device descriptor has a positive value */
    if (dev_descr[dev_ID] > 0)
    {
        return  1;		/* Open */
    }
    else
    {
	    return 0;		/* Not open */
	}
}

/*	**************************************************************  */
/*
 *	gp3_out
 *  This function writes a buffer of data to the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *	buf, null terminated string, the contents up to \0 are sent
 *
 *	Output:
 *	err, 0 if ok, -1 otherwise
 *
 *	Zachary Wolf
 *	1/24/00
 */

int gp3_out(int dev_ID, char* buf)
{
	/* Declare variables */
	int nbytes;
	int err;
	char out_buf[GP3_MAX_CMD + 1];
	
	/* Add LF to the message */
	Fmt(out_buf, "%s<%s%c", buf, 10);
	
	/* Send the message */
	nbytes = StringLength(out_buf);
	err = ibwrt(dev_descr[dev_ID], out_buf, (long)nbytes);
	
	/* Check for errors */
	if (err & 0x8000)
	{
		Fmt(msg, "%s<ibsta = %x, problem sending GPIB command", err);
		gp3_error(msg);
		return -1;
	}
	
	/* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	gp3_in
 *  This function reads a buffer of data from the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	buf, null terminated string, the contents from the device
 *	err, 0 if ok, -1 otherwise
 *
 *	Zachary Wolf
 *	1/24/00
 */

int gp3_in(int dev_ID, char* buf)
{
	/* Declare variables */
	int err;
	char in_buf[GP3_MAX_CMD];
	
	/* Read the message */
	err = ibrd(dev_descr[dev_ID], in_buf, GP3_MAX_CMD);
	
	/* Check for errors */
	if (err & 0x8000)
	{
		Fmt(msg, "%s<ibsta = %x, problem receiving GPIB input", err);
		gp3_error(msg);
		return -1;
	}
	
	/* Remove the LF terminator */
	Scan(in_buf, "%l>%s[t-]", buf);
	
	/* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	gp3_get_errors
 *  This function obtains device errors.
 *	The operator is alerted if there is an error.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	err, 0 if no errors, -1 otherwise
 *
 *	Zachary Wolf
 *	12/20/99
 */

int gp3_get_errors(int dev_ID)
{
	/* Declare variables */
    int status;
    int num_scan;

	/* Check the response to a query */
	gp3_out(dev_ID, "IR");
	gp3_in(dev_ID, msg);
	
	/* Check the response */
	num_scan = Scan(msg, "%s>%i", &status);
    if (num_scan != 1)
    {
        gp3_message("The Group3 teslameter has an error.");
        gp3_message(msg);
        return -1;
    }
    
    /* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	gp3_message
 *  This function handles messages about the GP3.
 *
 *	Input:
 *	message, string to display in standard I/O
 *
 *	Zachary Wolf
 *	12/20/99
 */

void gp3_message(char* message)
{
	/* Print the message */
	printf("%s\n", message);
	
	/* Done */
	return;
}

/*	**************************************************************  */
/*
 *	gp3_error
 *  This function handles error messages for the GP3.
 *
 *	Input:
 *	message, string to display in standard I/O
 *
 *	Zachary Wolf
 *	12/20/99
 */

void gp3_error(char* message)
{
	/* Declare variables */
	char buf[80];
	
	/* Notify the operator of the error */
	printf("\nGP3 ERROR: %s\n", message);
	Beep();
	Delay(.5);
	Beep();
	
	/* Terminate the program if the operator desires */
	printf("Press ENTER to continue.\nPress any key then ENTER to terminate program.\n");
	fgets(buf, 80, stdin);
	if (buf[0] == '\n') return;
	else exit(0);
}