Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Common DataOut Recv

Block

Mask

Description

The block DataOut Recv is used to receive raw data from an Opal-RT card.

One DataOut Recv block controls data reception from one of the DataOut ports of the bitstream programmed in the card. The bitstream must be produced with Opal-RT RT-XSG product, version 2.1 or higher.

In the RT-XSG implementation, the bitstreams have at least 32 DataIn input ports and 32 DataOut output ports. On VC707 and TE0741 FPGA based platforms, the bitstreams can have up to 64 DataIn input ports and 64 DataOut output ports if the RT-XSG revision used to generate the bitstream is 3.5.2 or above. Each port has a maximum width of 250 32-bit data words. These data ports are used to exchange data between the RT-LAB model and the FPGA chip of the card via the PCIe bus of the target computer.

Parameters

ControllerNameBind this block to an OpCtrl block by entering the same 'Controller Name' as specified in the OpCtrl block The OpCtrl block controls initialization of the settings of one specific card in the system.
DataOut port numberEnter the number of the DataOut port to be controlled by this block, in the range [1:64] for the VC707 and TE0741 FPGAs and [1:32] for all others.
Data outport widthEnter the maximum number of data words that will be received from the card at each calculation step, in the range [1:250].
Data outport typeSelect the data outport type : 'uint32' or 'double'. When 'double' is selected, the underlying driver performs data typecast between 'double' and 'uint32', so data values are limited to the range [0:2^32-1]. The possibility to set the outport to 'uint32' type is provided for optimum performances
Sample Time (s)This parameter allows the user to specify the block sample time in seconds. The default value is 0, which specifies a continuous sample time (note that the sample time is borrowed from the separated subsystem) while -1 specifies an inherited sample time. The DataOut Recv block and its associated OpCtrl block must execute at the same sample time.

Inputs

This block has no inputs.

Outputs

The block has two outports.

Data: The data values returned by this outport are received from the card at each calculation step. No scaling or formatting of the data is performed, except for typecasting from 'uint32' to 'double' if the 'Data outport type' parameter is set to 'double'.

Status: The Status output returns the following values:

ValueDescription
0No error.
-1

Block could not be matched with an OpCtrl block (check the 'controller Name' value), or card initialization problem.

-2Data reception timeout. This error can be caused by model synchronization errors.
-3

Data reception error: the block received fewer data from the card than the value specified in the 'Data outport width' parameter. Missing data were replaced by 0.

-4

Data reception error: the block received more data from the card than the value specified in the 'Data outport width' parameter. Extra data were discarded.

Characteristics and Limitations

This block has no special characteristics.

Direct FeedthroughNo
Discrete sample timeYes
XHP supportYes
Work offlineNo

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter