Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

IO

Model Preparation

Description

List IOs configuration available in a project or in an exported file (*.rios)

Required Control

None

Usage

iosList = RtLabApi.GetIOsConfiguration(path)

Get IOs available in a project defined by its path.

Input

  • path : Path to an RT-LAB project or an .rios file.

Info

We advise specifying the path with the r'<path>' format instead of "<path>" to avoid interpretation of the escape character (\t, \n...)

Parameters

Returns
ios_name {list} -- List of IOs names available in the project.

Input

Path to an RT-LAB project or an .rios file.

Output

path {str} -- path to an RT-LAB project or an .rios file.

Output

  • iosList : Return a list object containing the list of IOs names available in the project or in the .rios file given in parameters

Exception

Method

return

returns 'None' if an error occurred

Examples

>>> RtlabApi.GetIOsConfiguration(r'C:\__WORKSPACE__\tmp\opcua')

['OPCUA Server']

Related Items

ImportIOsConfiguration, ExportIOsConfiguration

Modules

import RtlabApi