Skip to content

Add ezspVersion to network backup metadata #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
puddly merged 3 commits into from
Oct 24, 2025
Merged

Add ezspVersion to network backup metadata #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
654b07e
Initial plan
Copilot Oct 24, 2025
6a624a1
Add ezspVersion to the internal metadata key
Copilot Oct 24, 2025
ed11a47
Add comment explaining Z2M requirement for ezspVersion
Copilot Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions bellows/zigbee/application.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,8 @@ async def load_network_info(self, *, load_devices=False) -> None:
"flow_control": (
flow_control.name.lower() if flow_control is not None else None
),
# Z2M will not load EZSP backups without this internal key
"ezspVersion": ezsp.ezsp_version,

@TheJulianJES TheJulianJES Oct 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this in the correct place for Z2M now? Shouldn't this be located in metadata.internal.ezspVersion for Z2M, and not metadata.ezsp.ezspVersion? Reference: https://github.com/Koenkk/zigbee-herdsman/blob/47ae47dbb70dfae4fe38a2458fc0d0250165f0d5/src/utils/backup.ts#L95

@puddly puddly Oct 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When exporting from the internal Zigpy NetworkBackup to the old JSON format, the metadata key contents are merged into internal: https://github.com/zigpy/zigpy/blob/1aba0f1c15af94120349c0ba18a58bd9ced8c484/zigpy/backups.py#L286-L320

We don't actually use internal in zigpy, it was renamed to metadata.

@TheJulianJES TheJulianJES Oct 24, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks for linking that. I only had the new structure from a HA downloaded backup in mind 😅
We should have a unified coordinator backup at some point! 😆

},
},
)
Expand Down
1 change: 1 addition & 0 deletions tests/test_application.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@
),
)
def test_send_failure(app, aps, ieee, msg_type):
fut = app._pending_requests[(0xBEED, 254)] = asyncio.Future()

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.10.8 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop

Check warning on line 548 in tests/test_application.py

View workflow job for this annotation

GitHub Actions / shared-ci / Run tests Python 3.11.0 

There is no current event loop
app.ezsp_callback_handler(
"messageSentHandler", [msg_type, 0xBEED, aps, 254, t.EmberStatus.SUCCESS, b""]
)
Expand Down Expand Up @@ -1995,6 +1995,7 @@
"can_burn_userdata_custom_eui64": True,
"can_rewrite_custom_eui64": True,
"chip_info": None,
"ezspVersion": 8,
}
},
),
Expand Down
Loading