/* ---------------------------------------------------------------------------
 * testaio.h                                            (c) 2008 Micro-key bv
 * ---------------------------------------------------------------------------
 * Micro-key bv
 * Industrieweg 28, 9804 TG Noordhorn
 * Postbus 92, 9800 AB Zuidhorn
 * The Netherlands
 * Tel: +31 594 503020
 * Fax: +31 594 505825
 * Email: support@microkey.nl   
 * Web: www.microkey.nl
 * ---------------------------------------------------------------------------
 * Description: 
 * Headerfile for analogue Testfile testaio.c
 * ---------------------------------------------------------------------------
 * Version(s):  0.1, Sep 08, 2008, MMi
 *                   Creation.
 * ---------------------------------------------------------------------------
 */
#ifndef TESTAIO_H_
#define TESTAIO_H_

/* ---------------------------------------------------------------------------
 * System include files.
 * ---------------------------------------------------------------------------
 */
#include "lpc23xx.h"
#include "types.h"

/* ---------------------------------------------------------------------------
 * Application include files.
 * ---------------------------------------------------------------------------
 */

/* ---------------------------------------------------------------------------
 * Constant and macro definitions.
 * ---------------------------------------------------------------------------
 */

/* ---------------------------------------------------------------------------
 * Type definitions.
 * ---------------------------------------------------------------------------
 */

/* ---------------------------------------------------------------------------
 * Variable declarations.
 * ---------------------------------------------------------------------------
 */

/* ---------------------------------------------------------------------------
 * Function declarations.
 * ---------------------------------------------------------------------------
 */

/* ---------------------------------------------------------------------------
 * Function: testioStart
 * 
 * Main Function of Analogue Tests.
 * 
 * Parameters: void
 * 
 * Return : BOOLEAN - Test Result
 * ---------------------------------------------------------------------------
 */
BOOLEAN testaioStart (void);               /* Test analog Input/Output */

/* ---------------------------------------------------------------------------
 * Function: doAIOVoltageTest / doAIOCurrentTest
 * 
 * Function to test every single analogue Output and Input (either V or C)
 * 
 * Parameters: void
 * 
 * Return : BOOLEAN - Test Result
 * ---------------------------------------------------------------------------
 */
BOOLEAN doAIOVoltageTest (void);

BOOLEAN doAIOCurrentTest (void);


/* ---------------------------------------------------------------------------
 * Function: CheckAllOtherAIOZero
 * 
 * Function to check if all other analogue Inputs but the chosen one is 
 * Zero or below a certain test Limit.
 * 
 * Parameters:  UINT32 AIONumber - currently tested Input
 *              BOOLEAN local    - check either local or remote lines
 * 
 * Return : BOOLEAN - Test Result
 * ---------------------------------------------------------------------------
 */
BOOLEAN CheckAllOtherAIOZero (UINT32 AIONumber, BOOLEAN local);


/* ---------------------------------------------------------------------------
 * Function: Set AnalogueInput
 * 
 * Function to set Inputs either to Voltage or Current Mode
 * 
 * Parameters: BOOLEAN isCurrent - Indicates if Voltage or Current Mode
 * 
 * Return : void
 * ---------------------------------------------------------------------------
 */
void SetAnalogueInput(BOOLEAN isCurrent);


/* ---------------------------------------------------------------------------
 * Function: testSlaveAnalogueLines
 * 
 * Main function to remote AIO Test
 * 
 * Parameters: void
 * 
 * Return : BOOLEAN - TestResult
 * ---------------------------------------------------------------------------
 */
BOOLEAN testSlaveAnalogueLines (void);


/* ---------------------------------------------------------------------------
 * Function: remoteaioOutput
 * 
 * Function to test remote analogue Outputs
 * 
 * Parameters: BOOLEAN testmodeVOLTAGE - test in voltage (TRUE) or current
 *                                       (FALSE) mode
 * 
 * Return : BOOLEAN - Test Result
 * ---------------------------------------------------------------------------
 */
BOOLEAN remoteaioOutput (BOOLEAN testmodeVOLTAGE);


/* ---------------------------------------------------------------------------
 * Function: remoteaioInput
 * 
 * Function to test remote analogue Inputs
 * 
 * Parameters: BOOLEAN testmodeVOLTAGE - test in voltage (TRUE) or current
 *                                       (FALSE) mode
 * 
 * Return : BOOLEAN - Test Result
 * ---------------------------------------------------------------------------
 */
BOOLEAN remoteaioInput (BOOLEAN testmodeVOLTAGE);

#endif /*TESTAIO_H_*/