Jump to content

Template:Boilerplate-Firmware-Changelog: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{TemplateData
{{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.
}}
}}
</noinclude><includeonly>


== Description ==
4 mandatory sections (== H2 ==):
This page lists all firmware releases for the [Product Name]. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard.
# Description
# Version History
# Compatibility
# Related Pages


== Latest Stable Release ==
[[Category:Boilerplates]]
{{FW-Latest-Release
</noinclude><includeonly>== Description ==
| version = 1.2.0
<div class="dim">
| date    = 2026-05-01
 
| type   = Stable
''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:
** [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>
{| 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 ==
{| class="wikitable sortable" style="width:100%; font-size:0.95em"
<div class="dim">
|-
 
! style="width:8%"  | Version
''Chronological list of all firmware releases (most recent first).''
! style="width:10%" | Date
 
! style="width:8%"  | Type
'''What to fill in:''' sortable table with columns:
! style="background:#4CAF50; color:white" | Added
* '''Version''' — version number per SemVer (e.g., '''1.2.0''', '''1.1.2''')
! style="background:#2196F3; color:white" | Changed
* '''Date''' — release date (YYYY-MM-DD)
! style="background:#FFC107; color:black" | Fixed
* '''Description''' — bullet list grouped by change category
! style="background:#F44336; color:white" | Security
 
! style="background:#9E9E9E; color:white" | Known Issues
'''Description format — use these standard categories:'''
{{FW-Row-Detail
* <code><nowiki>* '''Added'''</nowiki></code> — new features
| version = 1.2.0
* <code><nowiki>* '''Changed'''</nowiki></code> — behavior changes / improvements
| date   = 2026-05-01
* <code><nowiki>* '''Fixed'''</nowiki></code> — bug fixes (link to PCN if applicable)
| type    = Stable
* <code><nowiki>* '''Security'''</nowiki></code> — security patches (include CVE if applicable)
| added  =
* <code><nowiki>* '''Known Issues'''</nowiki></code> — limitations with workarounds
* BLE fast-connect pairing (-60% time)
* <code><nowiki>* '''Deprecated'''</nowiki></code> — features being phased out
* External 1-Wire temperature probe
* <code><nowiki>* '''Removed'''</nowiki></code> — features removed in this version
* Configurable sampling rate (1/5/10 Hz)
 
| changed =
'''Versioning rules:'''
* Accuracy ±0.5% → ±0.3% (full-scale)
* MAJOR — incompatible API/protocol changes (requires re-qualification)
* Sleep power consumption −15%
* MINOR — new features, backward-compatible
| fixed  =
* PATCH — bug fixes only
* BLE disconnect after 30+ days uptime
* Pre-release — append <code>-alpha.N</code>, <code>-beta.N</code>, <code>-rc.N</code>
* Memory leak in logging causing reboot
 
* Temperature compensation at −20 to −30 °C
'''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.
| security =
 
* LE Secure Connections (replaces legacy pairing)
</div>
* Buffer overflow in OTA routine (CVE-2026-XXXX)
| known_issues =
* OTA fails on iOS 17.4.1 — use Android/USB
* Calibration UI button unresponsive
}}
{{FW-Row-Detail
| version = 1.1.2
| date    = 2026-03-20
| type    = Stable
| fixed  =
* Boot loop on HW Rev B (date code 2602+)
* Time drift after RTC battery low
}}
{{FW-Row-Detail
| version = 1.1.0
| date    = 2026-02-15
| type    = Stable
| added  =
* Support for HW Rev B (improved antenna)
* Diagnostic mode (long-press 5s)
| changed =
* Default BLE TX power +4 → 0 dBm
| fixed  =
* Battery % reporting 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 ==
== Compatibility ==
{| class="wikitable"
<div class="dim">
|-
 
! Firmware Version !! Hardware Rev A !! Hardware Rev B !! Hardware Rev C
''Matrix showing which firmware versions work on which hardware revisions.''
|-
 
| 1.2.0 || ✅ Supported || ✅ Supported || ✅ Supported
'''What to fill in:''' table with columns:
|-
* '''Firmware Version''' — version number
| 1.1.2 || ✅ Supported || ✅ Supported || ❌ Not supported
* '''Hardware Rev A''', '''Rev B''', '''Rev C''', etc. — one column per hardware revision
|-
 
| 1.1.0 || ✅ Supported || ⚠️ Boot loop bug || ❌ Not supported
'''Status indicators:'''
|-
* ✅ Supported — works without issues
| 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
* ⚠️ 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."


</div>
<div class="noprint">
== Related Documents ==
== Related Documents ==
* [[{{SUBPAGENAME}} User Guide|User Guide]]
''Cross-references to other documents.''
* [[{{SUBPAGENAME}} Datasheet|Datasheet]]
{{RelatedDocuments}}
* [[Product Change Notification|PCN List]]
</div>


== Document Revision History ==
== Revision History ==
{| class="wikitable"
<div class="revision-history-auto">
|-
<span class="dim">Loading revision history...</span>
! Doc Version !! Date !! Author !! Changes
</div>
|-
| 1.4 || 2026-05-01 || [Author] || Added v1.2.0 release
|-
| 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>

Latest revision as of 09:02, 25 May 2026

Template:TemplateData

4 mandatory sections (== H2 ==):

  1. Description
  2. Version History
  3. Compatibility
  4. Related Pages
SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-Firmware-Changelog&oldid=1231"