Template:Boilerplate-Firmware-Changelog: Difference between revisions

[checked revision]

← Older edit Newer edit →

VisualWikitext

Revision as of 07:42, 15 May 2026

Template:TemplateData

SOJI Electronics

@@ Line 1: / Line 1: @@
 <noinclude>
 {{TemplateData
-|description=Boilerplate for product Firmware Changelog page. Lean structure — no Status, Download, Migration Notes, Update Procedure, Support Lifecycle.
+|description=Boilerplate for product Firmware Changelog page. Includes inline placeholders and edit hints for each section.
 }}
 </noinclude><includeonly>
+<!-- ════════════════════════════════════════════════════════════════
+     INSTRUCTIONS FOR EDITOR:
+     - Replace all {{Placeholder|...}} calls with your actual content
+     - Update {{FW-Latest-Release}} with the current latest version
+     - Add a new {{FW-Row-Summary}} and {{FW-Row-Detail}} for each new release
+     - Update Compatibility table when HW revision changes
+     - Add an entry to Document Revision History after each edit
+     ════════════════════════════════════════════════════════════════ -->
 == Description ==
-This page lists all firmware releases for the [Product Name]. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard.
+<!-- 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. -->
+{{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.}}
 == Latest Stable Release ==
+<!-- 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. -->
 {{FW-Latest-Release
 | version = 1.2.0
@@ Line 16: / Line 28: @@
 == Version Summary ==
+<!-- 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%"
 |-
@@ Line 27: / Line 44: @@
 == Version History ==
+<!-- WHAT TO WRITE: Detailed breakdown per version using {{FW-Row-Detail}} template.
+     - version: REQUIRED, used for anchor id (must match Version Summary)
+     - date, type: REQUIRED
+     - added/changed/fixed/security/known_issues: bullet lists (use *)
+     - Leave field empty if no items in that category (will show "—")
+     COPY-PASTE this block to add new version:
+     {{FW-Row-Detail
+     | version = X.X.X
+     | date    = YYYY-MM-DD
+     | 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"
 |-
@@ Line 42: / Line 82: @@
 | type    = Stable
 | added   =
-* BLE fast-connect pairing (-60% time)
+* '''[e.g., BLE fast-connect pairing — 60% faster pairing time]'''
-* External 1-Wire temperature probe
+* '''[e.g., Support for external 1-Wire temperature probe]'''
-* Configurable sampling rate (1/5/10 Hz)
+* '''[e.g., Configurable sampling rate: 1 / 5 / 10 Hz]'''
 | changed =
-* Accuracy ±0.5% → ±0.3% (full-scale)
+* '''[e.g., Measurement accuracy improved from ±0.5% to ±0.3% (full-scale)]'''
-* Sleep power consumption −15%
+* '''[e.g., Sleep-mode power consumption reduced by 15%]'''
 | fixed   =
-* BLE disconnect after 30+ days uptime
+* '''[e.g., Fixed BLE disconnect after 30+ days uptime — see PCN-2025-002]'''
-* Memory leak in logging causing reboot
+* '''[e.g., Memory leak in logging subsystem causing reboot every ~14 days]'''
-* Temperature compensation at −20 to −30 °C
 | security =
-* LE Secure Connections (replaces legacy pairing)
+* '''[e.g., Updated BLE pairing to LE Secure Connections]'''
-* Buffer overflow in OTA routine (CVE-2026-XXXX)
+* '''[e.g., Buffer overflow in OTA routine (CVE-2026-XXXX)]'''
 | known_issues =
-* OTA fails on iOS 17.4.1 — use Android/USB
+* '''[e.g., OTA update fails on iOS 17.4.1 — use Android/USB as workaround]'''
-* Calibration UI button unresponsive
+* '''[e.g., Calibration UI button occasionally unresponsive — fix planned in v1.2.1]'''
 }}
 {{FW-Row-Detail
@@ Line 64: / Line 103: @@
 | type    = Stable
 | fixed   =
-* Boot loop on HW Rev B (date code 2602+)
+* '''[e.g., Hot-fix for boot loop on hardware revision Rev B (date code 2602+)]'''
-* Time drift after RTC battery low
+* '''[e.g., Corrected RTC time drift after low-battery event]'''
 }}
 {{FW-Row-Detail
@@ Line 72: / Line 111: @@
 | type    = Stable
 | added   =
-* Support for HW Rev B (improved antenna)
+* '''[e.g., Support for Hardware Revision B with improved antenna]'''
-* Diagnostic mode (long-press 5s)
 | changed =
-* Default BLE TX power +4 → 0 dBm
+* '''[e.g., Default BLE TX power reduced from +4 to 0 dBm for regulatory compliance]'''
 | fixed   =
-* Battery % reporting below 20%
+* '''[e.g., Battery percentage incorrect when below 20%]'''
-* Sporadic disconnect in high-interference env
-| known_issues =
-* Boot loop on certain Rev B → fixed in 1.1.2
-}}
-{{FW-Row-Detail
-| version = 1.0.0
-| date    = 2025-12-01
-| type    = Stable
-| added   =
-* Initial production release
-* BLE 5.0 connectivity
-* USB configuration interface
-* Battery level reporting
-* Measurement modes (continuous / on-demand / scheduled)
-| known_issues =
-* Battery % inaccurate < 20% → fixed in 1.1.0
-}}
-{{FW-Row-Detail
-| version = 0.9.0
-| date    = 2025-10-10
-| type    = Beta
-| added   = ''Pre-production beta — engineering samples only''
 }}
 |}
 == Compatibility ==
+<!-- WHAT TO WRITE: Matrix showing which firmware versions work on which hardware revisions.
+     Use ✅ Supported, ⚠️ Known issue, ❌ Not supported.
+     Add columns for each hardware revision your product has. -->
 {| class="wikitable"
 |-
@@ Line 112: / Line 131: @@
 | 1.1.2 || ✅ Supported || ✅ Supported || ❌ Not supported
 |-
-| 1.1.0 || ✅ Supported || ⚠️ Boot loop bug || ❌ Not supported
+| 1.1.0 || ✅ Supported || ⚠️ Known boot loop || ❌ Not supported
 |-
 | 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
 |}
+{{Placeholder|e.g., If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported.}}
 == Related Documents ==
-* [[{{SUBPAGENAME}} User Guide|User Guide]]
+<!-- WHAT TO WRITE: Cross-links to related wiki pages and external documents (PDFs uploaded via Special:Upload). -->
-* [[{{SUBPAGENAME}} Datasheet|Datasheet]]
+* [[{{SUBPAGENAME}} User Guide|User Guide]] {{Placeholder|e.g., installation and operation manual}}
-* [[Product Change Notification|PCN List]]
+* [[{{SUBPAGENAME}} Datasheet|Datasheet]] {{Placeholder|e.g., technical specifications}}
+* [[Product Change Notification|PCN List]] {{Placeholder|e.g., notifications of hardware/firmware changes}}
 == Document Revision History ==
+<!-- WHAT TO WRITE: Track changes to THIS PAGE (the changelog itself), not to firmware.
+     Add a new row at the top each time you edit this page.
+     Doc Version uses MAJOR.MINOR (e.g., 1.4) — increment MAJOR for structural changes, MINOR for content updates. -->
 {| class="wikitable"
 |-
 ! Doc Version !! Date !! Author !! Changes
 |-
-| 1.4 || 2026-05-01 || [Author] || Added v1.2.0 release
+| 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