Jump to content

Template:Boilerplate-Firmware-Changelog: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older editNewer edit →
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>
<noinclude>
{{TemplateData
{{TemplateData
|description=Boilerplate for product Firmware Changelog page. Follows Keep a Changelog standard + Semantic Versioning.
|description=Boilerplate for product Firmware Changelog page. Lean structure — no Status, Download, Migration Notes, Update Procedure, Support Lifecycle.
}}
}}
</noinclude><includeonly>
</noinclude><includeonly>
== Description ==
== Description ==
This page lists all firmware releases for the [Product Name] product line. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard and uses [https://semver.org Semantic Versioning] (MAJOR.MINOR.PATCH).
This page lists all firmware releases for the [Product Name]. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard.
 
For firmware update procedure, see [[{{SUBPAGENAME}} User Guide#Firmware Update|User Guide → Firmware Update]].


== Latest Stable Release ==
== Latest Stable Release ==
{{FW-Latest-Release
{{FW-Latest-Release
| version       = 1.2.0
| version = 1.2.0
| date         = 2026-05-01
| date   = 2026-05-01
| type         = Stable
| type   = Stable
| status        = Recommended
| download_file = Product-Firmware-v1.2.0.zip
}}
}}


Line 21: Line 18:
{| class="wikitable sortable" style="width:100%"
{| class="wikitable sortable" style="width:100%"
|-
|-
! Version !! Release Date !! Type !! Status !! Download !! Release Notes
! Version !! Release Date !! Type !! Release Notes
{{FW-Row-Summary | version=1.2.0 | date=2026-05-01 | type=Stable | status=Recommended | download_file=Product-Firmware-v1.2.0.zip}}
{{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 | status=Supported  | download_file=Product-Firmware-v1.1.2.zip}}
{{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 | status=Supported  | download_file=Product-Firmware-v1.1.0.zip}}
{{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 | status=Deprecated  | download_file=Product-Firmware-v1.0.0.zip}}
{{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   | status=EOL}}
{{FW-Row-Summary | version=0.9.0 | date=2025-10-10 | type=Beta}}
|}
|}
== Versioning Scheme ==
Firmware versions follow Semantic Versioning '''MAJOR.MINOR.PATCH''':
* '''MAJOR''' — Incompatible API/protocol changes, requires re-qualification
* '''MINOR''' — New features, backward-compatible
* '''PATCH''' — Bug fixes only, fully backward-compatible
Pre-release versions use suffix: ''-alpha.N'', ''-beta.N'', ''-rc.N''.


== Version History ==
== Version History ==
{| class="wikitable sortable" style="width:100%; font-size:0.95em"
{| class="wikitable sortable" style="width:100%; font-size:0.95em"
|-
|-
! Version !! Date !! Type !! Status !! Added !! Changed !! Fixed !! Security !! Known Issues !! Download
! 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
{{FW-Row-Detail
| version = 1.2.0
| version = 1.2.0
| date    = 2026-05-01
| date    = 2026-05-01
| type    = Stable
| type    = Stable
| status  = Recommended
| added  =  
| added  =  
* BLE fast-connect pairing
* BLE fast-connect pairing (-60% time)
* External 1-Wire temperature probe
* External 1-Wire temperature probe
* Configurable sampling rate (1/5/10 Hz)
* Configurable sampling rate (1/5/10 Hz)
| changed =  
| changed =  
* Accuracy ±0.5% → ±0.3%
* Accuracy ±0.5% → ±0.3% (full-scale)
* Sleep power −15%
* Sleep power consumption −15%
| fixed  =  
| fixed  =  
* BLE disconnect after 30+ days
* BLE disconnect after 30+ days uptime
* Memory leak in logging
* Memory leak in logging causing reboot
* Temperature compensation at −20 to −30 °C
| security =  
| security =  
* LE Secure Connections
* LE Secure Connections (replaces legacy pairing)
* Buffer overflow fix
* Buffer overflow in OTA routine (CVE-2026-XXXX)
| known_issues =  
| known_issues =  
* OTA fails on iOS 17.4.1
* OTA fails on iOS 17.4.1 — use Android/USB
* Calibration UI button
* Calibration UI button unresponsive
| download_file = Product-Firmware-v1.2.0.zip
}}
}}
{{FW-Row-Detail
{{FW-Row-Detail
Line 69: Line 63:
| date    = 2026-03-20
| date    = 2026-03-20
| type    = Stable
| type    = Stable
| status  = Supported
| fixed  =  
| fixed  =  
* Boot loop on HW Rev B
* Boot loop on HW Rev B (date code 2602+)
* Time drift after RTC battery low
* Time drift after RTC battery low
| download_file = Product-Firmware-v1.1.2.zip
}}
}}
|}
{{FW-Row-Detail
 
| version = 1.1.0
=== Migration Notes ===
| date    = 2026-02-15
Chú ý đặc biệt khi upgrade giữa các version:
| type    = Stable
 
| added  =
{| class="wikitable"
* Support for HW Rev B (improved antenna)
|-
* Diagnostic mode (long-press 5s)
! From → To !! Settings Preserved? !! Calibration Reset? !! Downgrade Path !! Notes
| changed =
|-
* Default BLE TX power +4 → 0 dBm
| 1.1.x → 1.2.0 || ✅ Yes || ❌ No || Supported back to 1.1.0
| fixed  =
|
* Battery % reporting below 20%
* Recommended upgrade
* Sporadic disconnect in high-interference env
* OTA + USB both supported
| known_issues =
|-
* Boot loop on certain Rev B → fixed in 1.1.2
| 1.1.0 → 1.1.2 || ✅ Yes || ❌ No || ✅ Supported
}}
|
{{FW-Row-Detail
* '''Mandatory''' for HW Rev B units
| version = 1.0.0
|-
| date    = 2025-12-01
| 1.0.0 → 1.1.0 || ✅ Yes || ❌ No || ✅ Supported
| type    = Stable
|
| added  =
* HW Rev B requires firmware ≥ 1.1.2 instead
* Initial production release
|-
* BLE 5.0 connectivity
| 0.9.x → 1.0.0 || ❌ Factory reset required || ✅ Yes (re-calibrate) || ❌ Not supported
* USB configuration interface
|
* Battery level reporting
* Engineering samples only
* Measurement modes (continuous / on-demand / scheduled)
|}
| known_issues =  
 
* Battery % inaccurate < 20% → fixed in 1.1.0
=== Removed & Deprecated ===
}}
Tính năng đã bỏ hoặc sắp bỏ — khách hàng nên migrate khỏi:
{{FW-Row-Detail
 
| version = 0.9.0
{| class="wikitable"
| date    = 2025-10-10
|-
| type    = Beta
! Feature !! Status !! Since !! Removed In !! Alternative
| added  = ''Pre-production beta — engineering samples only''
|-
}}
| Legacy BLE pairing (without LE SC) || {{FW-Status|Deprecated}} || 1.2.0 || 2.0.0 (planned) || Use LE Secure Connections
|-
| Old AT command set v1 || {{FW-Status|Deprecated}} || 1.1.0 || 1.3.0 (planned) || Migrate to AT v2 (see [[Configuration#AT Commands]])
|-
| HTTP cloud reporting || ❌ Removed || — || 1.2.0 || Use MQTT (see [[Configuration#MQTT]])
|}
|}


Line 128: Line 115:
|-
|-
| 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
| 1.0.0 || ✅ Supported || ❌ Not supported || ❌ Not supported
|}
== Support Lifecycle ==
{| class="wikitable"
|-
! Status !! Definition !! Bug Fixes? !! Security Fixes? !! Notes
|-
| {{FW-Status|Recommended}}  || Latest stable, recommended for all new and existing deployments || ✅ || ✅ || Default for new shipments
|-
| {{FW-Status|Supported}}    || Stable, receiving critical security fixes only || ❌ || ✅ || Upgrade to Recommended advised
|-
| {{FW-Status|Deprecated}}  || Older version, no longer receives fixes || ❌ || ❌ || Upgrade required for production
|-
| {{FW-Status|EOL}}          || End-of-life, no support || ❌ || ❌ || Beta / engineering samples only
|}
|}


Line 148: Line 121:
* [[{{SUBPAGENAME}} Datasheet|Datasheet]]
* [[{{SUBPAGENAME}} Datasheet|Datasheet]]
* [[Product Change Notification|PCN List]]
* [[Product Change Notification|PCN List]]
* [[Media:Product-FW-Update-Guide.pdf|Firmware Update Guide (PDF)]]
* [[Media:Product-Configuration-Tool.zip|Configuration Tool (Windows)]]


== Document Revision History ==
== Document Revision History ==
Line 165: Line 136:
|}
|}


[[Category:{{PAGENAME}}]]
[[Category:Firmware Changelog]]
[[Category:Firmware Changelog]]
</includeonly>
</includeonly>

Revision as of 07:38, 15 May 2026

Template:TemplateData

SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-Firmware-Changelog&oldid=626"