Skip to content

docs: correct stale detection rule and scenario counts #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sepehr-safari merged 2 commits into from
Jul 14, 2026
Merged

docs: correct stale detection rule and scenario counts #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01001b2
docs: correct stale detection rule and scenario counts
sepehr-safari Jul 14, 2026
26cc214
chore: add changeset for README count correction
sepehr-safari Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/readme-rule-scenario-counts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@ocpp-debugkit/toolkit': patch
---

Correct the package README, which advertised 10 detection rules and 10 predefined scenarios. The toolkit ships 16 detection rules (4 critical, 10 warning, 2 info) and 15 scenarios.
15 changes: 10 additions & 5 deletions CURRENT_STATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

## Current Version

`0.3.0` — Integrations & OSS Credibility (published)
`0.3.1` — Integrations & OSS Credibility (published)

## Active Milestone

**v1.0.0 — Stable FOSS Ecosystem (next)**

v0.3.0 is published to npm. Adds trace diffing, rich scenario assertions,
CI/anonymize/diff CLI commands, 15 detection rules, 15 scenarios, integration
examples, and contributor onboarding.
v0.3.1 is published to npm. The v0.3 line adds trace diffing, rich scenario
assertions, CI/anonymize/diff CLI commands, 16 detection rules, 15 scenarios,
integration examples, and contributor onboarding.

## What's Done

Expand Down Expand Up @@ -219,6 +219,11 @@ examples, and contributor onboarding.
- ✅ `REPEATED_BOOT_NOTIFICATION` — flags 2+ BootNotification calls within
five minutes. Added as the 16th detection rule (Issue #105).

### v0.3.1 Release

- ✅ `@ocpp-debugkit/toolkit@0.3.1` published to npm
- ✅ Git tag `v0.3.1` + GitHub release `v0.3.1` created

## What's Next

1. **v1.0.0 — Stable FOSS Ecosystem** — API stabilization, 20+ scenarios, docs
Expand All @@ -234,7 +239,7 @@ examples, and contributor onboarding.

| Package | Status | Version |
|---------|--------|---------|
| `@ocpp-debugkit/toolkit` | published | 0.3.0 |
| `@ocpp-debugkit/toolkit` | published | 0.3.1 |
| `@ocpp-debugkit/core` | deprecated | 0.1.1 |
| `@ocpp-debugkit/scenarios` | deprecated | 0.1.1 |
| `@ocpp-debugkit/reporter` | deprecated | 0.1.1 |
Expand Down
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ validate behavior against known scenarios.

- **Trace Inspector** — Load OCPP traces, view session timelines, inspect
individual messages, and identify failures.
- **Failure Detection** — 10 detection rules covering common failure patterns
(failed authorization, connector faults, station offline, heartbeat timeout,
meter value gaps, invalid stop reasons, status transition violations,
diagnostics failures, firmware update failures, unexpected starts).
- **Scenario Evaluator** — 10 predefined scenarios with expected failure
- **Failure Detection** — 16 detection rules (4 critical, 10 warning, 2 info)
covering common failure patterns: failed authorization, connector faults,
station offline, heartbeat timeout, meter value gaps, invalid stop reasons,
unexpected starts, status transition violations, diagnostics failures,
firmware update failures, suspicious session duration, slow CSMS responses,
heartbeat interval violations, meter value anomalies, unresponsive CSMS, and
repeated boot notifications.
- **Scenario Evaluator** — 15 predefined scenarios with expected failure
outcomes for testing the analysis engine. Supports external scenario files.
- **Replay Engine** — Deterministic, pure replay engine with step forward/back,
jump-to-event, and configurable playback speed.
Expand Down
13 changes: 8 additions & 5 deletions packages/toolkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ report generation, React components, and CLI.

- **Trace Parser** — Parse OCPP 1.6 JSON traces in JSON Object, JSONL, or bare
array format. Safe parsing with size and event-count limits.
- **Failure Detection** — 10 detection rules covering common failure patterns
(failed authorization, connector faults, station offline, heartbeat timeout,
meter value gaps, invalid stop reasons, status transition violations,
diagnostics failures, firmware update failures, unexpected starts).
- **Scenario Evaluator** — 10 predefined scenarios with expected failure
- **Failure Detection** — 16 detection rules (4 critical, 10 warning, 2 info)
covering common failure patterns: failed authorization, connector faults,
station offline, heartbeat timeout, meter value gaps, invalid stop reasons,
unexpected starts, status transition violations, diagnostics failures,
firmware update failures, suspicious session duration, slow CSMS responses,
heartbeat interval violations, meter value anomalies, unresponsive CSMS, and
repeated boot notifications.
- **Scenario Evaluator** — 15 predefined scenarios with expected failure
outcomes for testing the analysis engine. Supports external scenario files.
- **Replay Engine** — Deterministic, pure replay engine with step forward/back,
jump-to-event, and configurable playback speed. No timers or I/O.
Expand Down
Loading