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.

Orchestra_Proxy_Simulink

Library

rtlab/Orchestra/Proxy

Block

This block allows a user to exchange data between an RT-LAB Orchestra framework and Simulink External Components.

Figure 1: Orchestra_Proxy_Simulink block

Mask

Orchestra_Proxy_Simulink mask.

Description

This block acts as a bridge between the current model and External Components. Refer to the Orchestra page of the RT-LAB user guide for more information about RT-LAB Orchestra.

Parameters

XML fileName of the file to be used to read data information. Click on the Configure button to start the DDF Configurator.
Sample timeBlock sample time. Determines the rate at which to exchange data with the External Components.
Domain nameThe domain name to use in the DDF.
Work in Simulink modeEnables/Disables the connexion to the RT-LAB Orchestra framework when running the model outside of an RT-LAB Orchestra co-simulation.
Create Goto/From subsystemsClick on this button to trigger the creation of the ‘Goto’ and ‘From’ blocks for all items described in the XML file under the FRAMEWORK_TO_CLIENT and CLIENT_TO_FRAMEWORK sections of the selected domain.


Input (Wait-to-go)

The input is used to block the connection of the External Component to the framework. If the input is 1, the client will be blocked, when passed to 0 it will unblock it. By letting it unconnected it will not block the External Component connection. 

The default behavior of the input would be there is no wait granted before publishing and subscribing, Otherwise, there is a wait for the signal to start data exchanges.
This behavior is specifically designed for synchronous mode and by considering the domain name.

The wait-to-go input pin is used to hold the beginning of Publish/Subscribe of External Component until a falling edge.
By leaving it unconnected or having a constant set to 0 connected to it will provide the default behavior which is published and subscribe upon connection.
This can be used to synchronize multiple Domains to start together.

If this input is actively used to synchronize RT-LAB based clients, it is important to disable the watchdog for the client models to prevent undesired simulation failures.



Warning: In synchronous mode, using this feature may block the framework causing overruns.


Outputs

Output#1: ConnectionCount

Outputs the number of external components connected to the Framework. 

In case of synchronous use, This output is incremented before blocking, while waiting for wait-to-go input.

Note that ConnectionCount output is neither the number of active connections nor the number of attempted ones.

Output#2: ConnectionIsActive

Outputs the status of the connection with an External Component. 

The value is 0 if there is no External Component connected to the framework otherwise the value is 1.




Tip: It is possible to use the Connection Count pin of Proxy blocks and a Nand gate to control the Wait To Go input and therefore synchronize multiple Domains within the Framework.


Characteristics and Limitations

Direct Feedthrough

Yes

Discrete sample time

Yes

XHP support

Yes (Partial XHP only)

Work offline

Yes

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