UDP Receive

Receive data over UDP network from a remote device

  • Library:
  • Simulink Real-Time / Real-Time UDP

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, add a UDP Configure block to your model.

The parameter Local IP address applies only when the block executes on a target computer. If your model is running in Simulink® on the development computer, you can use this block to transmit 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

When Local IP address is set to Use host-target connection, the block uses the connection between the development and target computers. Otherwise, the block uses the value that you set in the Local IP address parameter of the UDP Configure block.

Programmatic Use

Block Parameter: ipAddress

Specifies UDP port through which to receive data.

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 Receive from any source.

Programmatic Use

Block Parameter: rcvFmAny

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

The default address, 0.0.0.0, causes the block to accept UDP packets from any accessible device. If you set From IP address to a specific IP address, only packets arriving from that IP address are received.

The address 255.255.255.255 is an invalid IP address.

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

Programmatic Use

Block Parameter: fmAdd

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

Programmatic Use

Block Parameter: sampleTime

Multicast Parameters

When you select Enable multicast, the UDP multicast parameters become visible.

Example: on

Programmatic Use

Block Parameter: rcvMulticast

Enter a valid IP address as a dotted decimal character vector, for example, 224.0.0.0.

The UDP Receive block issues an error at model update if the group IP address is not a valid multicast address in the range 224.0.0.0 through 239.255.255.255.

Example: 224.100.1.1

Programmatic Use

Block Parameter: multicastAddress

Introduced in R2016b