Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Allows browsing of the OPC servers in the runtime, returning a list of tags.

Caution: This function performs a fully recursive browse that can't be terminated, which can be especially problematic in larger systems. It is highly advised to use system.opc.browseServer instead since recursion with that function is driven by subsequent calls. 

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

This function accepts keyword arguments.

system.opc.browse(opcServer, device, folderPath, opcItemPath)

  • Parameters

String opcServer - The name of the OPC server to browse

String device - The name of the device to browse

String folderPath - Filters on a folder path. Use * as a wildcard for any number of characters and a ? for a single character.

String opcItemPath - Filters on a OPC item path. Use * as a wildcard for any number of characters and a ? for a single character.

  • Returns

List<OPCBrowseTag> - An array of OPCBrowseTag objects. OPCBrowseTag has the following functions: getOpcServer(), getOpcItemPath(), getType(), getDisplayName(), getDisplayPath(), getDataType().

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# Example 1: Browse every OPC server
 
tags = system.opc.browse()
for row in tags:
    print row.getOpcServer(), row.getOpcItemPath(), row.getType(), 
    print row.getDisplayName(), row.getDisplayPath(), row.getDataType()
Code Snippet
# Example 2: Browse Ignition OPC UA
 
tags = system.opc.browse(opcServer="Ignition OPC UA Server")
Code Snippet
# Example 3: Browse Specific Device
 
server = "Ignition OPC UA Server"
tags = system.opc.browse(opcServer=server, device="Dairy Demo Simulator")
Code Snippet
# Example 4: Browse Specific Folder Path (not OPC item path)
 
server = "Ignition OPC UA Server"
tags = system.opc.browse(opcServer=server, folderPath="*Overview/AU 1*")
Keywords

system opc browse, opc.browse  

  • No labels