Documentation

Stream Output

Write formatted ASCII data to port or file

Library

Simulink® Desktop Real-Time™

Description

Write formatted ASCII data to a port or file. After you have added a Stream Output block to your model, double-click the Stream Output block to open the Block Parameters: Stream Output dialog box.

The driver must be Standard Devices > Serial Port, Standard Devices > File, or Standard Devices > UDP Protocol. When you install a UDP device, enter port addresses in decimal format in the Standard Devices UDP Protocol dialog box.

Any serial output port can send data with sample rates up to 500 Hz. To enable a faster sample rate of up to 10 kHz for some output serial ports, click Install new board, select Standard Devices > Serial Port, and select Direct port access.

The software does not support this option with all types of serial output hardware.

Parameters

Install new board

Click this button to register a board with Simulink Desktop Real-Time.

When you click Install new board, the software displays a list of manufacturers of supported boards. When you select a manufacturer, the software displays a list of boards available from that manufacturer. When you select a board, the software adds the board to the list of registered boards and makes that board the current board.

By default, the initial selection in the list of registered boards is < no board selected >. When you select a board in the list, the Delete current board and Board setup buttons become active.

Delete current board

Click this button to delete the current board. The initial selection of the list of registered boards changes to < no board selected >, and the Delete current board and Board setup buttons become inactive.

Board setup

Click this button to set up the board.

A board-specific dialog box opens for you to use to set up the board. For more information to set up the board, see the board manufacturer documentation.

Sample time

Enter a value representing how frequently you want the block to execute and interact with the I/O hardware. The block also synchronizes your model with the real-time clock at this sample rate.

    Tip   If you are using a fixed-step solver, you must enter the value that you entered in the Fixed step size box in the Configuration Parameters dialog box, or an integer multiple of that value.

Maximum missed ticks

In Normal Mode, enter the number of timer ticks that your model can lag behind the real-time kernel. When the model lags by this number or less, the software assumes that the lag is temporary and allows the model to catch up, even if the model misses some ticks. When the model lags by more than this number, the software reports an error and simulation stops.

In External Mode, the software ignores this value.

Show "Missed Ticks" port

In Normal Mode, select this check box to display the number of missed ticks as a block output.

In External Mode, The "Missed Ticks" port displays zero.

Yield CPU when waiting

In Normal Mode, select this check box to grant other programs more CPU time while the kernel waits for a response from the hardware.

In External Mode, the software ignores this value.

Input port sizes

Enter a port width, or vector of port widths. The number of elements determines the number of input ports. Each port has the width specified by the corresponding element. For example, specifying 3,1,2 indicates that the block has three input ports. The first is a vector of width 3, the second is a scalar, and the third is a vector of width 2, for a total of six elements. You specify only the widths.

Format string

Enter a specification in the same format used by C library I/O routines like printf. The format string describes the data to be sent. The format string must have the same number of specifiers as the sum of the elements of Input port sizes.

For example, assume that Input port sizes is 3,1,2. Then a Format string of '%d %d %d %f %d %d' outputs ASCII representing: three integers from the vector on the first input port; a double from the scalar on the input second port; and two integers from the vector on the third input port.

If the data type specified in the Format string for a value differs from the type of the actual value, type conversion occurs, and converted data that conforms to the Format string is output as ASCII to the device.

Show "Data Ready" port

Select this check box to indicate that the block has an output port that signals 1 if the block is ready to accept new data, and 0 otherwise.

Show "Data Error" port

Select this check box to indicate that the block has an output port that signals 1 if a data error has occurred, and 0 otherwise.

Initial string

Optional. Enter a string. Before any other data that is output during simulation, Initial string is sent when simulation begins.

The string can contain anything. You can use it to initialize a device. It is sent literally as specified, without translation using Format string.

Final string

Optional. Enter a string. After any other data that is output during simulation, Final string is sent when simulation ends.

The string can contain anything. You can use it to shut down a device. It is sent literally as specified, without translation using the Format string

Was this topic helpful?