1. AS59099V2_0.zip Driver
2. AX5008.TXT File Contents

AX5008.TXT Driver File Contents (AS59099V2_0.zip)

[AX5008 - 8 Ch. Relay Actuator & Isolated D/I Board]

Function:
   ax5008Init

Description:
   Initialize the device.

   int ax5008Init(int base_addr, int function);
   base_addr: I/O base address of the device.
   function: Function ID.

Remarks:
   This function should be called once before the device performming any data
   I/O functions. The function ID could be either of the constants listing below
   or any combinition of them:
      ID_FUNC_DI
      ID_FUNC_DO
      ID_FUNC_ALL

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.


Function: ax5008Term

Description:
   Terminate the device driver.

   int ax5008Term(int base_addr);
   base_addr: I/O base address of the device.

Remarks:
   This function should be called once if the device will no longer performming
   any data I/O functions. Usually at the end of you data acquisition/control
   processes.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.


Function:
   ax5008GetDevAtbu

Description:
   Retrieve the device attribute.

   int ax5008GetDevAtbu(LPDEVATBU lpDevAtbu);
   lpDevAtbu: Pointer to the DEVATBU struct, which stores the device attribute.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.


Function:
   ax5008DI

Description:
   Digital input function for a specified channel.

   int ax5008DI(int base_addr, int chan, int* data);
   base_addr: I/O base address of the device.
   chan: Channel to perform DI function.
   data: Storage for digital input status.

Remarks:
   This function will retrieve the one and only specified channel for it's
   digital input status. The status value will stored in the third parameter,
   data, where '1' stands for 'HIGH' status, and '0' for 'LOW' one.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.


Function:
   ax5008DI_P

Description:
   Digital input function for a specified port(8-bit).

   int ax5008DI_P(int base_addr, int* data);
   base_addr: I/O base address of the device.
   data: Storage for digital input status.

Remarks:
   This function will retrieve all the digital input status of channels in
   the same port at one time.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.


Function:
   ax5008DO

Description:
   Digital output function for the specified channel.

   int ax5008DO(int base_addr, int chan, int data);
   base_addr: I/O base address of the device.
   chan: channel to proform digital output function.
   data: Digital output status.0:LOW, 1:HIGH.

Remarks:
   Use this function to output a LOW or HIGH signal to the specified channel.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.



Function:
   ax5008DO_P

Description:
   Digital output function for a specified port(8-bit).

   int ax5008DO_P(int base_addr, int data);
   base_addr: I/O base address of the device.
   data: Digital output status for a port(8-channel).

Remarks:
   Use this function to output signals(LOW/HIGH) at one time for channels in
   the same port.

Return Values:
   This function will return an error code defined in the ERROR CODE LIST of
   AXDDR include file(axddr.h). Please be sure to check this returned value to
   determine whether the function call succeed or not. If there're no any error
   occured, the return value should be ERR_NOERR. Otherwise, the value will be
   the one defined in ERROR CODE LIST.