Documentation

Packet Output

Write unformatted binary data to port, file, or CAN device

Library

Simulink® Desktop Real-Time™

Description

Connect to and write unformatted binary data to a port, file, or CAN device. After you add a Packet Output block to your model, double-click the block to set its parameters.

The driver must be Standard Devices > Serial Port, Standard Devices > UDP Protocol, Standard Devices > File, or Vector > CAN Device. 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.

Packet identifier

Enter the ID of the packet to process. If your protocol does not have packet IDs, this parameter is disabled.

Extended identifier

Select this check box if Packet identifier is an extended identifier.

Output packet size

Enter the number of bytes to be transmitted in the output packet. This number must be the same as the number of bytes required by the type specifications in Output packet field data types.

Output packet field data types

Enter a string, or a cell array of strings, that specifies how data provided by the application will be formatted into a packet for output to the device. The Packet Output block has an input port corresponding to each string in Output packet field data types. Changing the number of strings changes the number of ports.

Each string has the format [n*]datatype. The data that the string describes has the type specified by datatype and the width specified by n, or 1 if n is not specified. For example, 'double' means one double value, and '4*int8' means a vector of four int8 values. You can also type 'CAN_MESSAGE' to specify a single CAN_MESSAGE value.

The signal input to each port of the Packet Output block can be a scalar or vector of the data type. The string for each port specifies the type to be used when its signal is output to the device. If the format string for a port matches the type of the signal input to that port, the signal value appears verbatim in the output packet.

You can also perform type conversion on output. For example, if an input signal is a four-element int16 vector, but the corresponding string is '4*int8', each of the four integers is converted to an int8 before being written to the packet. The resulting data occupies four bytes in the output packet.

    Note:   The software forces an out-of-range value to the maximum value for that data type.

Output packet field byte order

From the list, select:

  • Little Endian (default) — Receive multibyte values in little-endian format.

  • Big Endian — Receive multibyte values in big-endian format.

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 value

Optional. Enter a vector that has the same number of elements as the sum of the widths of the input signals across all ports. Before other data that is output during simulation is sent, the specified data is sent when simulation begins.

Final value

Optional. Enter a vector that has the same number of elements as the sum of the widths of the input signals across all ports. After other data that is output during simulation, the specified data is sent when simulation ends.

Was this topic helpful?