GithubStar/UA-.NETStandard
1
0
Fork 0
mirror of https://github.com/OPCFoundation/UA-.NETStandard.git synced 2026-10-21 17:16:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
2,769 Commits 110 Branches 105 Tags
fix/diagnostic-delete-nodeversion-master
Commit Graph

2 Commits

Author SHA1 Message Date
Klaus Landsdorf 15f9a5ebcc Machinery client: enumerate each machine, component and process value once (#4672) 
# Description

`MachineryClient` browses the `Machines` folder, the `Components`
add-in, the `MachineryBuildingBlocks` organizer, the energy resources
and the process values with `HierarchicalReferences` and subtypes, and
turned every returned `ReferenceDescription` into a `MachineEntry`.
Browse returns one description per reference, not per node, and
`HasEventSource` and its subtype `HasNotifier` are hierarchical
references. A machine that the `Machines` folder organizes and that is
also registered as a notifier of the folder - how a server exposes its
event hierarchy below the `Server` object once alarms are attached - was
therefore returned twice by `EnumerateMachinesAsync` and
`DiscoverMachinesAsync`. The same held for a component that is an event
source of its `Components` folder and for a process value that is an
event source of `Monitoring`.

The fix:

- The shared browse helper reports each target NodeId once and keeps the
first description. Its `BrowseName`, `DisplayName` and `TypeDefinition`
belong to the node and are the same for every reference that leads to
it.
- All hierarchical references are still followed. Restricting the browse
to `Organizes` would lose machines, components and process values a
server references with another hierarchical reference type such as
`HasComponent`, so an address space without duplicate references returns
exactly what it returned before.
- `EnumerateProcessValuesAsync` looks below the machinery item and below
its `Monitoring`; a process value reachable from both is now reported
once as well.

The public API does not change.

## Changes

- `src/Opc.Ua.Machinery.Client/MachineryClient.cs`:
`BrowseChildrenAsync` skips a NodeId it has already returned; the
remarks of `EnumerateMachinesAsync` say so.
- `src/Opc.Ua.Machinery.Client/MachineryClient.ProcessValues.cs`:
`EnumerateProcessValuesAsync` skips a process value below `Monitoring`
it has already returned below the item.

Every enumeration of the client goes through `BrowseChildrenAsync`:
`EnumerateMachinesAsync`, `DiscoverMachinesAsync`,
`EnumerateComponentsAsync`, `EnumerateBuildingBlocksAsync`,
`EnumerateEnergyResourcesAsync`, `EnumerateMeteringPointsAsync`,
`EnumerateSubMetersAsync`, `EnumerateProcessValuesAsync`, and the child
walks of `ReadLifetimeCountersAsync`, `EnumerateEquipmentAsync`,
`ReadMeteringPointAsync` and `ReadPublishedResultsAsync`.

## Tests

- **New, end-to-end**
(`MachineryEndToEndTests.NodesThatAreAlsoEventSourcesOfTheirParentAreEnumeratedOnceAsync`):
the test press links the machine to `Machines` with `HasNotifier`, the
`HydraulicUnit` component to `Components` and the oil-temperature
process value to `Monitoring` with `HasEventSource`, each in addition to
its organizing reference, and expects each node once from
`EnumerateMachinesAsync`, `DiscoverMachinesAsync`,
`EnumerateComponentsAsync` and `EnumerateProcessValuesAsync` over
`opc.tcp`.
- **New, unit**
(`MachineryClientTests.ANodeReachedThroughTwoReferencesIsEnumeratedOnceAsync`):
a browse result that carries the same machine under `Organizes` and
`HasNotifier`.
- **Fail without the fix:** with `src/Opc.Ua.Machinery.Client` from
master, all four assertions of the end-to-end test fail - two machines,
two NodeIds, two components and two process values instead of one each.
- `Opc.Ua.Machinery.Tests` passed 167/167 on net10.0 and 167/167 on
net8.0 (macOS).
- `Opc.Ua.Machinery.Client` builds for net48, net8.0, net9.0 and net10.0
with 0 warnings.
- `dotnet format` (whitespace, style, analyzers) on the changed files:
nothing on the changed lines (the `ENDOFLINE` findings concern the whole
of every file in a checkout with LF line endings).
- Changed lines covered: 8/8 (100 %).
- Fork CI (full matrix incl. macOS) and CodeQL: [CI run
37201766371](https://github.com/biancode/UA-.NETStandard/actions/runs/37201766371)
and [CodeQL run
37201768280](https://github.com/biancode/UA-.NETStandard/actions/runs/37201768280),
both green.

## Notes for review

- No extra request: the de-duplication happens on the result of the
browse the client already made.
- Of the sibling companion clients, `PumpsClient.EnumeratePumpsAsync`
and `ScalesClient.EnumerateScalesAsync` already de-duplicate across
their two roots. `EnumeratePumpsUnderAsync`,
`EnumerateScalesUnderAsync`, `EnumerateSystemScalesAsync` and the DI
device discovery follow the same browse pattern without de-duplication;
they are not changed here.

## Related Issues

- Fixes #4670

## Checklist

- [x] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [x] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed. (Affected
suite on net10.0 and net8.0 locally on macOS; .NET Framework is covered
by the fork CI's Windows net48 legs.)
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.

Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
 2026-10-05 06:27:38 +02:00
Klaus Landsdorf 01d6b5d26c Machinery: the OPC 40001 companion SDK with Jobs, Result Transfer, Process Values and Energy (#4578) 
> Tracking issue #4576. #4577 is merged, so this branch is rebased onto
> `master` and contains only the Machinery commits.

## Summary

Second of four stacked PRs. Adds the OPC UA for Machinery series as
model
packages plus a server and a client SDK, following the companion pattern
of
DI and Robotics, and the two models it depends on that the repository
does
not carry yet.

| Package | Content |
|---|---|
| `Opc.Ua.IA` | OPC 10000-200 IA 1.01.4, **moved out of
`Opc.Ua.Robotics`** (see below) |
| `Opc.Ua.ECM` | OPC 34100 Energy Consumption Management 1.0.1 |
| `Opc.Ua.PADIM` | OPC 30081 PA-DIM 1.02.0 with the IRDI dictionary |
| `Opc.Ua.Machinery` | OPC 40001-1 Basic Building Blocks 1.04.1 |
| `Opc.Ua.Machinery.ProcessValues` | OPC 40001-2 Process Values 1.00.0 |
| `Opc.Ua.Machinery.Jobs` | OPC 40001-3 Job Management 1.0.1 |
| `Opc.Ua.Machinery.Energy` | OPC 40001-4 Energy 1.00 |
| `Opc.Ua.Machinery.Result` | OPC 40001-101 Result Transfer 1.01.0 |
| `Opc.Ua.Machinery.Server` | `AddMachinery()` /
`ConfigureMachinery(...)`, fluent machine builder, server-driven state
machines, process values, job management over the shared ISA-95 V2
binder, energy, result management incl. `GenerateFileForRead` |
| `Opc.Ua.Machinery.Client` | machine discovery, identification, state
observation, process values, job and result access |

OPC 40001-101 `ResultTransferType` redeclares `GenerateFileForRead` with
its
own arguments; the generator fix for such overrides, merged with #4577,
is
what makes it appear on the `ResultTransfer` instances.

All NodeSets are byte-identical to `UA-Nodeset/latest`. Each model
carries a
pinned `Model/*.NodeIds.csv` the generator validates, next to the
unmodified
upstream table; `tools/nodesets/derive-identifier-table.py` derives the
former from the latter.

## Changes to existing code

- **IA moves out of Robotics.** Machinery needs IA as well (OPC 40001-1
types
`Stacklight` with `BasicStacklightType`), and two assemblies generating
the
same model under the same prefix collide at any consumer referencing
both.
The NodeSet moves verbatim, so no generated type changes; the prefix
stays
`Opc.Ua.IA`. Source-compatible, but IA types now live in `Opc.Ua.IA.dll`
rather than `Opc.Ua.Robotics.dll` — binary-breaking for consumers of the
  Robotics package.
- **`samples/OpenUsd/GeneratorServer`** drops its hand-reduced Machinery
  NodeSet copy and the script that produced it (a workaround for the
generator defect fixed by #4577) and references `Opc.Ua.Machinery`
instead.
- `README.md` and `docs/README.md` list the new models; the README also
  corrects the Industrial Automation entry (Part 200, not OPC 40001-1).

## Review follow-ups

Separate commits after the docs/samples commit, so the reviewed state
stays
comparable. Each fix comes with a test that fails without it.

- Copilot review: a transition is committed only while the state machine
is
still in its source state; optional Jobs/Result namespaces the server
does
not load are reported as absent, as documented; resources of registered
machines (result transfer, job-management change pumps) are released
with
  the node manager (`DisposeMachineryResourcesAsync` for a custom DI
  manager); `NodeId`/`LocalizedText` use their null sentinels instead of
  `Nullable<T>`.
- Own review with the rubric in `.github/copilot-instructions.md`: a
failed
browse call propagates from the client instead of reading as "no
children";
  the predefined result metadata compares `CreationTime` against the
  `DateTimeUtc` sentinels (the `DateTime` conversion shifted
  `DateTime.MaxValue` by the host's UTC offset); process values below
`Monitoring` are found; a second metering point named `Main` is
rejected;
  the zero-point event is reported when the handler throws; smaller
  state-sharing and documentation corrections.

## Testing

- `tests/Opc.Ua.Machinery.Tests`: 162 tests on net8 and net10 and with
the
netstandard2.1 libraries; the integration tests connect a real client
session over `opc.tcp` to a hosted
  server.
- With IA extracted: Robotics 636, OpenUsd 921, DI 433 and
SourceGeneration
  263 tests pass.
- `UA.slnx` builds for net472, net48, netstandard2.0/2.1 and net8/9/10
with
  SDK 10.0.401 and no warnings.
- Changed-line coverage of this layer (`check-coverage.ps1`): 91.68 %
(6059 of 6609 changed lines, against `master`).
- Fork CI, full PR matrix incl. macOS, on the current master: green, all
184
jobs ([run
36582685653](https://github.com/biancode/UA-.NETStandard/actions/runs/36582685653)).
CodeQL: green ([run
36582689589](https://github.com/biancode/UA-.NETStandard/actions/runs/36582689589)).
- Beyond the in-repo tests the implementation has been validated end to
end
  against a separate, non-public OPC UA client and server.

## Reviewing

Commits are ordered so each builds: IA extraction → identifier-table
tool →
ECM/PA-DIM → Machinery models → server → client → tests → docs/samples →
GeneratorServer sample → review follow-ups. The model commits are large
only because of the
NodeSets and identifier tables; the hand-written code starts at the
server
commit.

---------

Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
 2026-09-29 19:59:34 +02:00