Skip to content

README.md

Latest commit

 

History

History
98 lines (71 loc) · 3.9 KB

README.md

File metadata and controls

98 lines (71 loc) · 3.9 KB
Raw

Console Reference PubSub

A single, self-contained OPC UA Part 14 PubSub reference application built on the fluent PubSubApplicationBuilder + dependency injection + .NET Generic Host surface. One executable exposes three command-line-selectable modes, and publishes as a NativeAOT-ready single-file executable.

Modes

ConsoleReferencePubSubClient <mode> [options]
Mode Purpose
publisher Publishes a built-in sample DataSet over UDP/UADP or MQTT (UADP/JSON).
subscriber Receives DataSets and logs each decoded message to the console.
external Bridges an external OPC UA server to PubSub via the Opc.Ua.PubSub.Adapter library (publisher / subscriber / responder direction).

publisher

ConsoleReferencePubSubClient publisher --profile udp-uadp --interval 1000
ConsoleReferencePubSubClient publisher --profile mqtt-json --endpoint mqtt://localhost:1883

Options: --profile udp-uadp|mqtt-uadp|mqtt-json, --config-file <xml>, --publisher-id, --writer-group-id, --data-set-writer-id, --endpoint, --interval.

subscriber

ConsoleReferencePubSubClient subscriber --profile udp-uadp

Options: --profile, --config-file <xml>, --publisher-id-filter, --writer-group-id-filter, --data-set-writer-id-filter, --endpoint.

external

Bridges an external OPC UA server (defaults to the repository's ConsoleReferenceServer at opc.tcp://localhost:62541/Quickstarts/ReferenceServer; override with --endpoint or the OPCUA_EXTERNAL_ENDPOINT environment variable).

# Read an external server and publish its values (cyclic Read each cycle)
ConsoleReferencePubSubClient external --mode publisher --read-mode cyclic

# Read via a client Subscription cache, one subscription per WriterGroup
ConsoleReferencePubSubClient external --mode publisher --read-mode subscription --affinity writergroup

# Write received PubSub values back to an external server
ConsoleReferencePubSubClient external --mode subscriber

# Map an inbound PubSub Action to an external server method call
ConsoleReferencePubSubClient external --mode responder

# Run a bidirectional bridge in one process
ConsoleReferencePubSubClient external --mode publisher,subscriber

Options: --mode publisher|subscriber|responder (comma-separated list accepted), --read-mode cyclic|subscription, --affinity writergroup|datasetwriter, --endpoint <external server>, --pubsub-endpoint <udp url>, --hot-reload.

Hot reload

Add --hot-reload to the external bridge to run the opt-in live reconfiguration demo:

ConsoleReferencePubSubClient external --mode publisher,subscriber --hot-reload

The bridge writes pubsub-config.xml next to the executable before starting and loads adapter options from the copied appsettings.json in the same directory. Edit and save either file while the bridge is running:

  • appsettings.json: change ExternalPublisher:ReadMode from Cyclic to Subscription, or change ExternalPublisher:Affinity to DataSetWriter, to rewire the external-server publisher options.
  • pubsub-config.xml: add or remove a DataSetWriter to change the PubSub topology. The watching XML store raises a configuration change and the adapter incrementally rewires the affected binding.

The samples connect to the external server unsecured (SecurityMode.None) for zero-config interop. A production bridge must use SignAndEncrypt with a provisioned application instance certificate. See Docs/PubSub.md external-server adapter section.

Build / publish

dotnet build Applications/ConsoleReferencePubSubClient/ConsoleReferencePubSubClient.csproj
dotnet publish Applications/ConsoleReferencePubSubClient/ConsoleReferencePubSubClient.csproj -r win-x64

See Docs/PubSub.md for the full PubSub guide.