|
|
| (21 intermediate revisions by the same user not shown) |
| 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. |
| }} | | }} |
| </noinclude><includeonly>
| |
| == 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).
| |
|
| |
|
| For firmware update procedure, see [[{{SUBPAGENAME}} User Guide#Firmware Update|User Guide → Firmware Update]].
| | 4 mandatory sections (== H2 ==): |
| | # 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
| |
| | status = Recommended
| |
| | download_file = Product-Firmware-v1.2.0.zip
| |
| }}
| |
|
| |
|
| == Version Summary ==
| | ''Brief intro to the firmware changelog per Keep a Changelog standard.'' |
| {| class="wikitable sortable" style="width:100%"
| |
| |-
| |
| ! Version !! Release Date !! Type !! Status !! Download !! 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.1.2 | date=2026-03-20 | type=Stable | status=Supported | download_file=Product-Firmware-v1.1.2.zip}}
| |
| {{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.0.0 | date=2025-12-01 | type=Stable | status=Deprecated | download_file=Product-Firmware-v1.0.0.zip}}
| |
| {{FW-Row-Summary | version=0.9.0 | date=2025-10-10 | type=Beta | status=EOL}}
| |
| |}
| |
|
| |
|
| == Versioning Scheme ==
| | '''What to fill in:''' |
| Firmware versions follow Semantic Versioning '''MAJOR.MINOR.PATCH''':
| | * 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.) |
|
| |
|
| * '''MAJOR''' — Incompatible API/protocol changes, requires re-qualification
| | '''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." |
| * '''MINOR''' — New features, backward-compatible
| |
| * '''PATCH''' — Bug fixes only, fully backward-compatible
| |
|
| |
|
| Pre-release versions use suffix: ''-alpha.N'', ''-beta.N'', ''-rc.N''.
| | </div> |
|
| |
|
| == Version History == | | == Version History == |
| {| class="wikitable sortable" style="width:100%; font-size:0.95em"
| | <div class="dim"> |
| |-
| | |
| ! Version !! Date !! Type !! Status !! Added !! Changed !! Fixed !! Security !! Known Issues !! Download
| | ''Chronological list of all firmware releases (most recent first).'' |
| {{FW-Row-Detail
| | |
| | version = 1.2.0
| | '''What to fill in:''' sortable table with columns: |
| | date = 2026-05-01
| | * '''Version''' — version number per SemVer (e.g., '''1.2.0''', '''1.1.2''') |
| | type = Stable
| | * '''Date''' — release date (YYYY-MM-DD) |
| | status = Recommended
| | * '''Description''' — bullet list grouped by change category |
| | added =
| |
| * BLE fast-connect pairing
| |
| * External 1-Wire temperature probe
| |
| * Configurable sampling rate (1/5/10 Hz)
| |
| | changed =
| |
| * Accuracy ±0.5% → ±0.3%
| |
| * Sleep power −15%
| |
| | fixed =
| |
| * BLE disconnect after 30+ days
| |
| * Memory leak in logging
| |
| | security =
| |
| * LE Secure Connections | |
| * Buffer overflow fix
| |
| | known_issues =
| |
| * OTA fails on iOS 17.4.1
| |
| * Calibration UI button
| |
| | download_file = Product-Firmware-v1.2.0.zip
| |
| }}
| |
| {{FW-Row-Detail
| |
| | version = 1.1.2
| |
| | date = 2026-03-20
| |
| | type = Stable
| |
| | status = Supported
| |
| | fixed =
| |
| * Boot loop on HW Rev B | |
| * Time drift after RTC battery low
| |
| | download_file = Product-Firmware-v1.1.2.zip
| |
| }}
| |
| |}
| |
|
| |
|
| === Migration Notes ===
| | '''Description format — use these standard categories:''' |
| Chú ý đặc biệt khi upgrade giữa các version:
| | * <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 |
|
| |
|
| {| class="wikitable"
| | '''Versioning rules:''' |
| |-
| | * MAJOR — incompatible API/protocol changes (requires re-qualification) |
| ! From → To !! Settings Preserved? !! Calibration Reset? !! Downgrade Path !! Notes
| | * MINOR — new features, backward-compatible |
| |-
| | * PATCH — bug fixes only |
| | 1.1.x → 1.2.0 || ✅ Yes || ❌ No || Supported back to 1.1.0
| | * Pre-release — append <code>-alpha.N</code>, <code>-beta.N</code>, <code>-rc.N</code> |
| |
| |
| * Recommended upgrade
| |
| * OTA + USB both supported
| |
| |-
| |
| | 1.1.0 → 1.1.2 || ✅ Yes || ❌ No || ✅ Supported
| |
| |
| |
| * '''Mandatory''' for HW Rev B units
| |
| |-
| |
| | 1.0.0 → 1.1.0 || ✅ Yes || ❌ No || ✅ Supported
| |
| |
| |
| * HW Rev B requires firmware ≥ 1.1.2 instead | |
| |-
| |
| | 0.9.x → 1.0.0 || ❌ Factory reset required || ✅ Yes (re-calibrate) || ❌ Not supported
| |
| |
| |
| * Engineering samples only | |
| |}
| |
|
| |
|
| === Removed & Deprecated ===
| | '''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. |
| Tính năng đã bỏ hoặc sắp bỏ — khách hàng nên migrate khỏi:
| |
|
| |
|
| {| class="wikitable"
| | </div> |
| |-
| |
| ! Feature !! Status !! Since !! Removed In !! Alternative
| |
| |-
| |
| | 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]])
| |
| |}
| |
|
| |
|
| == 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. |
|
| |
|
| == Support Lifecycle ==
| | '''Closing note suggestion:''' "If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported." |
| {| 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
| |
| |}
| |
|
| |
|
| | </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> |
| * [[Media:Product-FW-Update-Guide.pdf|Firmware Update Guide (PDF)]]
| |
| * [[Media:Product-Configuration-Tool.zip|Configuration Tool (Windows)]]
| |
|
| |
|
| == 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:Firmware Changelog]] | | [[Category:{{subst:#replace:{{subst:PAGENAME}}| Firmware Changelog|}}]] |
| </includeonly> | | </includeonly> |
