Skip to main content
net10.0.NETFramework4.7.2.NETFramework4.8net8.0net9.0.NETStandard2.1

OPC UA PubSub JSON Schema generation for DataSet payloads.

Published
Jan 1, 1900
128y ago
Total Downloads
0
0

Install

dotnet add package OPCFoundation.NetStandard.Opc.Ua.PubSub.Schema.Debug --version 2.0.0-preview.2
ProductVersions
.NET
net10.0net8.0net9.0
.NET Standard
netstandard2.1
Other
.NETFramework4.7.2.NETFramework4.8

README

OPC UA PubSub Schema

Runtime schema generation for OPC UA PubSub JSON message payloads. Produces JSON Schema (draft 2020-12) documents that describe the JSON DataSetMessage body for a writer from its DataSetMetaDataType metadata, so consumers (validators, code generators, documentation tooling) can be driven directly from the live PubSub configuration.

Part of the OPC UA .NET Standard stack (OPCFoundation.NetStandard.Opc.Ua.PubSub.Schema). Built on the core runtime schema subsystem (Opc.Ua.Core.Schema); no reflection, NativeAOT / trim safe.

Features

  • Generates JSON Schema for the Part 14 PubSub JSON message mapping (Part 6 reversible / non-reversible encoding rules).
  • Driven from runtime DataSetMetaDataType — schemas reflect the actual configured fields, data types and DataSetFieldContentMask.
  • Resolves built-in and custom (structured / enumerated) data types through the encodeable type system.
  • Dependency-injection first: services.AddOpcUa().AddPubSubSchema() registers IPubSubSchemaProvider; a direct-construction path (new PubSubSchemaProvider(...)) is also available.

Quick start

services.AddOpcUa().AddPubSubSchema();
// ...
var provider = serviceProvider.GetRequiredService<IPubSubSchemaProvider>();
IUaSchema schema = provider.CreateDataSetSchema(dataSetMetaData, fieldContentMask);
string jsonSchema = schema.ToSchemaString();

Documentation

See the Schema generation guide for concepts, registration, the schema object model and the PubSub message schemas, and the PubSub guide.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.No SPDX license expression is published. Review the license text and your organisation's policy before redistribution.Compatibility metadata lists 6 target frameworks; confirm the exact target used by your application.The published metadata declares 149 direct dependency entries across framework groups. Inspect the resolved dependency graph for your target framework.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.