Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Serial Instr

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Inherits from I/O Session class.

Long Name Description
Serial Settings:Parity Specifies the parity used with every frame that is transmitted or received. Valid values include: (0) Parity None, (1) Parity Odd, (2) Parity Even, (3) Parity Mark, (4) Parity Space. Mark means that the parity bit exists and is always 1. Space means that the parity bit exists and is always 0. Details
Serial Settings:Number of Bytes at Serial Port Returns the number of bytes currently available at the serial port used by this session. Details
Serial Settings:Data Bits Specifies the number of data bits contained in each frame. Valid values include 5-8. Details
Serial Settings:Modem Line Settings:Line DCD State Specifies the current state of the Data Carrier Detect (DCD) input signal. This is often used by modems to indicate the detection of a carrier (modem) on the phone line. This signal is also known as Receive Line Signal Detect (RLSD). This property is read only except when the Wire Mode property is set to RS232/DCE, or RS232/AUTO with the hardware currently in the DCE state. Details
Serial Settings:Modem Line Settings:Break State Sets manual control of the serial port's break state. If asserted, this property suspends character transmission and places the transmission line in a break state until this property is unasserted. If you want VISA to send a break signal after each write operation automatically, use the Break Length (Break Len) and End Mode for Writes (ASRL End Out) properties instead. The default is Unasserted. Details
Serial Settings:Error Replacement Character Specifies the character to use to replace incoming characters that arrive with errors (such as a parity error). The default is 0. Details
Serial Settings:Wire Mode Specifies the current wire/transceiver mode. For RS485 hardware, this property is valid only with the RS485 serial driver developed by National Instruments. For RS232 hardware, the values RS232/DCE and RS232/AUTO are valid only with RS232 serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. When this feature is not supported, RS232/DTE is the only valid value. Details
Serial Settings:Discard NUL Characters Specifies whether to discard each data byte whose value is 0. If this property is TRUE, read operations discard NUL characters. If this property is FALSE, read operations treat NUL characters as normal data characters. For binary transfers, set this property to FALSE. The default is FALSE. Details
Serial Settings:Stop Bits Specifies the number of stop bits used to indicate the end of a frame. Valid values include: (10) Stop One, (15) Stop One-and-a-Half, (20) Stop Two. Details
Serial Settings:Flow Control Specifies the flow control method used for both transmitting and receiving data. Valid values include: (0) Flow None, (1) Flow XON/XOFF, (2) Flow RTS/CTS, (3) Flow XON/XOFF and RTS/CTS, (4) Flow DTR/DSR, (5) Flow XON/XOFF and DTR/DSR. Certain values or combinations of values may not be supported by all serial ports and/or operating systems. Details
Message Based Settings:Suppress End Enable Specifies whether to terminate a read operation due to an END condition. This property is relevant only in VISA Read and related operations. Details
Message Based Settings:File Append Enable Specifies whether VISA Read To File appends or overwrites (truncates) when opening a file. If this property is set to TRUE, VISA Read To File appends when opening a file. If this property is set to FALSE, VISA Read To File overwrites (truncates) when opening a file. The default is FALSE. Details
Serial Settings:Modem Line Settings:Line DSR State Returns the current state of the Data Set Ready (DSR) input signal. Details
Serial Settings:End Mode for Reads Specifies the method used to terminate read operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar. If the value is (2) TermChar, then the value of the property Termination Character Enable (TermChar En) is ignored. The default is (2) TermChar. Details
Serial Settings:End Mode for Writes Specifies the method used to terminate write operations. Valid values include: (0) None, (1) Last Bit, (2) TermChar, (3) Break. The default is (0) None. Details
Serial Settings:Is Port Connected Returns whether the port is properly connected to another port or device. This property is valid only with serial drivers developed by National Instruments and documented to support this feature with the corresponding National Instruments hardware. Details
General Settings:Allow DMA Transfers Specifies whether I/O accesses should attempt to use DMA (TRUE) or Programmed I/O (FALSE). In some implementations, this property may have global effects even though it is documented as a local property. This behavior affects performance and not functionality. Details
Serial Settings:Flow Control XON Character Specifies the value of the XON character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x11 (Control-Q). Details
Serial Settings:Modem Line Settings:Line DTR State Asserts or unasserts the Data Terminal Ready (DTR) output signal manually. Details
Serial Settings:Allow Transmit Specifies whether to allow transmission. If FALSE, the serial port suspends transmission as if an XOFF character has been received. If TRUE, it resumes transmission as if an XON character has been received. If XON/XOFF flow control (software handshaking) is not being used, FALSE is an invalid value. The default is TRUE. Details
Message Based Settings:IO Protocol Specifies which protocol to use. In VXI, you can choose normal word serial or fast data channel. In GPIB, you can choose normal or high-speed HS-488 transfers. In serial, TCP/IP, or USB, you can choose normal transfers or 488.2-defined strings. In USBTMC, you can choose normal or vendor-specific transfers. The default is Normal. Details
Serial Settings:Modem Line Settings:Line RI State Specifies the current state of the Ring Indicator (RI) input signal. The RI signal is often used by modems to indicate that the telephone line is ringing. This property is read only except when the Wire Mode property is set to RS232/DCE or to RS232/AUTO with the hardware currently in the DCE state. Details
Serial Settings:Break Length Specifies the duration (in milliseconds) of the break signal asserted when End Mode for Writes (ASRL End Out) is set to Break (3). Valid values include 1-500. The default is 250. If you want to control the assertion state and length of a break signal manually, use the VISA Serial Break VI instead. Details
Serial Settings:Baud Rate Specifies the baud rate of the given communications port. Details
Message Based Settings:Termination Character Enable Specifies whether a read operation terminates when it receives the termination character. The default is FALSE. Details
Message Based Settings:Termination Character Specifies a character that, when read, causes a read operation to terminate. The termination character also must be enabled. This default is 0x0A (linefeed). Details
Serial Settings:Modem Line Settings:Line RTS State Asserts or unasserts the Request To Send (RTS) output signal manually. When the flow control is set to hardware handshaking, it is invalid to change this property. Details
Serial Settings:Modem Line Settings:Line CTS State Returns the current state of the Clear To Send (CTS) input signal. Details
Message Based Settings:Send End Enable Specifies whether to send an END indicator on the last byte of each write operation. This property is relevant only in VISA Write and related operations. The default is TRUE. Details
Serial Settings:Flow Control XOFF Character Specifies the value of the XOFF character used for XON/XOFF flow control (both directions). If XON/XOFF flow control (software handshaking) is not being used, the value of this property is ignored. The default is 0x13 (Control-S). Details

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit