busio.UART¶

class circuitpython_mocks.busio.UART(tx: Pin, rx: Pin, **kwargs)[source]¶

A class that mocks busio.UART.

class circuitpython_mocks.busio.UART.Parity¶

A mock enumeration of busio.Parity.

ODD : Parity¶

EVEN : Parity¶

property baudrate : int¶

The current baudrate.

property in_waiting : int¶

The number of bytes in the input buffer, available to be read.

Mock Expectations

This property peeks at the number of bytes in next available operation in expectations. If a UARTRead operation is not immediately expected, then 0 is returned.

readinto(buf: array | bytearray | memoryview | rgbmatrix.RGBMatrix | ulab.numpy.ndarray) → int | None[source]¶

A function that mocks busio.UART.readinto.

Mock Expectations

This function checks against UARTRead expectations.

readline() → bytes | None[source]¶

A function that mocks busio.UART.readline.

Mock Expectations

This function checks against UARTRead expectations.

reset_input_buffer() → None[source]¶

Discard any unread characters in the input buffer.

Mock Expectations

This function merely checks the immediately queued expectations for a UARTFlush operation. It does not actually discard any data.

property timeout : float¶

The current timeout, in seconds.

write(buf: array | bytearray | bytes | memoryview | rgbmatrix.RGBMatrix | ulab.numpy.ndarray) → int | None[source]¶

A function that mocks busio.UART.write.

Mock Expectations

This function checks against UARTWrite expectations.

UART operations¶

class circuitpython_mocks.busio.operations.UARTRead(response: bytearray | None, **kwargs)[source]¶

A class to identify a read operation over a UART bus.

Tip

To emulate a timeout condition, pass a None value to the response parameter.

class circuitpython_mocks.busio.operations.UARTWrite(expected: bytearray, **kwargs)[source]¶

A class to identify a write operation over a UART bus.

class circuitpython_mocks.busio.operations.UARTFlush[source]¶

A class to identify a flush operation over a UART bus.

This operation corresponds to the function reset_input_buffer.