Main Content

UDP Receive

Receive data over UDP network from a remote device

  • Library:
  • Simulink Real-Time / IP

  • UDP Receive block

Description

The UDP Receive block receives data over a UDP network from a remote device. It can receive data by using the connection between the development and target computers or by using a dedicated Ethernet card. If you use a dedicated Ethernet card, use the Speedgoat configuration utility to configure the dedicated Ethernet board.

The parameter Local IP address applies when the block executes in a real-time application on a target computer or in a model simulation on a development computer. If your model is running in Simulink® on the development computer, you can use this block to receive data to a remote device. In this case, the Windows® operating system determines the network connection.

Ports

Output

expand all

Vector of uint8 containing data received over the UDP network. If no new packet is received, the data values are held. To determine whether a new packet has been received, use the Length output port.

Data Types: uint8

Number of bytes in the new packet received, otherwise 0. If more bytes are received than can be output through the receive port with width defined by Receive width, the excess bytes are discarded.

Parameters

expand all

General Parameters

Dependency

When you select this parameter, it deactivates the Local IP address parameter and excludes the ports 1 through 1023 and 5500 through 5560 from use by UDP.

Programmatic Use

Block Parameter: useHostTargetConn

When Local IP address is set to Use host-target connection, the block uses the connection between the development and target computers. Use 0.0.0.0 to bind to INADDR_ANY, which enables the socket to receive broadcast datagrams.

Programmatic Use

Block Parameter: ipAddress

Specifies UDP port to receive data.

Ports 1 through 1023 and 5500 through 5560 are reserved for Simulink Real-Time communications.

Programmatic Use

Block Parameter: localPort

Determines the width of the Data output vector. If this value is less than the number of bytes in the received packet, the excess bytes are discarded.

Programmatic Use

Block Parameter: rcvWidth

When Receive from any source is on, the block receives data from any accessible IP address. When it is off, the block receives data from only the address that you specify in From IP address.

To make the From IP address parameter visible, clear the Receive from any source check box.

Programmatic Use

Block Parameter: rcvFmAny

Enter a valid IP address as a dotted decimal character vector, for example, 192.168.7.2. You can also use a MATLAB® expression that returns a valid IP address as a character vector.

The address 255.255.255.255 is an invalid IP address.

To make this parameter visible, clear the Receive from any source check box.

Programmatic Use

Block Parameter: fmAddress

Enter the base sample time or a multiple of the base sample time.

Programmatic Use

Block Parameter: sampleTime
Introduced in R2020b