COMM-DRV/Lib: Serial Communicaton Library Online Documentation

Manual for free windows serial communication library

1. License
2. Getting Started
3. Function Calls
   • BytesInReceiveBuffer() Returns the number of bytes in the receive buffer.
   • BytesInTransmitBuffer() Returns the number of bytes in the transmit buffer.
   • CdrvCheckTime() Determine if time expired form a previous call to CdrvSetTime().
   • CdrvClearAbort() Returns COMM-DRV/Lib to non-abort state.
   • CdrvDelay() Delay specified time.
   • CdrvSetTime() Sets a timer to a specified delay. Expiration is tested by CdrvCheckTime().
   • CdrvSetTimeoutFunction() Sets the address of a function that gets called when Delay() or CdrvCheckTime() is called.
   • CdrvSetTimerResolution() Sets the timer resolution used by CdrvSetTime() and Delay().
   • CloseComPort() Close the communication port.
   • DtrOff() Turns DTR off.
   • DtrOn() Turns DTR on.
   • FlushReceiveBuffer() Discards the contents of the receive buffer.
   • FlushTransmitBuffer() Discards the contents of the transmit buffer.
   • GetByte() Gets a byte from the receive buffer.
   • GetPaceTime() Get the current inter-character pace time.
   • GetPacket() Gets a packet from receive buffer.
   • GetString() Gets a carriage return, line feed, or null terminated string from receive buffer.
   • GetTimeout() Get the current timeout value.
   • IsBreak() Returns true if a break signal was detected.
   • IsCarrierDetect() Returns true if carrier detected.
   • IsCts() Returns true if CTS signal high.
   • IsDsr() Returns true if DSR signal high.
   • IsFramingError() Returns true if a framing error occurred.
   • IsInputOverrun() Returns true if the COMM-DRV receive buffer was overrun.
   • IsOverrunError() Returns true if the UART receive register was overrun.
   • IsParityError() Returns true if a parity error occurred.
   • IsPortAvailable() Determine if a particular port is in use.
   • IsReceiveBufferEmpty() Returns true if receive buffer is empty.
   • IsRing() Returns true if ring detected.
   • IsTransmitBufferEmpty() Returns true if transmit buffer is empty.
   • OpenComPort() – Open serial port (COM port)
   • PeekChar() Returns the next character from receive buffer non-destructively.
   • PutByte() Queues a byte for transmission.
   • PutPacket() Queues a packet for transmission.
   • PutString() Outputs a null terminated string.
   • ReceiveBufferSize() Returns the receive buffer size.
   • RtsOff() Turns RTS off.
   • RtsOn() Turns RTS on.
   • SendBreak() Sends a break signal.
   • SetBaud() Sets new baud rate.
   • SetFlowControlCharacters() Sets characters used for flow control.
   • SetFlowControlThreshold() Sets high and low receive buffer thresholds.
   • SetPaceTime() Sets the current inter-character pace time.
   • SetPortCharacteristics() Set line control parameters(baudrate, length, parity,etc.).
   • SetTimeout() Sets the current transmit/receive timeouts.
   • SpaceInReceiveBuffer() Returns space unused in receive buffer.
   • SpaceInTransmitBuffer() Returns space unused in transmit buffer.
   • TransmitBufferSize() Returns transmit buffer size.

   MODEM FUNCTIONS

   • Dial() Dials using the modem with the Hayes command set.
   • ModemAnswerMode() Puts modem in answer mode.
   • ModemAttention() Puts modem in command state.
   • ModemConnect() Returns true if modem connection attained.
   • ModemGetCarrierSpeed() Returns carrier speed.
   • ModemGetConnectSpeed() Returns connect speed.
   • ModemHangup() Hangup modem connection.
   • ModemInit() Set modem initialization string.
   • ModemWaitforConnect() Effects a modem connection that is abortable.

   FILE TRANSFER FUNCTIONS

   • cdrvxfer_files() Transmit or receive file(s) with specified protocol to completion.
   • FileTransferDialog() Enables an automatic dialog to be displayed on some of the file transfer functions.
   • XferFiles() Iterative simplified transfer function.

   GUI FUNCTIONS

   • CdrvLInitDialog() Displays dialog box for port characteristics input.
4. Appendix