Skip to content

Commit afcf909

Browse files
committed
Polish landing preview and clean portable release package
1 parent 6d1ec20 commit afcf909

15 files changed

Lines changed: 678 additions & 524 deletions

.github/workflows/release-package.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
release_notes_file:
2626
description: 'Markdown file used as release body'
2727
required: true
28-
default: 'docs/RELEASE_NOTES_v1.2.0.md'
28+
default: 'docs/RELEASE_NOTES_v1.2.6.md'
2929
push:
3030
tags:
3131
- 'v*'
@@ -103,8 +103,8 @@ jobs:
103103
$zip = "artifacts/release/ProcessBusInsight-v$version-win-x64-portable.zip"
104104
$sha = "artifacts/release/SHA256SUMS.txt"
105105
$notesFile = '${{ github.event.inputs.release_notes_file }}'
106-
if ([string]::IsNullOrWhiteSpace($notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.2.0.md' }
107-
if (-not (Test-Path $notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.2.0.md' }
106+
if ([string]::IsNullOrWhiteSpace($notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.2.6.md' }
107+
if (-not (Test-Path $notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.2.6.md' }
108108
if (-not (Test-Path $notesFile)) { throw "Release notes file not found: $notesFile" }
109109
110110
$releaseArgs = @('release','create',$tag,$zip,$sha,'--title',"Process Bus Insight $tag",'--notes-file',$notesFile,'--target','${{ github.sha }}')

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,4 +264,4 @@ scripts/verify-release-package.ps1
264264
.github/workflows/release-package.yml
265265
```
266266

267-
The package should contain the published app, quick-start note, license, notice files, third-party notices, and a convenience launcher only when it helps desktop users run the app.
267+
The package should contain the published app, quick-start note, license, notice files, third-party notices, and documents needed by desktop users.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Before opening a pull request:
2828

2929
1. Build the solution in Release mode.
3030
2. Confirm the app still starts on Windows.
31-
3. Keep README and docs user-facing.
31+
3. Keep README and docs clear for engineers using the application.
3232
4. Add or update validation notes when behavior changes.
3333
5. Avoid committing `bin`, `obj`, `artifacts`, captures, logs, or local settings.
3434

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Process Bus Insight (DigSubAnalyzer) IEC 61850 SV, GOOSE & PTP Analyzer for Windows
1+
# Process Bus Insight (DigSubAnalyzer) - IEC 61850 SV, GOOSE & PTP Analyzer for Windows
22

33
[![CI](https://github.com/masarray/DigSubAnalyzer/actions/workflows/ci.yml/badge.svg)](https://github.com/masarray/DigSubAnalyzer/actions/workflows/ci.yml)
44
[![GitHub Pages](https://github.com/masarray/DigSubAnalyzer/actions/workflows/pages.yml/badge.svg)](https://github.com/masarray/DigSubAnalyzer/actions/workflows/pages.yml)
@@ -81,7 +81,7 @@ ProcessBusInsight-v1.2.0-public-beta-win-x64-portable.zip
8181
SHA256SUMS.txt
8282
```
8383

84-
The portable package contains a self-contained single-file Windows EXE in the `app` folder, quick-start notes, license files, third-party notices, and a small launcher batch file for convenience. Visual Studio and a separate .NET runtime installation are not required to run the portable release package.
84+
The portable package contains a clean single-file Windows EXE at the package root, Quick Start PDF, User Manual PDF, license file, and third-party notices. Visual Studio and a separate .NET runtime installation are not required to run the portable release package.
8585

8686
Runtime notes:
8787

@@ -141,13 +141,13 @@ Create a local portable package:
141141

142142
## Documentation
143143

144-
- [`docs/QUICK_START.md`](docs/QUICK_START.md) first run and field checklist.
145-
- [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md) adapter, Npcap, empty traffic, and timing interpretation issues.
146-
- [`docs/VALIDATION_MATRIX.md`](docs/VALIDATION_MATRIX.md) practical validation scope for SV, GOOSE, PTP, SCL, and evidence.
147-
- [`docs/RELEASE_PACKAGING.md`](docs/RELEASE_PACKAGING.md) portable release package design.
148-
- [`docs/DEPLOYMENT.md`](docs/DEPLOYMENT.md) GitHub Pages and release automation notes.
149-
- [`docs/ROADMAP.md`](docs/ROADMAP.md) — user-facing product roadmap.
150-
- [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md) runtime and redistribution notes.
144+
- [`docs/QUICK_START.md`](docs/QUICK_START.md) / [`docs/QUICK_START.pdf`](docs/QUICK_START.pdf) - first run and field checklist.
145+
- [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md) - adapter, Npcap, empty traffic, and timing interpretation issues.
146+
- [`docs/VALIDATION_MATRIX.md`](docs/VALIDATION_MATRIX.md) - practical validation scope for SV, GOOSE, PTP, SCL, and evidence.
147+
- [`docs/RELEASE_PACKAGING.md`](docs/RELEASE_PACKAGING.md) - portable release package design.
148+
- [`docs/DEPLOYMENT.md`](docs/DEPLOYMENT.md) - GitHub Pages and release automation notes.
149+
- [`docs/ROADMAP.md`](docs/ROADMAP.md) - product roadmap.
150+
- [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md) - runtime and redistribution notes.
151151

152152
## Roadmap / Planned improvements
153153

docs/QUICK_START.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ C:\Tools\ProcessBusInsight
3434
Open the extracted folder and run:
3535

3636
```text
37-
app\ProcessBusInsight.exe
37+
ProcessBusInsight.exe
3838
```
3939

40-
The default release package publishes the app payload as a self-contained single EXE. The package also includes `Start-ProcessBusInsight.bat` as a convenience launcher.
40+
The default release package publishes the app as a self-contained single EXE at the package root. The package also includes Quick Start PDF and User Manual PDF documents for offline field use.
4141

4242
## 4. Start a safe capture workflow
4343

docs/RELEASE_NOTES_v1.2.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Release Notes — v1.2.0-public-beta
22

3-
This public beta hardens Process Bus Insight as a user-facing open-source Windows tool for IEC 61850 Process Bus visibility.
3+
This public beta prepares Process Bus Insight as an open-source Windows tool for IEC 61850 Process Bus visibility.
44

55
## Highlights
66

7-
- User-facing README with clear download, run, build, documentation, and contribution guidance.
8-
- SEO-ready GitHub Pages landing page with screenshots, FAQ, social preview metadata, and structured data.
7+
- README with clear download, run, build, documentation, and contribution guidance.
8+
- GitHub Pages landing page with screenshots, FAQ, social preview metadata, and structured data.
99
- Windows portable release automation for GitHub Actions with a self-contained single-EXE app payload.
1010
- Local PowerShell scripts to publish and verify the portable package.
1111
- GitHub repository setup script for description, homepage, topics, and repository feature settings.

docs/RELEASE_NOTES_v1.2.6.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Release Notes - v1.2.6
2+
3+
Process Bus Insight v1.2.6 improves the download experience, portable package layout, and product landing page for engineers who want to try the tool quickly on a Windows machine.
4+
5+
## What's new
6+
7+
- Cleaner GitHub Pages landing page with smaller typography, smoother navigation, and a more polished product preview.
8+
- Clickable screenshots with fullscreen preview, blurred background, and simple close behaviour.
9+
- Updated screenshot gallery and trailer section for first-time users evaluating the tool.
10+
- Refined FAQ for substation automation engineers preparing to use the app during FAT, SAT, commissioning, or lab troubleshooting.
11+
- Portable release package now opens directly from `ProcessBusInsight.exe`.
12+
- Release ZIP now includes `Quick Start.pdf` and `User Manual.pdf` for offline use.
13+
14+
## Download
15+
16+
Use the Windows x64 portable package from GitHub Releases:
17+
18+
```text
19+
ProcessBusInsight-v1.2.6-win-x64-portable.zip
20+
SHA256SUMS.txt
21+
```
22+
23+
After extracting the ZIP, run:
24+
25+
```text
26+
ProcessBusInsight.exe
27+
```
28+
29+
## Included documents
30+
31+
- `Quick Start.pdf` - first-run checklist and safe capture setup.
32+
- `User Manual.pdf` - practical guide for SV, GOOSE, PTP, SCL validation, evidence, and timing limitations.
33+
34+
## Runtime scope
35+
36+
Process Bus Insight is receive-only and raw-passive. It decodes observed SV, GOOSE, and PTP traffic and helps compare live traffic against SCL engineering expectation. It does not send control commands and does not replace certified timing or relay test equipment.
37+
38+
Npcap is required on the target machine and is not bundled in this repository.

docs/RELEASE_PACKAGING.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Release Packaging Process Bus Insight
1+
# Release Packaging - Process Bus Insight
22

3-
The release workflow creates a Windows x64 portable package for users who want to try the app without Visual Studio. By default, the application payload is published as a self-contained single EXE.
3+
The release workflow creates a Windows x64 portable package for users who want to try the app without Visual Studio. The application is published as a self-contained single EXE.
44

55
## Output files
66

7-
A release package contains:
7+
A release creates:
88

99
```text
1010
ProcessBusInsight-v<version>-win-x64-portable.zip
@@ -14,21 +14,25 @@ SHA256SUMS.txt
1414
The ZIP contains:
1515

1616
```text
17-
app/ProcessBusInsight.exe single self-contained Windows application
18-
Start-ProcessBusInsight.bat simple launcher
19-
README_QUICK_START.txt user-facing run instructions
20-
LICENSE
21-
NOTICE
17+
ProcessBusInsight.exe single self-contained Windows application
18+
Quick Start.pdf first-run checklist for Windows users
19+
User Manual.pdf practical user guide for IEC 61850 capture workflow
20+
README.txt short package note
21+
LICENSE.txt
22+
NOTICE.txt
2223
THIRD_PARTY_NOTICES.md
2324
```
2425

26+
The portable ZIP keeps startup clean: users run `ProcessBusInsight.exe` directly.
27+
2528
## Local packaging
2629

2730
Run from the repository root:
2831

2932
```powershell
30-
.\scripts\publish-windows-portable.ps1 -Version "1.2.0-public-beta"
31-
.\scripts\verify-release-package.ps1 -PackageZip ".\artifacts\release\ProcessBusInsight-v1.2.0-public-beta-win-x64-portable.zip"
33+
.\scripts\publish-windows-portable.ps1 -Version "1.2.6"
34+
.\scripts erify-release-package.ps1 -PackageZip ".rtifacts
35+
elease\ProcessBusInsight-v1.2.6-win-x64-portable.zip"
3236
```
3337

3438
## GitHub release workflow
@@ -37,11 +41,11 @@ The release workflow can be started manually from the GitHub Actions tab. It als
3741

3842
Manual inputs:
3943

40-
- `version` release version label, for example `1.2.0-public-beta`.
41-
- `publish_release` when `true`, create or update a GitHub Release.
42-
- `prerelease` mark release as prerelease.
43-
- `draft` create a draft release.
44-
- `release_notes_file` markdown file used as release body.
44+
- `version` - release version label, for example `1.2.6`.
45+
- `publish_release` - when `true`, create or update a GitHub Release.
46+
- `prerelease` - mark release as prerelease.
47+
- `draft` - create a draft release.
48+
- `release_notes_file` - markdown file used as release body.
4549

4650
## Runtime prerequisite
4751

docs/USER_MANUAL.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# User Manual - Process Bus Insight
2+
3+
Process Bus Insight is a receive-only Windows analyzer for IEC 61850 Process Bus visibility. It helps substation automation engineers observe Sampled Values, GOOSE, PTP timing context, and SCL expected-vs-observed validation during FAT, SAT, commissioning, and troubleshooting.
4+
5+
## Product boundary
6+
7+
- Receive-only and raw-passive.
8+
- Does not send IEC 61850 control commands.
9+
- Does not publish GOOSE or Sampled Values.
10+
- Does not replace certified relay test sets or timing instruments.
11+
- Uses Windows/Npcap capture timestamps for screening and troubleshooting.
12+
13+
## Before you start
14+
15+
Use a safe capture path such as a TAP, mirror port, or isolated engineering test switch. Avoid connecting an unverified PC directly into a protection-critical path. Install Npcap when raw Ethernet frame capture is required.
16+
17+
## Running the portable package
18+
19+
1. Download the latest Windows x64 portable ZIP from GitHub Releases.
20+
2. Extract it to a local folder, for example `C:\Tools\ProcessBusInsight`.
21+
3. Run `ProcessBusInsight.exe`.
22+
4. Select the physical Ethernet adapter connected to the Process Bus traffic.
23+
5. Start capture.
24+
25+
## Main workflow
26+
27+
1. Confirm the selected adapter is correct.
28+
2. Observe live Sampled Values streams.
29+
3. Inspect GOOSE publishers and event changes.
30+
4. Check PTP traffic presence and timing context when available.
31+
5. Load SCL when available.
32+
6. Compare expected objects against observed live traffic.
33+
7. Copy findings only after checking adapter, timestamp, and capture path confidence.
34+
35+
## Sampled Values view
36+
37+
Use the SV workspace to check stream identity, APPID, svID, VLAN, source MAC, continuity counters, waveform, phasor, and metering context. Treat missing stream or mismatch indications as investigation leads, not final protection conclusions until the network capture path is confirmed.
38+
39+
## GOOSE inspector
40+
41+
Use the GOOSE workspace to inspect publisher identity, state changes, stNum, sqNum, typed dataset values, and event history. This is useful when troubleshooting interlocking, trip, alarm, or binary status behaviour during testing.
42+
43+
## PTP timing context
44+
45+
Use PTP visibility to confirm timing traffic presence, transport, domain, and timing source context. Timing results from normal Windows capture are useful for screening, but not for certification-grade jitter proof.
46+
47+
## SCL validation
48+
49+
Load SCD, ICD, or CID files when engineering files are available. The app can compare expected APPID, VLAN, MAC, DataSet, confRev, and stream identity against observed traffic. This helps identify missing, unexpected, weak, mismatched, or conflicted objects.
50+
51+
## Troubleshooting no traffic
52+
53+
Common causes:
54+
55+
- Wrong adapter selected.
56+
- Npcap is not installed or capture permission is restricted.
57+
- Switch mirror port is not configured correctly.
58+
- VLAN traffic is not forwarded to the capture port.
59+
- PC is connected to the wrong network segment.
60+
- Traffic is not actually present from the publisher.
61+
62+
## Evidence guidance
63+
64+
Good FAT/SAT evidence should include adapter name, capture path, APPID, VLAN, source MAC, svID or GOOSE identity, timing context, SCL expected field, observed field, and confidence wording. Avoid overclaiming timing performance from software timestamps.
65+
66+
## Safety note
67+
68+
Process Bus Insight is a visibility tool. Always follow site safety rules, commissioning procedures, protection engineering sign-off, and customer test requirements.

0 commit comments

Comments
 (0)