Files
UA-.NETStandard/samples/Scales/ScalesServer/ScaleSimulation.cs
Klaus Landsdorf dadd609ec0 Scales: the OPC 40200 companion SDK with the OPC 30050 PackML model (#4580)
> Tracking issue #4576. #4577, #4578 and #4579 are merged, so this
branch is
> rebased onto `master` and contains only the Scales and PackML commits.

## Summary

Last of the four PRs of #4576. Adds OPC 40200 Weighing Technology 2.00
as a
model package plus a server and a client SDK, and the OPC 30050 PackML
model
it composes.

| Package | Content |
|---|---|
| `Opc.Ua.PackML` | OPC 30050 PackML 1.01, plus
`PackMLStateMachineController`, which drives a base state machine
together with its nested machine and execute state machines (activation
and deactivation of the sub-state machines, the PackML methods with an
`Executable` attribute that follows the state, acting states left
automatically or by the equipment) |
| `Opc.Ua.Scales` | OPC 40200 2.00
(`http://opcfoundation.org/UA/Scales/V2/`), generated from the
unmodified UA-Nodeset publication, plus the contracts client and server
share |
| `Opc.Ua.Scales.Server` | `AddScales()` / `ConfigureScales(...)`; all
fourteen scale kinds and scale systems below `DeviceSet` and `Machines`;
a runtime that does the weighing arithmetic (ranges, rounding to d or e,
zero band, overload/underload, zero, tare, preset tare, registration),
production presets with DI locking, statistics, recipes and recipe
files, Annex C events and alarms over a `HasNotifier` hierarchy, and the
methods of every scale type |
| `Opc.Ua.Scales.Client` | discovery, weight reads and streaming,
zero/tare/register, products, PackML state and commands, type-specific
methods, events and alarms, snapshots |

`docs/Scales.md` includes a conformance matrix against the 21 OPC 40200
server
facets with test evidence, the places where the specification and the
NodeSet disagree, and known limitations.

## Review follow-ups

Separate commits after the docs/samples commit, each with a test that
fails without it where the defect can be observed.

- Copilot review: `CurrentProductsChanged` fires only when the set of
  current products changes; the new public collection APIs
  (`ScalesServerOptions.AdditionalNamespaceUris`,
  `ScaleNamespaceIndices.SearchOrder`, `ScalesModel.AllKinds`) are
  `ArrayOf<T>`.
- Own review with the rubric in `.github/copilot-instructions.md`:
  - PackML raises `StateChanged` after its lock is released (queued, in
    order), reads `StartParameters` under the lock, and reports the
    handler's status when an acting state cannot complete.
- Scales: concurrent first creations share one runtime (the lock service
    refused a second attach); two creations of the same name cannot both
publish; a removed product id stays reserved until its node is gone; the
    zone, target-count and vehicle handlers change products under the
preset lock; the product factory and `configure` delegate run outside
    it; the recipe upload reads `ActiveRecipe` under the lock; resetting
    the statistics also resets the tolerance percentage.
- The client lets a failed browse call propagate instead of reading it
as
    "no children".

## Testing

- `tests/Opc.Ua.Scales.Tests`: 115 tests on net8 and net10 and with the
netstandard2.1 libraries, including the PackML runtime; the
client/server
  tests connect a real session over `opc.tcp` to a hosted
  `ScalesNodeManager`.
- `UA.slnx` builds for net472, net48, netstandard2.0/2.1 and net8/9/10
with
  SDK 10.0.401 and no new warnings.
- Changed-line coverage of this layer (`check-coverage.ps1`): 94.59 %
(4585 of 4847 changed lines, against `master`).
- Fork CI, full PR matrix incl. macOS: in progress, [run
36676067489](https://github.com/biancode/UA-.NETStandard/actions/runs/36676067489);
CodeQL: in progress, [run
36676070427](https://github.com/biancode/UA-.NETStandard/actions/runs/36676070427).
- On the current `master` (with Pumps merged), `UA.slnx` builds for
every target
  framework and the Scales and Pumps tests pass.
- 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: PackML → Scales model → server → client → tests → docs and
samples
→ review follow-ups.
2026-09-30 10:54:48 +02:00

131 lines
5.5 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2026 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Opc.Ua;
using Opc.Ua.Scales;
using Opc.Ua.Scales.Server.Runtime;
namespace ScalesSample
{
/// <summary>
/// Drives the sample equipment: packages cross the checkweigher and are
/// accepted or rejected, the balance settles, the counting scale fills
/// and trucks cross the weighbridge.
/// </summary>
internal sealed partial class ScaleSimulation : BackgroundService
{
public ScaleSimulation(PackingLine line, ILogger<ScaleSimulation> logger)
{
m_line = line;
m_logger = logger;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
// The scales exist once ConfigureScales has run.
await m_line.Ready.WaitAsync(stoppingToken).ConfigureAwait(false);
var random = new Random(40200);
int tick = 0;
while (!stoppingToken.IsCancellationRequested)
{
tick++;
WeighPackage(random, tick);
#pragma warning disable CA5394 // Simulated load noise, not security relevant
m_line.Laboratory.PublishLoad(0.1 + (random.NextDouble() * 0.000004), stable: tick % 4 != 0);
#pragma warning restore CA5394
m_line.PieceCounter.PublishLoad(0.00498 * (tick % 200));
CrossWeighbridge(tick);
await Task.Delay(TimeSpan.FromMilliseconds(500), stoppingToken).ConfigureAwait(false);
}
}
private void WeighPackage(Random random, int tick)
{
ScaleHandle checkweigher = m_line.Checkweigher;
#pragma warning disable CA5394 // Simulated load noise, not security relevant
// 481 .. 515 g, so roughly one package in ten falls below T1.
double weight = 0.5 + ((random.NextDouble() - 0.55) * 0.034);
#pragma warning restore CA5394
// RegisterWeight would count the package into ProductionOutput as
// well; a checkweigher counts accepted and rejected packages instead.
checkweigher.PublishLoad(weight);
// Nominal 500 g: packages below T1 (-15 g) are rejected, as OIML R 87 asks.
if (weight < 0.485)
{
checkweigher.ProductionOutput?.RecordRejected(weight, CheckweigherRejectReason.LowerToleranceLimit1);
checkweigher.Notifications.RaiseEvent(
ScaleNotificationId.BadPack,
new LocalizedText(FormattableString.Invariant($"Package of {weight:F4} kg rejected.")),
EventSeverity.Medium);
LogRejected(weight);
}
else
{
checkweigher.ProductionOutput?.RecordAccepted(weight, belowLowerToleranceLimit1: weight < 0.5);
}
// Every 20 s the label printer runs out of labels for a few seconds.
bool outOfLabels = tick % 40 is >= 34;
ScaleModuleHandle printer = checkweigher.Modules[1];
printer.PublishPrinterStock(outOfLabels ? 0 : 100 - ((tick % 40) * 100.0 / 34), 100);
checkweigher.Notifications.SetAlarm(
ScaleNotificationId.PrinterFault,
outOfLabels,
new LocalizedText(outOfLabels ? "The labeler is out of labels." : "Labels restocked."));
}
private void CrossWeighbridge(int tick)
{
// A truck arrives loaded, unloads and leaves empty every 60 ticks.
int phase = tick % 60;
ScaleHandle bridge = m_line.Weighbridge;
bridge.PublishLoad(phase switch
{
< 10 => 0,
< 20 => 38440,
< 40 => 0,
< 50 => 14220,
_ => 0
});
}
[LoggerMessage(Level = LogLevel.Information, Message = "Rejected a package of {Weight:F4} kg.")]
private partial void LogRejected(double weight);
private readonly PackingLine m_line;
private readonly ILogger<ScaleSimulation> m_logger;
}
}