docs(system): firmware_version is the version on offer
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 6m21s
driver / test (3.13) (pull_request) Successful in 6m13s
driver / lowest (pull_request) Successful in 5m44s
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Successful in 1m13s
CI / driver (pull_request) Successful in 8m6s
driver / publish (pull_request) Skipped

get_system_config()'s firmware_version reads NewX_AVM-DE_Version, the
firmware the box offers as an update, empty when it offers none, not the
version running (get_facts()["os_version"]). The name stays; the README
and the docstring now say what it holds, and that a box answering only
UserInterface1.GetInfo reports firmware_update_available without it.
No behaviour change.

Closes #3
This commit is contained in:
Christian Manivong committed 2026-11-01 22:10:00 +01:00
1 parent 245c2f030c
commit 94fa378796
3 files changed
+19 -4

No files matched your search

+3
View File
@@ -20,6 +20,9 @@ All notable changes to this driver. The format follows
250 Mbit/s line was shown as 250000 (#2).
- `get_system_config()` reports the box's time zone (`NewLocalTimeZoneName`) as
`timezone`; it held the box's current local time (#3).
- `get_system_config()`'s `firmware_version` is documented for what it is: the
version the box offers as an update, empty when it offers none, not the running
version (that is `get_facts()["os_version"]`). Unchanged in behaviour (#3).
## [0.3.0] - 2026-10-23
+12
View File
@@ -66,6 +66,18 @@ d.close()
FritzBox serves TR-064 over HTTPS with a self-signed certificate; `fritzconnection`
does not verify it, so no separate `verify` option is needed.
## `get_system_config()`
A snapshot of the box's settings, every field best-effort (a TR-064 service the
box does not offer leaves its fields out). Two of them are easy to misread:
- `firmware_version` is the version the box **offers** as an update, empty when
it offers none — not the version running, which is `get_facts()["os_version"]`.
`firmware_update_available` says whether there is one. A box that only answers
`UserInterface1.GetInfo` (not `X_AVM-DE_GetInfo`) reports
`firmware_update_available` without `firmware_version`.
- `timezone` is the box's time zone name (`NewLocalTimeZoneName`).
## Limitations
- Read-only: configuration management methods (`load_merge_candidate`,
+4 -4
View File
@@ -334,11 +334,11 @@ class FritzBoxDriver(ResidentialGatewayDriver):
return result
def get_system_config(self) -> dict[str, Any]:
"""Return a system configuration snapshot for storage as ``system_snapshot``.
"""Return a best-effort snapshot of DSL statistics, firmware updates, DNS and NTP.
Collects DSL line statistics, firmware update status, upstream DNS
servers and NTP settings. All fields are best-effort: missing
TR-064 services are silently skipped.
``firmware_version`` is the version on *offer* (empty when none), not the one
running (``get_facts()["os_version"]``); a box answering only
``UserInterface1.GetInfo`` leaves it out. A missing TR-064 service is skipped.
"""
available = self.fc.services if self.fc else {}
result: dict[str, Any] = {}