API Reference


Functions:

     Here is a list of the functions which comprise the serial board API:

Constants:

     A number of constants and error codes have been defined in the header file for C/C++ and the module file for Visual Basic. Using these constants will make your code more readable and less prone to coding errors. These constants are listed below, along with the actual values of the constants. The value is included for informational purposes only. We encourage you to use the constants in your programs.

Error Codes:


Baud Rates:
I/O Port Configuration:

     There are a number of constants defined for use in configuring the I/O ports. These will be used when calling the ser_sr24_set_portmode() function. Note that this function is used for configuring several different properties of an I/O port. You must therefore pass a parameter indicating which property you want to change, as well as the value you want to assign to the property. For example, if you want to make Port 2 an output port, pass a constant which indicates you want to set the direction of the port; also pass a constant indicating that the port should be set to 'output'.

     The constants are listed below. Note that they are arranged logically -- all the possible values are listed below each port property. Also, a typical function call is shown for each property.




Back to Contents Winford Engineering (2000)