Main Content

SCI Read

Read N-by-1 array of data on UART

expand all in page
  • SCI Read block

Libraries:
Embedded Coder Support Package for STMicroelectronics STM32 Processors / STM32F746G-Discovery
Embedded Coder Support Package for STMicroelectronics STM32 Processors / STM32F769I-Discovery
Embedded Coder Support Package for STMicroelectronics STM32 Processors / STM32L475VG-Discovery (B-L475E-IOT01A)
Simulink Coder Support Package for STMicroelectronics Nucleo Boards / Common

Description

The SCI Read block reads an N-by-1 array of data from the Universal Asynchronous Receiver Transmitter (UART), where N is the length of data to be read. You can change the Baudrate and select the Receive pin for the UART Serial Communication Interface (SCI) from Configuration Parameters > Hardware Implementation pane > SCI.

During external mode simulation, the block outputs the simulation results returned from the executable running on the target hardware. During simulation in all other modes, the block outputs zeroes.

This block operates in nonblocking mode.

Ports

Output

expand all

The port outputs the data read from the selected UART.

Data Types: int8 | uint8 | int16 | uint16 | int32 | uint32 | single | double

When you select the Output error status parameter, an output port, labeled as Status, becomes available.

The port outputs the status of each read request as mentioned in the following table:

Return status codes

StatusDescription
0SUCCESS
1RX_BUSY
2TX_BUSY
4PARITY_ERROR
8FRAME_ERROR
16BUS_ERROR
32DATA_NOT_AVAILABLE

When the length of data received is greater than or equal to the length specified in the Data length (N) parameter, the output is 0. Otherwise, the output is a nonzero value, indicating that the length of data available is less than the length specified in the Data length (N) parameter.

0 indicates a successful read operation.

For example, when the length of data received is 9 and N = 8, the Status port outputs 0 indicating a successful read operation. When the length of data received is 9 and N = 10, the Status port outputs 32 indicating that data is not available.

Length of Data Received = 9
PortData TypeData Length
N = 8N = 9N = 10
Rxuint8899
Statusuint80032

Dependencies

To enable the port, select the Output status parameter.

Data Types: uint8

Parameters

expand all

SCI module to which the SCI device is connected.

Note

In external mode, the SCI0 module is reserved for external mode communication and cannot be used by the SCI Read block.

Data type of data to be read from the UART port.

Number of data points to be read from the UART port for the selected data type.

Select this parameter to enable the Status port.

Frequency at which to read data from the UART port, specified in seconds. When you set this parameter to -1, Simulink determines the best sample time for the block based on the block context within the model.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2018a

See Also