Skip to content

add "system" api to allow query of panel status flags - #98

Merged
kk7ds merged 1 commit into
kk7ds:masterfrom
drsweb:Add-Panel-System-Battery-Info
Nov 5, 2026
Merged

kk7ds merged 1 commit into
kk7ds:masterfrom
drsweb:Add-Panel-System-Battery-Info

Conversation

@drsweb

@drsweb drsweb commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

Description

Adds a /system endpoint to expose security system panel status information (panel ID and active status flags), improving observability for Home Assistant and other integrations consuming the nx584 server API.

Changes

  • New GET /system endpoint returning panel_id and status_flags from the controller's system state
  • New Client.get_system() method in the Python client library for programmatic access
  • New nx584_client system CLI subcommand with pretty-printed output
  • Version bumped from 1.2 to 1.3 to signal the new endpoint availability
  • get_system() returns None on non-200 responses for graceful degradation against older server versions

Verification

  • Automated tests pass (python -m pytest tests — 22 passed)
  • Visual/manual verification completed (tested /system endpoint response with active flags, empty flags, and CONTROLLER=None error state)

Closes #91

@drsweb
drsweb marked this pull request as ready for review October 29, 2026 21:18
@kk7ds

kk7ds commented Nov 4, 2026

Copy link
Copy Markdown
Owner

@chrodriguez ?

@chrodriguez

Copy link
Copy Markdown
Contributor

@chrodriguez ?

Thanks @drsweb, this is exactly what we asked for in #91: /system with panel_id and status_flags, Client.get_system() returning None on non-200, and the API version bump to 1.3. LGTM from the Home Assistant integration side.

@kk7ds a release with this would let us add a panel low-battery / AC-fail sensor to the nx584 integration.

@drsweb

drsweb commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor Author

@chrodriguez ?

Thanks @drsweb, this is exactly what we asked for in #91: /system with panel_id and status_flags, Client.get_system() returning None on non-200, and the API version bump to 1.3. LGTM from the Home Assistant integration side.

@kk7ds a release with this would let us add a panel low-battery / AC-fail sensor to the nx584 integration.

@chrodriguez You're very welcome, glad to hear it gets you what you need for this. Thanks @kk7ds for your help.

@kk7ds
kk7ds merged commit 5e538c5 into kk7ds:master Nov 5, 2026
1 check passed
@drsweb
drsweb deleted the Add-Panel-System-Battery-Info branch November 13, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature request: battery level and a stable device identifier

3 participants