Skip to main content

Configuration

configuration file​

The configuration file is a YAML file that contains the settings for the server. The file should be structured as follows:

# yaml-language-server: $schema=node_modules/@sterfive/opcua-omni-edge/schema/config.schema.json

# the TCP-IP port of the OPC UA server
port: 4840

# well-known companion specifications, by alias (di = http://opcfoundation.org/UA/DI/)
namespaces:
  - di

# your own NodeSet2.xml models
imports:
  - alias: t
    filename: ./model/MyDevice.Nodeset2.xml

# the objects and variables the server exposes, built from those types
instances:

# the devices to connect to (Modbus, S7, EtherNet/IP, OPC UA, MQTT, Redis...)
brownfieldDevices:

# which device value feeds which OPC UA variable
mapping:

the namespaces and imports sections​

The server builds its information model from OPC UA nodesets:

  • namespaces: lists well-known companion specifications by alias, such as di for Device Integration. See the list of nodesets aliases.
  • imports: loads any other NodeSet2.xml, typically your own model, under an alias of your choice.

The namespaces and imports sections give the details.

A version 3 configuration used a single nodesets: key instead. The gateway refuses it; opcua-omni-edge migrate-config config.yaml converts it.

the instances section​

The objects and variables the server exposes, instantiated from the types the nodesets define. See the instances section.

the brownfieldDevices section​

The server can connect to various brownfield devices, such as Modbus, OPC UA, MQTT, S7, Redis, etc. You can define the devices to be connected in the brownfieldDevices section of the configuration file.

See Brownfield Devices for more details on how to configure the brownfield devices.

the mapping section​

The mapping section allows you to map OPC UA Variable nodes to brownfield devices. This is done using a variety of technics, such as JSONata expressions, which allow you to transform and manipulate the data from the brownfield devices before exposing it in the OPC UA address space.

See Mapping Section for more details on how to configure the mapping.

the serverOptions and certificateStores sections​

These shape the OPC UA server itself: the endpoint URLs it advertises (Docker port mapping, NAT), Reverse Connect, security, limits and the PKI folders.

See the OPC UA server.