Click or drag to resize

SerialPortAPI Class

Provides access to SerialPort handling operations.
Inheritance Hierarchy
SystemObject
  RAYLASE.SPICE3.ClientLibSpice3API
    RAYLASE.SPICE3.ClientLibSerialPortAPI

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.6.0
Syntax
C#
public class SerialPortAPI : Spice3API

The SerialPortAPI type exposes the following members.

Methods
 NameDescription
Public methodGetConfig Gets the current configuration from the card.
Public methodLoadConfig Loads the current configuration from the card's local storage.
Public methodReceiveBytes Receives a binary message of a specified length via the card's serial port, waiting up to the configured ReadTimeout period.
Public methodReceiveLine Receives a string of characters and the configured end-of-line sequence via the card's serial port, waiting up to the configured ReadTimeout period.
Public methodReceiveString Receives a string of characters via the card's serial port, waiting up to the configured ReadTimeout period.
Public methodSetConfig Sets the current configuration on the card.
Public methodStoreConfig Stores the current configuration in the card's local storage for later (re-)loading.
Public methodTransmit(Byte) Sends a binary message via the card's serial port.
Public methodTransmit(String) Sends a string of characters via the card's serial port.
Public methodTransmitLine Sends a string of characters and the configured end-of-line sequence via the card's serial port.
Public methodTryVerifyResponse(Byte, Byte) Sends a binary message via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Public methodTryVerifyResponse(String, String) Sends a string of characters via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Public methodTryVerifyResponseLine Sends a string of characters and the configured end-of-line sequence via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Public methodVerifyResponse(Byte, Byte) Sends a binary message via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Public methodVerifyResponse(String, String) Sends a string of characters via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Public methodVerifyResponseLine Sends a string of characters and the configured end-of-line sequence via the card's serial port, and waits up to the configured ReadTimeout period for the expected response.
Top
See Also