Admin at 09:46, 24 August 2013

2013-08-24T09:46:24Z

Admin: Created page with "= Action = Clear serial input or output buffer ..."

2013-02-07T18:04:17Z

Created page with "= Action = Clear serial input or output buffer ..."

New page

= Action =

Clear serial input or output buffer

 

 

= Syntax =

CLEAR bufname

 

 

= Remarks =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="604" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
Bufname

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
Serial buffer name to clear.

 

SERIALIN, SERIALIN0 - COM1/UART0 input buffer

SERIALIN2 - COM2/UART1 input buffer

SERIALIN3 - COM3/UART2 input buffer

SERIALIN4 - COM4/UART3 input buffer

 

SERIALOUT,SERIALOUT0 - COM1/UART0 output buffer

SERIALOUT1 - COM2/UART1 output buffer

SERIALOUT2 - COM3/UART2 output buffer

SERIALOUT3 - COM4/UART3 output buffer

|}
</div>
 

When you use buffered serial input or buffered serial output, you might want to clear the buffer.

While you can make the head pointer equal to the tail pointer, an interrupt could be active which might result in an update of the buffer variables, resulting in an unexpected result.

The CLEAR statement will reset the head and tail pointers of the ring buffer, and it will set the buffer count variable to 0. The buffer count variable is new and introduced in 1.11.8.3. It counts how many bytes are in the buffer.

The internal buffercount variable is named _RS_BUFCOUNTxy , where X is R for Receive, and W for Write, and y is 0 for the first UART, and 1 for the second UART.

 

 

= See also =

[[CONFIG SERIALIN|CONFIG SERIALIN]] , [[CONFIG SERIALOUT|CONFIG SERIALOUT]]

 

 

= ASM =

Calls _BUF_CLEAR from MCS.LIB

 

 

= Example =

 <source lang="bascomavr">
CLEAR SERIALIN
</source> {{Languages}}

[[Category:BASCOM Language Reference]]

@@ Line 34: / Line 34: @@
 SERIALIN4 - COM4/UART3 input buffer
 &nbsp;
@@ Line 44: / Line 54: @@
 SERIALOUT3 - COM4/UART3 output buffer
 |}

CLEAR - Revision history

Admin at 09:46, 24 August 2013

Admin: Created page with "= Action = Clear serial input or output buffer ..."