Abort the on-going read transfer.

It is safe to call abort_read() when there is no on-going transaction.

Abort the on-going write transfer.

It is safe to call abort_write() when there is no on-going transaction.

Attach a function to call whenever a serial interrupt is generated.

Parameters

func	A pointer to a void function, or 0 to set as none
type	Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Set the baud rate of the serial port.

Parameters

baudrate

The baudrate of the serial port (default = 9600).

Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.

Enable serial input.

If both serial input and serial output are disabled, the peripheral is freed. If either serial input or serial output is re-enabled, the peripheral is reinitialized.

On re-initialization rx interrupts will be enabled if a rx handler is attached. The rx handler is called once during re-initialization.

Enable serial output.

If both serial input and serial output are disabled, the peripheral is freed. If either serial input or serial output is re-enabled, the peripheral is reinitialized.

On re-initialization tx interrupts will be enabled if a tx handler is attached. The tx handler is called once during re-initialization.

Set the transmission format used by the serial port.

Parameters

bits	The number of bits in a word (5-8; default = 8)
parity	The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
stop_bits	The number of stop bits (1 or 2; default = 1)

Begin asynchronous reading using 8bit buffer.

The read operation ends with any of the enabled events and invokes registered callback function (which can be empty to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_read() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of RX events that should end operation
char_match	The matching character

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Begin asynchronous reading using 16bit buffer.

The read operation ends with any of the enabled events and invokes registered callback function (which can be empty to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_read() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of RX events that should end operation
char_match	The matching character

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Determine if there is a character available to read.

Returns

1 if there is a character available to read, 0 otherwise

Generate a break condition on the serial line.

Generate a break condition on the serial line NOTE: Clear break needs to run at least one frame after set_break is called.

Configure DMA usage suggestion for non-blocking RX transfers.

Parameters

usage

The usage DMA hint for peripheral

Returns

Zero if the usage was set, -1 if a transaction is on-going

Configure DMA usage suggestion for non-blocking TX transfers.

Parameters

usage

The usage DMA hint for peripheral

Returns

Zero if the usage was set, -1 if a transaction is on-going

Set the flow control type on the serial port.

Parameters

type	the flow control type (Disabled, RTS, CTS, RTSCTS)
flow1	the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
flow2	the second flow control pin (CTS for RTSCTS)

Set the flow control type on the serial port.

Parameters

type	the flow control type (Disabled, RTS, CTS, RTSCTS)
pinmap	reference to structure which holds static pinmap

Begin asynchronous write using 8bit buffer.

The write operation ends with any of the enabled events and invokes registered callback function (which can be empty to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_write() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of TX events that should end operation

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Begin asynchronous write using 16bit buffer.

The write operation ends with any of the enabled events and invokes registered callback function (which can be empty to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_write() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of TX events that should end operation

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Determine if there is space available to write a character.

Returns

1 if there is space to write a character, 0 otherwise