Skip to content

docs: publish Viewer 0.2.2 stable documentation #19

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
han-xudong merged 1 commit into from
Oct 21, 2026
Merged

docs: publish Viewer 0.2.2 stable documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions data/ecosystem.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@
"audience": "Lab and field users",
"docsPath": "tutorials/viewer/connect-and-inspect",
"repository": "https://github.com/netft/netft-viewer",
"version": "0.2.1",
"version": "0.2.2",
"platforms": ["Linux", "macOS", "Windows"],
"installMethods": ["release", "source"],
"documentationOwner": "netft-docs",
"priority": 2,
"releaseChannel": "development"
"releaseChannel": "stable"
}
]
},
Expand Down
10 changes: 5 additions & 5 deletions data/reference/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@
"sourceCommit": "e272550080e10a1f1bc71c2ce6499c556ecd538c"
},
"netft-viewer": {
"version": "0.2.1",
"sourceTag": "v0.2.1",
"version": "0.2.2",
"sourceTag": "v0.2.2",
"repository": "https://github.com/netft/netft-viewer",
"sourceUrl": "https://github.com/netft/netft-viewer/tree/v0.2.1",
"sourceCommit": "678da9903880849d1a673504e3f16c177e384bcc",
"releaseChannel": "development"
"sourceUrl": "https://github.com/netft/netft-viewer/tree/v0.2.2",
"sourceCommit": "a7c8068a25aa6ac5b2dcd87271b477af283267bc",
"releaseChannel": "stable"
}
}
}
16 changes: 8 additions & 8 deletions docs/get-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ sidebar_position: 2

Choose one interface for the first connection. The CLI is the recommended commissioning tool because it can inspect configuration and run a bounded health check without a GUI, programming environment, or ROS graph.

Viewer 0.2.1 is a development prerelease without publisher signing. Its Windows installers are unsigned; macOS packages are not notarized. It is intended for development evaluation.
Viewer 0.2.2 is a stable release. Its Windows installers are unsigned; macOS packages use ad hoc signatures for code integrity and are not notarized. Operating-system policy may require explicit approval before opening the application. Publisher signing is optional and does not determine the release channel.

## Supported releases

| Interface | Version | Preferred install | Platforms |
| -------------- | ------------------------------ | ----------------------------------- | ------------------------------------------ |
| Net F/T CLI | 0.3.0 | GitHub release executable | Linux, macOS, Windows |
| Net F/T Viewer | 0.2.1 (development prerelease) | GitHub release installer or archive | Linux, macOS, Windows |
| netft-cpp | 0.3.4 | CMake source build | Linux, macOS, Windows |
| pyNetFT | 2.1.2 | PyPI wheel | CPython 3.10–3.14 on Linux, macOS, Windows |
| ros-netft | 0.4.0 | ROS workspace source build | Supported ROS environments on Linux |
| Interface | Version | Preferred install | Platforms |
| -------------- | ------- | ----------------------------------- | ------------------------------------------ |
| Net F/T CLI | 0.3.0 | GitHub release executable | Linux, macOS, Windows |
| Net F/T Viewer | 0.2.2 | GitHub release installer or archive | Linux, macOS, Windows |
| netft-cpp | 0.3.4 | CMake source build | Linux, macOS, Windows |
| pyNetFT | 2.1.2 | PyPI wheel | CPython 3.10–3.14 on Linux, macOS, Windows |
| ros-netft | 0.4.0 | ROS workspace source build | Supported ROS environments on Linux |

Check the [compatibility reference](../references/compatibility.mdx) before installing a later release.

Expand Down
6 changes: 3 additions & 3 deletions docs/references/data-formats/csv.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Monitor CSV is observation output. Its bounded presentation rate can be lower th
```text
schema_version,timestamp_utc,elapsed_seconds,rdt_sequence,ft_sequence,status,
raw_fx,raw_fy,raw_fz,raw_tx,raw_ty,raw_tz,
fx,fy,fz,tx,ty,tz,force_unit,torque_unit
fx,fy,fz,tx,ty,tz,force_unit,torque_unit,configuration_revision
```

`timestamp_utc` is for cross-system correlation. `elapsed_seconds` is the monotonic capture timeline and should be used for interval analysis.
Expand All @@ -41,7 +41,7 @@ CLI and Viewer recorders write a temporary `.partial` file and promote it only a

## Recording metadata (CLI 0.3.0 and Viewer 0.2.1)

After successful data finalization, the candidate writes `<output>.metadata.json` using schema version 1 and kind `netft-recording`. CLI and Viewer share these meanings:
CLI 0.3.0 and later and Viewer 0.2.1 and later write `<output>.metadata.json` after successful data finalization, using schema version 1 and kind `netft-recording`. Both applications share these meanings:

| Field | Meaning |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -57,4 +57,4 @@ After successful data finalization, the candidate writes `<output>.metadata.json

Partial or failed captures do not receive a completed summary. Metadata creation and promotion follow the data file's overwrite policy. The two files are finalized separately: a metadata failure reports an error and preserves the completed data file, and may leave a metadata partial for recovery. Keep both files when archiving a successful capture.

The CLI candidate appends `configuration_revision` to CSV without moving existing columns and adds it inside the NDJSON sample object. Viewer already records revisions in each CSV row. Existing published releases retain their documented formats until these changes are released.
CLI 0.3.0 and later append `configuration_revision` to CSV without moving existing columns and add it inside the NDJSON sample object. Viewer records revisions in each CSV row. Older releases retain their documented formats.
2 changes: 1 addition & 1 deletion docs/tutorials/viewer/connect-and-inspect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connect and inspect live data

Net F/T Viewer 0.2.1 is a cross-platform desktop application for one sensor. It combines raw counts, calibrated values, units, connection health, charts, bias, and buffered CSV recording without requiring ROS.
Net F/T Viewer 0.2.2 is a cross-platform desktop application for one sensor. It combines raw counts, calibrated values, units, connection health, charts, bias, and buffered CSV recording without requiring ROS.

![Net F/T Viewer showing connection controls, status, live values, and six chart panels.](/img/netft-viewer.png)

Expand Down