|
|
| (19 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| <noinclude> | | <noinclude> |
| {{TemplateData | | {{TemplateData |
| |description=Boilerplate for product Firmware Changelog page. Includes inline placeholders and edit hints for each section. | | |description=Boilerplate for product Firmware Changelog page. |
| }} | | }} |
| </noinclude><includeonly>
| |
|
| |
|
| <!-- ════════════════════════════════════════════════════════════════
| | 4 mandatory sections (== H2 ==): |
| INSTRUCTIONS FOR EDITOR:
| | # Description |
| - Replace all {{Placeholder|...}} calls with your actual content
| | # Version History |
| - Update {{FW-Latest-Release}} with the current latest version
| | # Compatibility |
| - Add a new {{FW-Row-Summary}} and {{FW-Row-Detail}} for each new release
| | # Related Pages |
| - Update Compatibility table when HW revision changes
| |
| - Add an entry to Document Revision History after each edit
| |
| ════════════════════════════════════════════════════════════════ -->
| |
|
| |
|
| == Description == | | [[Category:Boilerplates]] |
| <!-- WHAT TO WRITE: Brief 1-2 paragraph intro about this changelog. Mention the product, the standard used (e.g., Keep a Changelog), and any naming conventions. --> | | </noinclude><includeonly>== Description == |
| {{Placeholder|e.g., This page lists all firmware releases for the '''LIGO AIR''' fuel level sensor. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard and uses [https://semver.org Semantic Versioning] (MAJOR.MINOR.PATCH). Firmware files are distributed via authorized SOJI partners — contact your sales representative for access.}}
| | <div class="dim"> |
|
| |
|
| == Latest Stable Release ==
| | ''Brief intro to the firmware changelog per Keep a Changelog standard.'' |
| <!-- WHAT TO WRITE: Replace the parameter values below with the latest stable version info.
| | |
| The link "Jump to vX.X.X" auto-generates from the version parameter and links to the row in Version History below. -->
| | '''What to fill in:''' |
| {{FW-Latest-Release
| | * 1–2 paragraph intro explaining the purpose of this page |
| | version = 1.2.0
| | * Specify which product line this firmware changelog covers |
| | date = 2026-05-01
| | * Mention the standards used: |
| | type = Stable
| | ** [https://keepachangelog.com Keep a Changelog] for format |
| }}
| | ** [https://semver.org 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 Summary ==
| | </div> |
| <!-- WHAT TO WRITE: One row per firmware release (most recent first). | |
| Use {{FW-Row-Summary}} template. Required fields: version, date, type.
| |
| COPY-PASTE this block to add new version:
| |
| {{FW-Row-Summary | version=X.X.X | date=YYYY-MM-DD | type=Stable}}
| |
| -->
| |
| {| class="wikitable sortable" style="width:100%"
| |
| |-
| |
| ! Version !! Release Date !! Type !! Release Notes
| |
| {{FW-Row-Summary | version=1.2.0 | date=2026-05-01 | type=Stable}}
| |
| {{FW-Row-Summary | version=1.1.2 | date=2026-03-20 | type=Stable}}
| |
| {{FW-Row-Summary | version=1.1.0 | date=2026-02-15 | type=Stable}}
| |
| {{FW-Row-Summary | version=1.0.0 | date=2025-12-01 | type=Stable}}
| |
| {{FW-Row-Summary | version=0.9.0 | date=2025-10-10 | type=Beta}}
| |
| |}
| |
|
| |
|
| == Version History == | | == Version History == |
| <!-- WHAT TO WRITE: Detailed breakdown per version using {{FW-Row-Detail}} template. | | <div class="dim"> |
| - version: REQUIRED, used for anchor id (must match Version Summary)
| | |
| - date, type: REQUIRED
| | ''Chronological list of all firmware releases (most recent first).'' |
| - added/changed/fixed/security/known_issues: bullet lists (use *)
| | |
| - Leave field empty if no items in that category (will show "—")
| | '''What to fill in:''' sortable table with columns: |
| COPY-PASTE this block to add new version:
| | * '''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:''' |
| | * <code><nowiki>* '''Added'''</nowiki></code> — new features |
| | * <code><nowiki>* '''Changed'''</nowiki></code> — behavior changes / improvements |
| | * <code><nowiki>* '''Fixed'''</nowiki></code> — bug fixes (link to PCN if applicable) |
| | * <code><nowiki>* '''Security'''</nowiki></code> — security patches (include CVE if applicable) |
| | * <code><nowiki>* '''Known Issues'''</nowiki></code> — limitations with workarounds |
| | * <code><nowiki>* '''Deprecated'''</nowiki></code> — features being phased out |
| | * <code><nowiki>* '''Removed'''</nowiki></code> — 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 <code>-alpha.N</code>, <code>-beta.N</code>, <code>-rc.N</code> |
|
| |
|
| {{FW-Row-Detail
| | '''How to add a new version:''' copy a row block (from <code>|-</code> to next <code>|-</code>) and paste at top of table. Update Version, Date, and Description fields. |
| | version = X.X.X
| | |
| | date = YYYY-MM-DD
| | </div> |
| | type = Stable
| |
| | added =
| |
| * New feature description
| |
| | changed =
| |
| * Behavior change description
| |
| | fixed =
| |
| * Bug fix description
| |
| | security =
| |
| * Security fix description (with CVE if applicable)
| |
| | known_issues =
| |
| * Known limitation description
| |
| }}
| |
| -->
| |
| {| class="wikitable sortable" style="width:100%; font-size:0.95em"
| |
| |-
| |
| ! style="width:8%" | Version
| |
| ! style="width:10%" | Date
| |
| ! style="width:8%" | Type
| |
| ! style="background:#4CAF50; color:white" | Added
| |
| ! style="background:#2196F3; color:white" | Changed
| |
| ! style="background:#FFC107; color:black" | Fixed
| |
| ! style="background:#F44336; color:white" | Security
| |
| ! style="background:#9E9E9E; color:white" | Known Issues
| |
| {{FW-Row-Detail
| |
| | version = 1.2.0
| |
| | date = 2026-05-01
| |
| | type = Stable
| |
| | added =
| |
| * '''[e.g., BLE fast-connect pairing — 60% faster pairing time]'''
| |
| * '''[e.g., Support for external 1-Wire temperature probe]'''
| |
| * '''[e.g., Configurable sampling rate: 1 / 5 / 10 Hz]'''
| |
| | changed =
| |
| * '''[e.g., Measurement accuracy improved from ±0.5% to ±0.3% (full-scale)]'''
| |
| * '''[e.g., Sleep-mode power consumption reduced by 15%]'''
| |
| | fixed = | |
| * '''[e.g., Fixed BLE disconnect after 30+ days uptime — see PCN-2025-002]'''
| |
| * '''[e.g., Memory leak in logging subsystem causing reboot every ~14 days]'''
| |
| | security = | |
| * '''[e.g., Updated BLE pairing to LE Secure Connections]'''
| |
| * '''[e.g., Buffer overflow in OTA routine (CVE-2026-XXXX)]'''
| |
| | known_issues =
| |
| * '''[e.g., OTA update fails on iOS 17.4.1 — use Android/USB as workaround]'''
| |
| * '''[e.g., Calibration UI button occasionally unresponsive — fix planned in v1.2.1]'''
| |
| }}
| |
| {{FW-Row-Detail
| |
| | version = 1.1.2
| |
| | date = 2026-03-20
| |
| | type = Stable
| |
| | fixed =
| |
| * '''[e.g., Hot-fix for boot loop on hardware revision Rev B (date code 2602+)]'''
| |
| * '''[e.g., Corrected RTC time drift after low-battery event]'''
| |
| }}
| |
| {{FW-Row-Detail
| |
| | version = 1.1.0
| |
| | date = 2026-02-15
| |
| | type = Stable
| |
| | added =
| |
| * '''[e.g., Support for Hardware Revision B with improved antenna]'''
| |
| | changed =
| |
| * '''[e.g., Default BLE TX power reduced from +4 to 0 dBm for regulatory compliance]'''
| |
| | fixed =
| |
| * '''[e.g., Battery percentage incorrect when below 20%]'''
| |
| }}
| |
| |}
| |
|
| |
|
| == Compatibility == | | == Compatibility == |
| <!-- WHAT TO WRITE: Matrix showing which firmware versions work on which hardware revisions. | | <div class="dim"> |
| Use ✅ Supported, ⚠️ Known issue, ❌ Not supported.
| | |
| Add columns for each hardware revision your product has. -->
| | ''Matrix showing which firmware versions work on which hardware revisions.'' |
| {| class="wikitable"
| | |
| |-
| | '''What to fill in:''' table with columns: |
| ! Firmware Version !! Hardware Rev A !! Hardware Rev B !! Hardware Rev C
| | * '''Firmware Version''' — version number |
| |-
| | * '''Hardware Rev A''', '''Rev B''', '''Rev C''', etc. — one column per hardware revision |
| | 1.2.0 || ✅ Supported || ✅ Supported || ✅ Supported
| | |
| |-
| | '''Status indicators:''' |
| | 1.1.2 || ✅ Supported || ✅ Supported || ❌ Not supported
| | * ✅ Supported — works without issues |
| |-
| | * ⚠️ Known issue — works but has documented bug |
| | 1.1.0 || ✅ Supported || ⚠️ Known boot loop || ❌ Not supported
| | * ❌ Not supported — incompatible |
| |-
| | |
| | 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
| | '''Note:''' Add as many hardware revision columns as your product has. Remove unused columns. |
| |}
| |
|
| |
|
| {{Placeholder|e.g., If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported.}}
| | '''Closing note suggestion:''' "If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported." |
|
| |
|
| | </div> |
| | <div class="noprint"> |
| == Related Documents == | | == Related Documents == |
| <!-- WHAT TO WRITE: Cross-links to related wiki pages and external documents (PDFs uploaded via Special:Upload). -->
| | ''Cross-references to other documents.'' |
| * [[{{SUBPAGENAME}} User Guide|User Guide]] {{Placeholder|e.g., installation and operation manual}}
| | {{RelatedDocuments}} |
| * [[{{SUBPAGENAME}} Datasheet|Datasheet]] {{Placeholder|e.g., technical specifications}}
| | </div> |
| * [[Product Change Notification|PCN List]] {{Placeholder|e.g., notifications of hardware/firmware changes}}
| |
|
| |
|
| == Document Revision History == | | == Revision History == |
| <!-- WHAT TO WRITE: Track changes to THIS PAGE (the changelog itself), not to firmware. | | <div class="revision-history-auto"> |
| Add a new row at the top each time you edit this page.
| | <span class="dim">Loading revision history...</span> |
| Doc Version uses MAJOR.MINOR (e.g., 1.4) — increment MAJOR for structural changes, MINOR for content updates. -->
| | </div> |
| {| class="wikitable"
| |
| |-
| |
| ! Doc Version !! Date !! Author !! Changes
| |
| |-
| |
| | 1.4 || {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} || {{Placeholder|e.g., Cuongnv}} || {{Placeholder|e.g., Added v1.2.0 release entry}}
| |
| |-
| |
| | 1.3 || 2026-03-20 || [Author] || Added v1.1.2 hotfix
| |
| |-
| |
| | 1.2 || 2026-02-15 || [Author] || Added v1.1.0 release
| |
| |-
| |
| | 1.1 || 2025-12-01 || [Author] || Initial release with v1.0.0
| |
| |}
| |
|
| |
|
| [[Category:{{PAGENAME}}]] | | [[Category:{{subst:#replace:{{subst:PAGENAME}}| Firmware Changelog|}}]] |
| [[Category:Firmware Changelog]]
| |
| </includeonly> | | </includeonly> |
