mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-28 14:09:56 +08:00
# Description Remove stock phrasing and correct misleading or inconsistent technical documentation. The initial two passes covered 367 Markdown files, followed by an interactive review of 169 editorial flags. The U5 interpretation originally deferred in that review has since received the upstream Mantis answer recorded by #4843; remaining server/spec follow-ups stay explicit in the CTT log. - Correct package responsibilities, migration steps, API names, ownership, protocol descriptions and links. Keep bundled migration guides synchronized. Preserve historical conclusions as historical records with separate re-check notes. - Provide at least two rendered TOC levels throughout `docs/`. Convert appropriate architecture figures to Mermaid without changing code examples, transcripts or historical quotations. - Address the October 19 feedback with concrete setup/migration instructions, corrected certificate paths and PubSub names, shorter repeated caveats, consistent XML comments, and a full review of the Concepts guide. Retain #4839's API corrections. - Integrate #4841's runtime/performance guidance and review incoming/recent prose. Preserve dated measurements rather than claiming new benchmark runs; clarify allocation ratios, startup-only processor settings, JIT warm-up and the benchmark commit's scope. Missing raw measurement artifacts and repeat ranges remain tracked by #4842. - Merge master through `e8c5d800a` in `32c6394b7`. Resolve the CTT log conflict using the updated Mantis states and OPC answers, retaining historical framing and re-checks for C28/C32/C43. - Address the latest naming/index feedback in `adb5bf693`: rename the guides to `docs/WotCon.md` and `docs/WotNodeSetConversion.md`; move the provider and DataType-declaration contracts into the conversion guide and remove `docs/WoT.md`. Rename `samples/DI` to `samples/Di` and `samples/Isa95` to `samples/ISA95`. Add content-index READMEs to Di, FluentApi, ISA95, Lds and PubSub; update solution entries, project references, Docker/CI paths, test fixture paths and documentation links with exact casing. **WoT guide scope.** This branch retains the detailed conversion guide that #4758 had replaced with an anchor stub. Conversion limits, verified document sets, preservation rules and provider ownership now live together in `WotNodeSetConversion.md`; binding/runtime guidance remains in `WotBindings.md` and `WotCon.md`. The design-rationale/test-ledger prose was shortened, the oversized argument-table cell moved into its section, and existing anchors preserved. **SDK policy is a separate, explicit user-directed change.** `global.json` sets a stable minimum of `10.0.400`, `rollForward: latestMajor`, and `allowPrerelease: false`. Newer major SDKs are permitted; CI's explicit SDK pins are unchanged. README, GettingStarted, DeveloperGuide and Recycling instructions reflect the possible analyzer differences. The image-contract regression fix accepts compatible stable SDK images instead of requiring exact equality with the floor. The latest four rename/index threads are resolved after publication. Three older threads remain open: universal obsolete-removal timing, unconditional nonce-strength wording, and a blanket Vision NativeAOT claim. Existing implementation/evidence constraints are explained in their inline replies. The two-level TOCs remain as requested. ## Validation - `git diff --check` and staged diff checks: passed. The untouched upstream AutoID NodeSet retains its provenance bytes, including two existing license-header trailing spaces. - `.\.azurepipelines\validate-migration-plugin.ps1`: passed; 15 bundled migration documents and manifests synchronized. - Documentation/path validation: **101** documents retain two rendered TOC levels (**2,228** entries), with idempotent formatting. **52** new relative links and their anchors passed exact-case checks. No tracked references to the old guide/sample paths remain. Both relocated provider-contract sections are preserved in the destination. - `dotnet sln UA.slnx list`: passed; shows the renamed Di/ISA95 projects and the existing FluentApi/Lds/PubSub projects. Updated solution and pump ProjectReference paths also passed exact-case existence checks. - Latest focused commands, run from the repository root: ```powershell # Passed: 61 channel send-order and reconnect tests. dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~UaSCBinaryChannelSendOrderTests|FullyQualifiedName~TcpReconnectKeyAgreementTests' --verbosity minimal # Passed: 5 pump datasheet tests; builds the renamed pump sample. dotnet test tests\Opc.Ua.Di.Tests\Opc.Ua.Di.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~PumpDatasheetConformanceTests' --verbosity minimal # Passed: 4 repository NodeSet path/round-trip tests, including the moved pump models. dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~RepositorySourceSurvivesSerializedLinkedPartitionsAsync' --verbosity minimal # Passed: build, zero warnings/errors. dotnet build samples\ISA95\MinimalIsa95Server\MinimalIsa95Server.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal # Passed: dependent sample-test project build, zero warnings/errors. dotnet build tests\Opc.Ua.WotCon.Samples.Tests\Opc.Ua.WotCon.Samples.Tests.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal ``` Earlier focused integration checks passed 2,620 tests across AutoID, event queues/scheduling, source generation, MCP/package profiles and WoT. Both reviewed Mermaid diagrams rendered locally without network access. These checks are not a full solution run. The full solution has **not** been rerun for this review. Earlier `dotnet test UA.slnx -p:CustomTestTarget=net10.0 --verbosity quiet` did not pass: three AOT projects rejected VSTest and 20 Vision tests failed during graphics initialization with `OutOfMemoryException`. Remaining long-running tests were stopped at the user's request. A focused Vision rerun passed 558 tests and reproduced those 20 failures. The earlier `dotnet test UA.slnx -p:CustomTestTarget=net48 --verbosity quiet` was blocked by the former SDK pin and was not retried after the policy change. The user approved proceeding with those limitations documented; current remote CI is not claimed green. ## Related Issues - Follow-up #4842 tracks the requested 2.0.2+ benchmark/tuning and diagnostic-tool documentation refresh. #4841 supplies documentation and earlier results, not all newly requested measurements. - #4758 explains the conversion guide's earlier consolidation; the current provider contracts are now consolidated into `WotNodeSetConversion.md`. - #4839 supplies the reviewed API corrections; #4843 supplies the updated CTT issue record. - The original prose cleanup and SDK policy were user-requested without a source issue. No new runtime architecture is introduced by these documentation edits. ## Checklist _Put an `x` in the boxes that apply. You can complete these step by step after opening the PR._ - [ ] 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. - [ ] 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. - [ ] 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. - [ ] 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: Roman Ettlinger <romanett98@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
302 lines
9.7 KiB
Markdown
302 lines
9.7 KiB
Markdown
# GenX-500 Diesel Generating Set — Technical Data
|
||
|
||
**SimGen Systems** · 400 kW Prime / 440 kW Standby · 50 Hz · 400/230 V
|
||
|
||
> **This is a simulated device.** *SimGen Systems* and the *GenX-500* do not
|
||
> exist. The data below are ordinary engineering parameters for a mid-size
|
||
> industrial diesel generating set, chosen so that the simulation in
|
||
> `GeneratorServer` is physically self-consistent. They describe
|
||
> no real product.
|
||
>
|
||
> Every value here is also a constant in
|
||
> [`GeneratorDatasheet.cs`](GeneratorDatasheet.cs), which the server uses to build
|
||
> the address space and drive the simulation.
|
||
> `GeneratorDatasheetConformanceTests` fails the build if this document and the
|
||
> code ever disagree.
|
||
|
||
---
|
||
|
||
## 1 Product description
|
||
|
||
The GenX-500 is a skid-mounted, radiator-cooled diesel generating set for prime
|
||
and standby duty. A turbocharged and aftercooled inline-six drives a four-pole
|
||
brushless alternator through a flexible coupling; both are mounted on a welded
|
||
steel base frame with anti-vibration mounts and an integral fuel tank.
|
||
|
||
A single control panel provides start/stop, mode selection, metering, protection
|
||
and an OPC UA interface conforming to the
|
||
[Generators companion specification](https://opcfoundation.org/UA/Generators/).
|
||
|
||
---
|
||
|
||
## 2 Nameplate
|
||
|
||
| Field | Value | OPC UA browse path |
|
||
|---|---|---|
|
||
| Manufacturer | SimGen Systems | `2:Identification/2:Manufacturer` |
|
||
| Model | GenX-500 | `2:Identification/2:Model` |
|
||
| Product code | GX500-400-50-4W | `2:Identification/2:ProductCode` |
|
||
| Serial number | `SG-500-<nnn>` | `2:Identification/2:SerialNumber` |
|
||
| Device class | GeneratingSet | `2:Identification/3:DeviceClass` |
|
||
| Hardware revision | 3.1 | `2:Identification/2:HardwareRevision` |
|
||
| Software revision | 5.4.2 | `2:Identification/2:SoftwareRevision` |
|
||
| Device revision | 3.1/5.4.2 | `2:Identification/2:DeviceRevision` |
|
||
| Manufacturer URI | `https://simgen.example.com` | `2:Identification/2:ManufacturerUri` |
|
||
| Year of construction | 2025 | `2:Identification/3:YearOfConstruction` |
|
||
| Month of construction | 4 | `2:Identification/3:MonthOfConstruction` |
|
||
|
||
Namespace prefixes: `2:` = `http://opcfoundation.org/UA/DI/`,
|
||
`3:` = `http://opcfoundation.org/UA/Machinery/`,
|
||
`4:` = `http://opcfoundation.org/UA/Generators/`.
|
||
|
||
---
|
||
|
||
## 3 Ratings (ISO 8528)
|
||
|
||
| Duty | Real power | Apparent power | Application |
|
||
|---|---|---|---|
|
||
| **PRP** — Prime | **400 kW** | **500 kVA** | Unlimited hours, variable load |
|
||
| **ESP** — Standby | **440 kW** | **550 kVA** | Emergency use, varying load |
|
||
|
||
| Parameter | Value |
|
||
|---|---|
|
||
| Rated power factor | 0.8 lagging |
|
||
| Rated line-to-line voltage | 400 V |
|
||
| Rated line-to-neutral voltage | 230 V |
|
||
| Rated line current at PRP | 721.7 A |
|
||
| Frequency | 50 Hz |
|
||
| Phases / wires | 3 / 4 |
|
||
| Reference ambient | 25 °C |
|
||
| Reference altitude | 150 m |
|
||
|
||
Rated current is not tabulated independently — it is
|
||
`I = S / (√3 · V_LL)`, so it cannot drift away from the rating it derives from.
|
||
|
||
---
|
||
|
||
## 4 Engine
|
||
|
||
| Parameter | Value |
|
||
|---|---|
|
||
| Configuration | Inline 6-cylinder, 4-stroke |
|
||
| Aspiration | Turbocharged, air-to-air aftercooled |
|
||
| Displacement | 12.5 L |
|
||
| Bore × stroke | 130 × 157 mm |
|
||
| Compression ratio | 16.5 : 1 |
|
||
| Rated speed | 1500 min⁻¹ |
|
||
| Governor | Electronic, isochronous |
|
||
| Oil pressure at rated speed | 4.8 bar |
|
||
| Thermostat opening | 82 °C |
|
||
| Cooling | Radiator, engine-driven fan |
|
||
|
||
Rated speed follows from the pole count and output frequency:
|
||
`N = 120 · f / p = 120 · 50 / 4 = 1500 min⁻¹`.
|
||
|
||
---
|
||
|
||
## 5 Alternator
|
||
|
||
| Parameter | Value |
|
||
|---|---|
|
||
| Type | Brushless, self-excited, 4-pole |
|
||
| Connection | Star (wye), 4-wire |
|
||
| Insulation class | H |
|
||
| Voltage regulation | ±0.5 % steady state |
|
||
| Phases | L1, L2, L3 individually metered |
|
||
|
||
---
|
||
|
||
## 6 Fuel system
|
||
|
||
| Parameter | Value |
|
||
|---|---|
|
||
| Fuel | Diesel |
|
||
| Base tank capacity | 1000 L |
|
||
| Reference fuel density | 0.832 kg/L |
|
||
| Reference lower heating value | 42.7 MJ/kg |
|
||
| Usable energy per litre | 9.868 kWh/L |
|
||
|
||
---
|
||
|
||
## 7 Physical
|
||
|
||
| Parameter | Value |
|
||
|---|---|
|
||
| Length × width × height | 4.00 × 1.50 × 2.20 m |
|
||
| Dry mass | 4500 kg |
|
||
| Sound pressure at 1 m (enclosed) | 75 dB(A) |
|
||
|
||
---
|
||
|
||
## 8 Characteristic curves
|
||
|
||
Load fraction `x` — electrical output as a fraction of prime power — is the
|
||
**only independent variable**. Everything else follows from these curves, so
|
||
the published values remain mutually consistent at every tick.
|
||
|
||
### 8.1 Fuel consumption
|
||
|
||
The classic affine generating-set fuel map:
|
||
|
||
```
|
||
V̇_f(x) = 3.67 + 100.00 · x [L/h]
|
||
```
|
||
|
||
### 8.2 Electrical efficiency
|
||
|
||
```
|
||
η(x) = P(x) / (V̇_f(x) · ρ · LHV)
|
||
```
|
||
|
||
with `ρ · LHV = 9.868 kWh/L`. Efficiency is therefore never an independent
|
||
number: it always reconciles with the published power and fuel rate.
|
||
|
||
### 8.3 Thermal
|
||
|
||
```
|
||
T_coolant(x) = 82 + 13 · x [°C]
|
||
T_exhaust(x) = 250 + 300 · x [°C]
|
||
```
|
||
|
||
### 8.4 Electrical
|
||
|
||
```
|
||
S = P / PF [VA]
|
||
I = S / (√3 · V_LL) [A]
|
||
f = N · p / 120 [Hz]
|
||
```
|
||
|
||
---
|
||
|
||
## 9 Performance table
|
||
|
||
Derived from the curves in §8 — this table is generated by them, not
|
||
independently asserted.
|
||
|
||
| Load | Real power | Fuel rate | Efficiency | Coolant | Exhaust |
|
||
|---:|---:|---:|---:|---:|---:|
|
||
| 10 % | 40 kW | 13.7 L/h | 29.65 % | 83.3 °C | 280 °C |
|
||
| 25 % | 100 kW | 28.7 L/h | 35.34 % | 85.2 °C | 325 °C |
|
||
| 50 % | 200 kW | 53.7 L/h | 37.76 % | 88.5 °C | 400 °C |
|
||
| 75 % | 300 kW | 78.7 L/h | 38.64 % | 91.8 °C | 475 °C |
|
||
| 100 % | 400 kW | 103.7 L/h | 39.10 % | 95.0 °C | 550 °C |
|
||
| 110 % | 440 kW | 113.7 L/h | 39.22 % | 96.3 °C | 580 °C |
|
||
|
||
At 1000 L usable capacity and full prime load the set runs for approximately
|
||
**9.6 hours** on a full tank.
|
||
|
||
---
|
||
|
||
## 10 Instrumentation
|
||
|
||
| Measurement | Unit published | Engineering range | Browse path |
|
||
|---|---|---|---|
|
||
| Engine speed | min⁻¹ | 0 … 2000 | `4:Engine/4:Speed` |
|
||
| Oil pressure | Pa | 0 … 8 bar | `4:Engine/4:OilPressure` |
|
||
| Coolant temperature | K | 0 … 120 °C | `4:Engine/4:CoolantTemperature` |
|
||
| Exhaust temperature | K | 0 … 700 °C | `4:Engine/4:ExhaustTemperature` |
|
||
| Fuel rate | m³/s | 0 … 120 L/h | `4:Engine/4:FuelRate` |
|
||
| Engine hours | h | — | `4:Engine/4:EngineHours` |
|
||
| Frequency | Hz | 45 … 55 | `4:Alternator/4:Frequency` |
|
||
| Total real power | W | 0 … 550 kW | `4:Alternator/4:TotalRealPower` |
|
||
| Average voltage | V | 0 … 480 | `4:Alternator/4:AverageLineVoltage` |
|
||
| Average current | A | 0 … 800 | `4:Alternator/4:AverageCurrent` |
|
||
| Power factor | — | 0 … 1 | `4:Alternator/4:AveragePowerFactor` |
|
||
| Load percent | % | 0 … 120 | `4:Alternator/4:LoadPercent` |
|
||
| Per-phase V/I/P/PF | V/A/W/— | as above | `4:Alternator/4:L1 … 4:L3` |
|
||
| Fuel level | % | 0 … 100 | `4:FuelSystem/4:FuelLevel` |
|
||
| Battery voltage | V | 0 … 32 | `4:StartingSystem/4:BatteryVoltage` |
|
||
|
||
OPC UA publishes SI throughout: temperatures in kelvin, pressures in pascal,
|
||
volumetric rates in cubic metres per second. The datasheet's own engineering
|
||
units are converted on the way out.
|
||
|
||
---
|
||
|
||
## 11 Protection trip points
|
||
|
||
| Protection | Trip | Effect |
|
||
|---|---|---|
|
||
| Low oil pressure | < 1.7 bar | Shutdown |
|
||
| High coolant temperature | > 98 °C | Shutdown |
|
||
| Overspeed | > 1725 min⁻¹ (115 %) | Shutdown |
|
||
| Overload | > 110 % of PRP | Alarm |
|
||
| Low fuel level | < 15 % | Warning |
|
||
| Low battery voltage | < 22 V | Warning |
|
||
|
||
Protection events are reported as `4:GeneratorProtectionAlarmType`, a subtype of
|
||
`OffNormalAlarmType`, carrying the `ProtectionFunction`, severity, whether the
|
||
event is a shutdown, and the originating subsystem.
|
||
|
||
---
|
||
|
||
## 12 Operating states
|
||
|
||
`OperatingState` is a `4:GeneratorStateMachineType` with twelve states:
|
||
|
||
```mermaid
|
||
stateDiagram-v2
|
||
[*] --> Off
|
||
Off --> Ready
|
||
Ready --> Starting
|
||
Ready --> Off
|
||
Starting --> Warmup
|
||
Starting --> Fault
|
||
Warmup --> Running
|
||
Running --> Loaded
|
||
Running --> Cooldown
|
||
Running --> Fault
|
||
Loaded --> Cooldown
|
||
Loaded --> Fault
|
||
Cooldown --> Stopping
|
||
Stopping --> Off
|
||
Fault --> Off
|
||
Running --> EmergencyStopped
|
||
Loaded --> EmergencyStopped
|
||
EmergencyStopped --> Off
|
||
```
|
||
|
||
`OperatingMode` reflects the panel selector: `Off`, `Manual`, `Auto`, `Test`,
|
||
`Exercise`, `RemoteStart`, `Maintenance`, `Lockout`.
|
||
|
||
---
|
||
|
||
## 13 Process schematic
|
||
|
||
```mermaid
|
||
flowchart LR
|
||
TANK[("Fuel tank<br/>1000 L")] -->|"V̇_f(x)"| ENG
|
||
AIR([Intake air]) --> TC[Turbocharger]
|
||
TC --> AC[Aftercooler] --> ENG
|
||
ENG[["Engine<br/>12.5 L inline-6<br/>1500 min⁻¹"]] --> CPL{{Coupling}}
|
||
CPL --> ALT[["Alternator<br/>4-pole brushless<br/>400 V 50 Hz"]]
|
||
ENG -->|exhaust| SIL[Silencer] --> STK([Stack])
|
||
ENG <-->|jacket water| RAD[Radiator + fan]
|
||
ALT --> BRK[/Breaker/] --> BUS([Load bus])
|
||
BATT[("Battery<br/>24 V")] --> STR[Starter] --> ENG
|
||
CTRL[Controller] -.->|start / stop / mode| ENG
|
||
ALT -.->|V, I, f, PF| CTRL
|
||
ENG -.->|speed, oil, coolant| CTRL
|
||
```
|
||
|
||
---
|
||
|
||
## 14 Simulation profile
|
||
|
||
The server does not replay a recording. It integrates the model above:
|
||
|
||
1. Load fraction is driven around a nominal 72 % with an 18 % swing, phase
|
||
shifted per set so no two sets in a plant report the same duty point.
|
||
2. Real power, apparent power, per-phase voltage and current, frequency, fuel
|
||
rate, efficiency, coolant and exhaust temperature all follow from that single
|
||
value through §8.
|
||
3. Engine hours, total real energy and fuel consumed are integrated over time.
|
||
4. Protection states are evaluated against §11 with hysteresis, so an alarm
|
||
latches and clears cleanly rather than chattering on the threshold.
|
||
5. The operating state machine advances through §12, staged per set so that a
|
||
plant shows sets in different states simultaneously.
|
||
|
||
Because power and fuel rate are both functions of the same load fraction,
|
||
`η = P / (V̇_f · ρ · LHV)` and `P = √3 · V · I · PF` hold at **every** published
|
||
sample — which is exactly what the conformance tests assert.
|