Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Esdieff documentation

Esdieff is a command-line toolkit and Rust library for connected-device models written in Semantic Definition Format, the SDF of IETF RFC 9880. It checks models, shows what a composed interface contains, compares revisions and turns model rules into test values. Model operations run offline on the documents you supply.

Where to start

  • New to Esdieff? Install and try a model installs the command, runs the supplied thermostat model and reads your first generated values.
  • Checking a model? Inspect and check a model supplies model files and shared definitions, runs the checks and follows each finding back to its source.
  • Testing a device or an app? Test values against a model checks single samples, generates boundary and invalid values and checks a log of recorded values in one run.
  • Reviewing a model change? Compare two revisions shows which changes between two revisions break the apps that use a device, and acknowledges the ones you intend.
  • Running checks in CI? Repeat checks and share reports saves checks as plans, checks whole directories and brings results into automation with JSON, SARIF and Markdown.
  • Building your own tool? Use the Rust library embeds the same checking, inspection and comparison in your own program.
  • Looking up a command or option? See the command line reference.
  • Something not working? See troubleshooting.

Esdieff works on model files and JSON values. It does not connect to devices or test network protocols.

Each guide walks through one task with real commands and their output.

Reference

The reference pages are the contracts behind each command. They state what an operation promises, what its report contains and where its limits lie.

How it works and why

How Esdieff works follows the process map from supplied files to model checks, revision comparisons and test values. The architecture decisions in the repository record why Esdieff behaves as it does, from exact numbers to client-side revision comparison. Contributing and project records links the contribution guide and the changelog.