7526 DCT Reference


Summary List of the 7526 DCT Microcode APIs

summary list of the 7526 DCT microcode APIs

These APIs are detailed beginning on page reference #8, where the parameters and return values are shown for each reference of each function. In addition to the return codes shown, E_Internal may be returned if the DCT detects an internal system error which should not occur during normal operation.

Serial Ports

Note:

Serial port functions are available in microcode V3.00 and above when an optional Ethernet-Serial-Parallel or Serial-Parallel card is installed.
ComInit ( port number, baud rate, parity, stopbits, databits)
Sets the parameters for an optional RS-232 serial port, purging any data in the port buffers in the process.
ComQuery ( port number, returned data buffer )
Retrieves the current serial port settings (baud, parity, stop bits, and data bits).
ComRead ( port number, max read length, read buffer, length read )
Reads up to a maximum number of characters from the incoming character buffer for the desired serial port.
ComWrite ( port number, write length, write buffer, length written )
Copies data from a user write buffer to the serial port output buffer, and causes the transmission to begin.

DI/DO Port

DiCtrRead (DI point, value)
Reads a DI counter
DiCtrWrite (DI point, value)
Writes to a DI counter
DidoRead (character for all 8 points)
Reads all of the DI/DO points
DidoWrite (character for all 8 points)
Writes all 8 DO points
DoWritePoint (point, value, time)
Writes one DO point 0-7

Keypad

KbdReadAscii (make code)
Returns the next make code in ASCII form
KbdSetMode(keylock_mode, clear_mode, adjustment_mode)
Determines how contrast adjust, beeper adjust, clear and keylock keys are handled in a CFR

Printer Port

PrtChar (character)
Adds a character to the printer buffer. Available in V2.00 and above.
PrtInit (no parameters)
Initializes the printer-DI/DO port to be a printer port. Available in V2.00 and above.
PrtQuery (port status, POST result)
Returns the status of the printer status lines. Available in V2.00 and above.
PrtQueryData (buffer space used, space available)
Returns the number of characters left to print. Available in V2.00 and above.
PrtSetBuffer (new printer buffer, buffer size)
Changes the address of the printer buffer. Available in V2.00 and above.
PrtSetStatus (set the autofeed line)
Modifies the printer status output lines. Available in V2.00 and above.
PrtStr (string to print, string length)
Adds a string to the printer buffer. Available in V2.00 and above.

Date/Time

RtcGetAsciiDate (format, ASCII date, default_format)
Returns the date in an ASCII string
RtcGetAsciiTime (format, ASCII time, default_format)
Returns the time in an ASCII string

Sensor Input Ports

SenActLed (LED number, duration)
Lights the sensor port or panel LEDs for a specified duration
SenQueryPort (port)
Returns the port number of the most recent sensor read
SenQueryPort2 (port, direction)
Returns the port number of the most recent sensor read and the direction of the read. Available in V2.00 and above.
SenRead (buffer, length of buffer)
Returns the next sensor data record available
SenSetDiscrimGrp (bar code, i2of5len)
Sets the native bar code and Interleaved 2 of 5 length

Speaker

SpkBeep (volume, duration)
Sounds the speaker

Timers

TimerSetAlarm (character)
Sets alarms to trigger at selected times throughout the day.
TimerClearAlarm (no parameters)
Clears all alarms set by the TimerSetAlarm function.
TimerSetInterval (port status, POST result)
Sets alarms to trigger at a user specified interval.
TimerClearInterval (no parameters)
Clears all interval alarm set by the TimerSetInterval function.
TimerSetAlarmAsynch (set the autofeed line)
Set timers to trigger DO points at selected times throughout the day.
TimerClearAlarmAsynch (no parameters)
Clears all alarms set by the TimerSetAlarmAsynch function.

LCD Display

VioClear (no parameters)
Clears the video display
VioGetCurPos (row, column)
Returns the current cursor row and column position
VioQuery (rows, columns, cursor type, video mode, char set)
Returns the current video configuration information
VioReadCharStr (string, length, row, column, transfer count, cursor move)
Reads a character string from the display
VioSetCurPos (row, column)
Sets the cursor at the indicated row and column
VioSetCurType (cursortype)
Sets the specified cursor type
VioWrtCharStr (string, length, row, column, transfer count, cursor move)
Writes a character string to the display

General Support

AliasTransID (newid)
Sets the transaction event identification of the current transaction record
ClearUserVariable (user_variable)
Clears the specified user variable or the transaction buffer (accesses up to 256 user variables)
ClearUserVariable2 (user_variable)
Clears the specified user variable or the transaction buffer (accesses up to 999 user variables) Available in V2.00 and above.
DataFile (name, pointer to file, size of file)
Returns a pointer to a validation file, and the file size
GetTerminalAddress (address)
Returns the address that the terminal is using for communications. Available in V2.00 and above.
HitWatchdog (no parameters)
Pulses the watchdog timer to prevent a DCT reset
PntrFile0 (pointer to file 0)
Returns a pointer to file 0
IdleManager (delay count)
Allows other tasks to run
ReadUserVariable (user variable, data)
Returns the contents of a user variable in the data area allocated by the CFR (accesses up to 256 user variables)
ReadUserVariable2 (user variable, data)
Returns the contents of a user variable in the data area allocated by the CFR (accesses up to 999 user variables) Available in V2.00 and above.
SendTransaction (no parameters)
Sends a transaction from a CFR
Validation (filename, data)
Performs validation in local files. Also performs validation at the terminal controller in V2.00 and above.
WriteToTrans (data)
Appends data to a transaction
WriteUserVariable (user variable, data)
Appends data to a user variable (accesses up to 256 user variables)
WriteUserVariable2 (user variable, data)
Appends data to a user variable (accesses up to 999 user variables) Available in V2.00 and above.