flush(peripheral)

flush(peripheral)

Description

Flush selected peripheral internal buffer.

Syntax

flush(peripheral);

Parameters

Variable

Input

Variable

Input

peripheral

RS232 - for flushing RS232 buffer.

RS485 - for flushing RS485 buffer.

CAN1 - for flushing CAN1 buffer.

CAN2 - for flushing CAN2 buffer.

Remote_Command - for flushing Remote command buffer.

Returns

Return value

Return explanation

SCRIPT_OPERATION_SUCCESS

Successfully flushed peripheral.

SCRIPT_OPERATION_FAILED

Failed to flush peripheral.

SCRIPT_NO_ACCESS

Peripheral was not initialized.

Function call example

flush() example
main() { flush(RS232); for(;;) { Delay(1000); } }

Notes and Warnings

flush(CAN1); or flush(CAN2); flushes only buffer and does not resets any of the can filters or masks.

flush(RS232) or flush(RS485) flushes buffer even if transmission is in progress which results in data loss. For this reason it is recommended to flush before transmitting instead of after.