LIGO AIR Firmware Changelog

Description

Brief intro to the firmware changelog per Keep a Changelog standard.

What to fill in:

• 1–2 paragraph intro explaining the purpose of this page
• Specify which product line this firmware changelog covers
• Mention the standards used:
  • Keep a Changelog for format
  • Semantic Versioning (MAJOR.MINOR.PATCH) for version numbering
• Note how firmware files are distributed (authorized partners, downloadable links, etc.)

Example structure: "This page lists all firmware releases for the [Product Name] [type]. The changelog follows the Keep a Changelog standard and uses Semantic Versioning (MAJOR.MINOR.PATCH). Firmware files are distributed via authorized SOJI partners — contact your sales representative for access."

Version History

Chronological list of all firmware releases (most recent first).

What to fill in: sortable table with columns:

• Version — version number per SemVer (e.g., 1.2.0, 1.1.2)
• Date — release date (YYYY-MM-DD)
• Description — bullet list grouped by change category

Description format — use these standard categories:

• * '''Added''' — new features
• * '''Changed''' — behavior changes / improvements
• * '''Fixed''' — bug fixes (link to PCN if applicable)
• * '''Security''' — security patches (include CVE if applicable)
• * '''Known Issues''' — limitations with workarounds
• * '''Deprecated''' — features being phased out
• * '''Removed''' — features removed in this version

Versioning rules:

• MAJOR — incompatible API/protocol changes (requires re-qualification)
• MINOR — new features, backward-compatible
• PATCH — bug fixes only
• Pre-release — append -alpha.N, -beta.N, -rc.N

How to add a new version: copy a row block (from |- to next |-) and paste at top of table. Update Version, Date, and Description fields.

Compatibility

Matrix showing which firmware versions work on which hardware revisions.

What to fill in: table with columns:

• Firmware Version — version number
• Hardware Rev A, Rev B, Rev C, etc. — one column per hardware revision

Status indicators:

• ✅ Supported — works without issues
• ⚠️ Known issue — works but has documented bug
• ❌ Not supported — incompatible

Note: Add as many hardware revision columns as your product has. Remove unused columns.

Closing note suggestion: "If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported."

Revision History

Loading revision history...