Back to Sealevel      

SeaMAX API


Detailed Description

The SeaMAX API consists of the functions outline below, and provides an easy-to-use interface for Sealevel I/O device configuration and access. For more information, click a function name below for detailed information on function use, parameter types, and return codes.

Note:
Not every function below may apply to your specific Sealevel I/O device. A complete list of of model specific SeaMAX API functions is available in the SeaMAX by Sealevel Model Number document.


Modules

 Deprecated Functions

Functions

int SM_Version (int *major, int *minor, int *revision, int *build)
 Returns the SeaMAX library's version info as major.minor.revision.build.
int SM_Open (SM_HANDLE *handle, char *connection)
 Opens a connection to a Sealevel I/O module.
int SM_ConfigureSerialConnection (SM_HANDLE handle, int baudrate, int parity)
 Configures the local PC's serial port baudrate (For Serial Connections Only).
int SM_ConfigureSerialTimeouts (SM_HANDLE handle, int multiple, int constant, int interval)
 Configures the local PC's serial port timeout parameters (For Serial Connections Only).
int SM_Close (SM_HANDLE handle)
 Closes the SeaMAX handle and releases all allocated memory.
int SM_SelectDevice (SM_HANDLE handle, int slaveID)
 Targets a new Modbus device.
int SM_GetConfig (SM_HANDLE handle, int *model, int *commType, int *baudrate, int *parity)
 Queries the Sealevel I/O module to determine the module model number, type, baudrate, and parity.
int SM_GetAnalogInputConfig (SM_HANDLE handle, unsigned char *reference, unsigned char *mode)
 Gets the device's analog configuraton.
int SM_GetAnalogInputRanges (SM_HANDLE handle, unsigned char *ranges)
 Gets the device's analog inputs range configuraton.
int SM_SetAnalogInputConfig (SM_HANDLE handle, unsigned char reference, unsigned char mode)
 Sets the device's analog configuraton.
int SM_SetAnalogInputRanges (SM_HANDLE handle, unsigned char *ranges)
 Sets the device's analog inputs range configuraton.
int SM_GetAnalogOutputRanges (SM_HANDLE handle, unsigned char *ranges)
 Polls the Sealevel I/O device for it's analog hardware jumper configuration.
int SM_GetPIOPresets (SM_HANDLE handle, unsigned char *config)
 Retrieves a Sealevel I/O module's programmable IO bit presets.
int SM_SetPIOPresets (SM_HANDLE handle, unsigned char *config)
 Configures a Sealevel I/O module's programmable IO bit presets.
int SM_GetPIODirection (SM_HANDLE handle, unsigned char *config)
 Retrieves a Sealevel I/O module's programmable IO direction.
int SM_SetPIODirection (SM_HANDLE handle, unsigned char *config)
 Configures a Sealevel I/O module's programmable IO direction.
int SM_ReadPIO (SM_HANDLE handle, unsigned char *values)
 Reads the entire I/O space of a Sealevel programmable IO device.
int SM_WritePIO (SM_HANDLE handle, unsigned char *values)
 Writes the IO space of a programmable I/O Sealevel I/O module.
int SM_SetCommunications (SM_HANDLE handle, int baudrate, int parity)
 Configures a Sealevel I/O module's communication parameters.
int SM_SetSoftwareAddress (SM_HANDLE handle, int slaveID)
 Configure's a Sealevel I/O module's software selectable Modbus slave ID (Modbus devices only).
int SM_ReadDigitalOutputs (SM_HANDLE handle, int start, int number, unsigned char *values)
 Reads the current state of one or more digital outputs.
int SM_ReadDigitalInputs (SM_HANDLE handle, int start, int number, unsigned char *values)
 Reads the current state of one or more digital inputs.
int SM_ReadAnalogInputs (SM_HANDLE handle, int start, int number, double *analogValues, unsigned char *ranges, unsigned char *byteValues)
 Reads one or more Sealevel I/O device analog input(s).
int SM_WriteDigitalOutputs (SM_HANDLE handle, int start, int number, unsigned char *values)
 Writes the state of one or more digital outputs.
int SM_WriteAnalogOutputs (SM_HANDLE handle, int start, int number, double *analogValues, unsigned char *ranges, unsigned char *byteValues)
 Writes one or more analog outputs.
int SM_NotifyInputState (SM_HANDLE handle, int cancel)
 Checks or cancels the notify input state status.
int SM_NotifyOnInputChange (SM_HANDLE handle, int start, int number, unsigned char *values, int delay, int blocking)
 Continuously reads the discrete inputs until a change occurs.

 
 
Generated on 18 Sep 2007.