Serial api files – ProSoft Technology MVI69-ADM User Manual
Page 66

Understanding the MVI-ADM API
MVI-ADM ♦ 'C' Programmable
Developer's Guide
'C' Programmable Application Development Module
Page 66 of 342
ProSoft Technology, Inc.
February 20, 2013
3.8
Serial API Files
The following table lists the supplied API file names. These files should be copied
to a convenient directory on the computer where the application is to be
developed. These files need not be present on the module when executing the
application.
File Name
Description
MVIspapi.h
Include file
MVIspapi.lib
Library (16-bit OMF format)
3.8.1 Serial API Architecture
The serial API communicates with foreign serial devices via industry standard
UART hardware.
The API acts as a high level interface that hides the hardware details from the
application programmer. The primary purpose of the API is to allow data to be
transferred between the module and a foreign device. Because each foreign
device is different, the communications protocol used to transfer data must be
device specific. The application must be programmed to implement the specific
protocol of the device, and the data can then be processed by the application
and transferred to the control processor.
Note: Care must be taken if using PRT1 (COM1) when the console is enabled or the Setup jumper
is installed. If the console is enabled, the serial API will not be able to change the baud rate on
PRT1. In addition, console functions such as keyboard input may not behave properly while the
serial API has control of PRT1. In general, this situation should be avoided by disabling the console
when using PRT1 with the serial API.