Template:Boilerplate-Firmware-Changelog: Difference between revisions

[checked revision]

← Older edit Newer edit →

VisualWikitext

Revision as of 08:05, 15 May 2026

Template:TemplateData

SOJI Electronics

@@ Line 18: / Line 18: @@
 == Version History ==
-<!-- WHAT TO WRITE: Detailed breakdown per version using {{FW-Row-Detail}} template.
+<!-- WHAT TO WRITE: One {{FW-Row-Detail}} per firmware release.
-      - version: REQUIRED, used for anchor id (must match Version Summary)
+      Required: version, date, type
-     - date, type: REQUIRED
+      Description: free-form content, recommend organizing by Added/Changed/Fixed/Security/Known Issues -->
-      - added/changed/fixed/security/known_issues: bullet lists (use *)
+{| class="wikitable sortable fw-version-history" style="width:100%; font-size:0.95em"
-     - 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"
 |-
 ! style="width:8%"  | Version
 ! style="width:10%" | Date
 ! style="width:8%"  | Type
-! style="background:#4CAF50; color:white" | Added
+! Description
-! 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   =
+| description =
-* '''[e.g., BLE fast-connect pairing — 60% faster pairing time]'''
+* '''Added'''
-* '''[e.g., Support for external 1-Wire temperature probe]'''
+** {{Placeholder|e.g., BLE fast-connect pairing — 60% faster pairing time}}
-* '''[e.g., Configurable sampling rate: 1 / 5 / 10 Hz]'''
+** {{Placeholder|e.g., Support for external 1-Wire temperature probe}}
-| changed =
+** {{Placeholder|e.g., Configurable sampling rate: 1 / 5 / 10 Hz}}
-* '''[e.g., Measurement accuracy improved from ±0.5% to ±0.3% (full-scale)]'''
+* '''Changed'''
-* '''[e.g., Sleep-mode power consumption reduced by 15%]'''
+** {{Placeholder|e.g., Measurement accuracy improved from ±0.5% to ±0.3% (full-scale)}}
-| fixed   =
+** {{Placeholder|e.g., Sleep-mode power consumption reduced by 15%}}
-* '''[e.g., Fixed BLE disconnect after 30+ days uptime — see PCN-2025-002]'''
+* '''Fixed'''
-* '''[e.g., Memory leak in logging subsystem causing reboot every ~14 days]'''
+** {{Placeholder|e.g., Fixed BLE disconnect after 30+ days uptime — see PCN-2025-002}}
-| security =
+** {{Placeholder|e.g., Memory leak in logging subsystem causing reboot every ~14 days}}
-* '''[e.g., Updated BLE pairing to LE Secure Connections]'''
+* '''Security'''
-* '''[e.g., Buffer overflow in OTA routine (CVE-2026-XXXX)]'''
+** {{Placeholder|e.g., Updated BLE pairing to LE Secure Connections}}
-| known_issues =
+** {{Placeholder|e.g., Buffer overflow in OTA routine (CVE-2026-XXXX)}}
-* '''[e.g., OTA update fails on iOS 17.4.1 — use Android/USB as workaround]'''
+* '''Known Issues'''
-* '''[e.g., Calibration UI button occasionally unresponsive — fix planned in v1.2.1]'''
+** {{Placeholder|e.g., OTA update fails on iOS 17.4.1 — use Android/USB as workaround}}
+** {{Placeholder|e.g., Calibration UI button occasionally unresponsive}}
 }}
 {{FW-Row-Detail
@@ Line 76: / Line 53: @@
 | date    = 2026-03-20
 | type    = Stable
-| fixed   =
+| description =
-* '''[e.g., Hot-fix for boot loop on hardware revision Rev B (date code 2602+)]'''
+* '''Fixed'''
-* '''[e.g., Corrected RTC time drift after low-battery event]'''
+** {{Placeholder|e.g., Hot-fix for boot loop on hardware revision Rev B}}
+** {{Placeholder|e.g., Corrected RTC time drift after low-battery event}}
 }}
 {{FW-Row-Detail
@@ Line 84: / Line 62: @@
 | date    = 2026-02-15
 | type    = Stable
-| added   =
+| description =
-* '''[e.g., Support for Hardware Revision B with improved antenna]'''
+* '''Added'''
-| changed =
+** {{Placeholder|e.g., Support for Hardware Revision B with improved antenna}}
-* '''[e.g., Default BLE TX power reduced from +4 to 0 dBm for regulatory compliance]'''
+* '''Changed'''
-| fixed   =
+** {{Placeholder|e.g., Default BLE TX power reduced from +4 to 0 dBm}}
-* '''[e.g., Battery percentage incorrect when below 20%]'''
+* '''Fixed'''
+** {{Placeholder|e.g., Battery percentage incorrect when below 20%}}
+}}
+{{FW-Row-Detail
+| version = 1.0.0
+| date    = 2025-12-01
+| type    = Stable
+| description =
+* '''Added'''
+** {{Placeholder|e.g., Initial production release}}
+** {{Placeholder|e.g., BLE 5.0 connectivity}}
+** {{Placeholder|e.g., USB configuration interface}}
+}}
+{{FW-Row-Detail
+| version = 0.9.0
+| date    = 2025-10-10
+| type    = Beta
+| description = {{Placeholder|e.g., Pre-production beta — engineering samples only}}
 }}
 |}
@@ Line 101: / Line 96: @@
 ! Firmware Version !! Hardware Rev A !! Hardware Rev B !! Hardware Rev C
 |-
-| 1.2.0 || ✅ Supported || ✅ Supported || ✅ Supported
+| 1.2.0 || {{Placeholder|✅ Supported}} || {{Placeholder|✅ Supported}} || {Placeholder|✅ Supported}}
-|-
-| 1.1.2 || ✅ Supported || ✅ Supported || ❌ Not supported
 |-
-| 1.1.0 || ✅ Supported || ⚠️ Known boot loop || ❌ Not supported
+| 1.1.2 || {{Placeholder|✅ Supported}} || {{Placeholder|✅ Supported}} || {Placeholder|❌ Not supported}}
 |-
-| 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
 |}