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.

List of Commands for OPAL-RTLinux (x86-based) and Windows Targets

CommandDescription
/usr/opalrt/common/bin/
flash_update -bim

This is a request to get Board Identification Messages (BIM) of remote SignalWire boards. It searches and displays data on installed boards.

ls -lo /usr/opalrt
Lists the RT-LAB versions installed on the target.
uname -a

Prints the name, version and other details about the current target and the operating system running on it.

ps -A
Reports the process status.
ifconfig -a

Allows the user to view information about the configured network interfaces.

ls /dev
Lists the devices that are currently running on the target.
cat /proc/cpuinfo

Displays information about the processors installed on the target.

lspci -v

Displays information about all PCI buses in the system and all devices connected to them.

List of Commands Specific to Windows Targets

dir C:\Opal-RT
Lists the Opal-RT directory
systeminfo
Displays information about the system
tasklist

Prints the name, the PID and the memory usage of all running applications and services on the target.

ipconfig /all

Allows the user to view information about the configured network interfaces.


ICON

DESCRIPTION

From top to bottom:

Connect
Opens the connection to the target.


Disconnect
Closes the connection to the target.


Settings
Opens the Terminal Settings dialog. While connected, only the view title can be changed.


Toggle Command Input Field
Toggles the Command Input field to edit complex command lines on dumb terminals. See figure: Command Input Field.


Display Selected Connections
Selects a Terminal connection to show in this view instance. Only available when multiple connections have been defined in the view.


New Terminal Connection in Current View
Creates a new terminal connection in the current view.


New Terminal View
Creates a new terminal view that will be stacked in the tabbed notebook at the rightmost position.

X = Remove Terminal
Removes the currently selected Terminal Connection from the view. Only available when multiple connections have been defined in the view.


Command Input Field


Contextual Menu

To open the contextual menu, right-click the output of the Terminal View.

Contextual Menu


MENU ITEMDESCRIPTION
CopyCopies selected text from the view.
PastePastes text into the view.
Clear TerminalClears text in the terminal view.
Select AllSelects all text in the terminal view.

Toggle Command Input
Field

Enables/disables the command input field at the bottom of the Terminal view.

Search View
This view shows the results of a search. The same view is shared for different types of searches, like File Search and RT-LAB Search.


RT-LAB Search Results

RT-LAB searches only search for expressions in RT-LAB objects specified in the RT-LAB Search dialog.

Here is what the results of Search View look like for an RT-LAB Search:

Search View show as a List

If you close the Search View, you can return to it later by selecting Window > Show View > Other... > General > Search.


Display the results as a tree

To enable the display of the results as a tree, select the option Show As Tree from the view menu.

Show results as a Tree


Working with search result items

Drag and drop itemsDrag and drop features in the editor are enabled for the model and the subsystem objects. If the search found a model or subsystem, select it, drag it to the editor and drop it. The model opens in the editor.
Double click itemsDouble-clicking on a model or a subsystem opens the editor.
View / Edit variable from the contextual menu

This option helps to see the value of the selected items by opening the Variable Viewer.

Variable Viewer

Assign Working Set from the contextual menu

This command is used to assign the selected object to an existing or a new Working Set. The next figure shows the Variables Table the plant_response signal that have been added to the Working
Set 1.


Variable Table

Contextual Menu for RT-LAB Search

To open the contextual menu, right-click on one of the matches.


Contextual Menu


MENU ITEMDESCRIPTION
View / Edit variable

Opens the variable viewer for the selected object.

Show In

Shows the selected object in a view, only if applicable.

Next Match

Highlights the next match of the search expression in the search view.

Previous Match

Highlights the previous match of the search expression in the search view.

CopyCopies the text of the selected match to the clipboard.

Remove Selected
Matches

Removes all highlighted matches from the search results.
Remove All MatchesRemoves all search results from the search view.
Assign Working Set...

This command is used to assign the selected object to an existing or a new Working Set.

Search Again

This command reruns the current search again, so that removed search results reappear or changes are reflected.

PropertiesOpens Property View for the selected object.

File Search Results

File Search result


  • Within the Search view two files are shown, and within each file there were 4 matches found.
  • Click the Show Next Match button to navigate to the first match of the search expression (it). Notice that the file file1.txt is automatically selected and opened in the editor area. Click Show Next Match button two more times. Once again the Search view automatically opens the file
    (file2.txt).
  • It is sometimes useful to remove uninteresting matches from the search results. The Search view's popup menu allows you to do this using Remove Selected Matches which removes any selected file entries (and all matches in them) from the Search view. Note that this only removes the entries in the Search view, it does not affect the files themselves. Select file1.txt and choose Remove Selected Matches from the popup menu. The Search view now shows only the matches for file2.txt
  • Perform a second search for that by clicking on the Search button in the Workbench's toolbar.
  • The Search view updates to show the results of the new search. Use the drop-down button on the Search view's toolbar to move back and forth between the two search results.
  • In the drop-down button choose 'it' - 2 matches in the workspace. The Search view switches back to show the original search. On the context menu choose Search Again to repeat the initial search.

Notice that once again there are four matches.

So far, you have seen how to manage your search results and how to switch between different searches. However, it might happen that you do not want the search view to change even if further searches are performed. For this you can pin the search view, which causes subsequent searches to be shown in a second Search view.

Toolbar

ICONDESCRIPTION

From top to bottom:

Show Next Match
This command highlights the next match of the search expression in the search view.


Show Previous Match
This command highlights the previous match of the search expression in the search view.


Remove Selected Matches
Removes all highlighted matches from the search results.


Remove All Matches
Removes all search results from the search view.


Collapse all
Collapses every tree item in the search view.


Run the Current Search Again
This command runs the current search again, so that removed search results reappear or changes are reflected.


Cancel Current Search
Cancels the current search.


Show Previous Searches
This command allows you to browse previously conducted searches and repeat a previous search. You can select a previous search from the drop-down menu or clear the search history.


Pin the Search view
Pinning the search view means that subsequent searches will show their results in another search view and that the pinned view remains unchanged.

Bookmarks View

To add the Bookmarks view to the current perspectiveclick Window > Show View > Other... > General > Bookmarks.
DescriptionDescription of the bookmark. Edit the description by selecting Properties from the context menu.
ResourceName of the resource associated with each bookmark
PathLocation of the resource associated with each bookmark
LocationLine number of the bookmark within its associated resource.
ToolbarThe toolbar of the Bookmarks view includes the following buttons.
DeleteDelete the selected bookmark.
Go toOpen the bookmark's resource and navigate to the bookmarked region.
MenusClick the icon at the left end of the view's title bar to open a menu of items generic to all views. Click the black upside-down triangle icon to open a menu of items specific to the Bookmarks view. Right-click inside the view to open a context menu.


Creating a Bookmark within a File

The Workbench allows you to create bookmarks in files that you edit so that you can quickly reopen those files from the Bookmarks view.

With the file open in an editor, right-click in the gray border at the left of the editor area, next to the line of code or text that you want to bookmark.

Select Add Bookmark from the pop-up menu.

Notice that an icon for the bookmark now appears in the left border of the editor area. A line is also added to the Bookmarks view.

You can reopen the file for editing at any time by double-clicking the bookmark in the Bookmarks view.

Tasks View

The Tasks view displays tasks that you add manually. You can associate a task with a resource in the Workbench, but this is not required.

By default, the Tasks view is not included in the RT-LAB Edition perspective. To add it to the current perspective, click Window > Show View > Other... > General > Tasks.

First columnIndicates whether the task is completed. Completed tasks are flagged with a checkmark, which you add manually.
Second column Indicates whether the task is high, normal, or low priority.
Description Contains a description of the line item. You can edit the description of user-defined tasks by selecting Properties from the context menu.
Resource and Path columnsProvides the name and location of the resource associated with each line item.
Location Indicates the line number of the line item within its associated resource.
ToolbarThe toolbar of the Tasks view includes the following buttons.
Add taskManually add a to-do item to the Tasks view.
DeleteDelete the selected line item.
FilterFilter the view according to the type of item.
MenusClick the icon at the left end of the view's title bar to open a menu of items generic to all views. Click the upside-down triangle icon to open a menu of items specific to the Tasks view. Right-click inside the view to open a context menu.


Adding Line Items in the Tasks View


The Tasks view contains line items for system-generated problems, warnings, and errors. You can add your own entries to the table to build a list of to-do items, or tasks.

  • On the toolbar in the Tasks view, click the New Task button. The New Task dialog opens.
  • Type a brief description of the task in the Description field. The new task is assigned default priority and completed values.
  • These values may also be modified within the New Task dialog.
  • Press OK.

Associating a Task to a Resource


You can associate tasks with an editable resource, for instance, to remind yourself to update a line of source code later.

  • In the project explorer view, double-click the resource with which you wish to associate the new task. The resource opens in the editor area.
  • Right-click on the gray border at the left of the editor area, beside the line of text or source code against which you want to log the new task.
  • On the pop-up menu, select Add Task.
  • When prompted, enter a brief description of the task.

A new task icon appears in the border of the editor area, to the left of the line where you added the task. When you move the mouse pointer over the marker, the description of the task is displayed as a tooltip. The task is also added to the Tasks view. You can delete a task either by right-clicking its icon in the editor area and selecting Remove Task or by pressing the Delete key in the Tasks view.

Internal Web Browser View

This view allows you to display web pages. By default, it is used to display web pages when they are opened from the workbench. You can modify this setting in the Web Browser preference page.

Markers View

This view shows problems, tasks and bookmarks added to your resources.

  • By default, the Markers view is not included in the RT-LAB Edition perspective. To add it to the current perspective, click Window > Show View > Other... > General > Tasks.
  • The Description column contains a description of the line item. You can edit the description of user-defined tasks by selecting Properties from the context menu.
  • The Resource and Path columns provide the name and location of the resource associated with each line item.
  • The Location column indicates the line number of the line item within its associated resource.
  • The Type column indicates the type of marker of the line item: problem, task, bookmark.

Navigator View

This view shows resources in the workspace. It displays projects and other resources that you are working with.

Outline View

The Outline view displays an outline of a structured file that is currently open in the editor area and lists structural elements. The contents of the Outline view are editor specific. The contents of the toolbar are also editor specific.

To add the Outline view to the current perspective, click Window > Show View > Other... > General > Outline.

Problems View

As you work with resources in the workbench, various tools may automatically log problems, errors, or warnings in the Problems view. When you double-click the icon for a problem, error, or warning, the editor for the associated resource automatically opens to the relevant line of code.

  • By default, the problems view will group your problems by severity. You can also group them by type or not at all. Certain components will add their own grouping. The grouping can be selected using the Group By menu.
  • The first column of the Problems view displays an icon that denotes the type of line item, the category and the description. Left-click the item to open the file in an editor and highlight the line containing the problem.
  • You can configure the contents of the Problems view to view only warnings and errors associated with a particular resource or group of resources. This is done using the Configure Contents dialog available from the drop-down menu. You can add multiple filters to the problems view and enable or disable them as required. Filters can either be additive (any problem that satisfies at least one of the enables filters will be shown) or exclusive (only problems that satisfy all of the filters will be shown) The two most popular filters (All Errors and Warnings on Selection) are provided by default.
  • Problems can be fixed by selecting Quick Fix from the context menu. The list of possible resolutions will be shown.
  • To add the Problems view to the current perspective, click Window > Show View > Other... > General > Problems.


OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323