Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add Freebox telephony status monitoring

Open
#1,827 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
backend

Research direction

Read the existing Freebox plugin and its API v6 authorization/token flow, then review the Freebox phone API calls the reporter has tested. Confirm with maintainers whether this belongs in the existing plugin or a companion plugin before choosing an entry point. Done means optional read-only telephony status monitoring reuses the existing token, excludes call and personal data and write actions, and has tests.

Written by the indexing model from the issue text.

Description

Feature request ➕ please feedback 💬
Is there an existing issue for this?
  • I have searched the existing open and closed issues
Is your feature request related to a problem? Please describe

The existing Freebox plugin can discover the Freebox and connected LAN devices, but it does not currently expose telephony status available through the Freebox API.

The Freebox API provides read-only information about the telephone service and connected phone interfaces, for example:

  • telephone service/network state
  • FXS/phone interface status
  • hardware fault state
  • DECT enabled/registration state
  • hook/ringing state

This could be useful for monitoring the Freebox telephone service without creating a separate external monitoring solution.

Describe the solution you'd like

Add optional read-only monitoring of Freebox telephony status to NetAlertX.

The implementation should reuse the existing Freebox authorization/token and should not require a second pairing.

Only non-sensitive operational information should be exposed. In particular, the feature should not collect or expose:

  • call history
  • phone numbers
  • caller names
  • contacts
  • DECT PINs
  • any write/configuration actions

I have confirmed on a Freebox v8 that the existing NetAlertX Freebox authorization can access the Freebox phone API successfully.

I would be happy to help implement this, but before starting I wanted to check whether this is something the maintainers would be interested in and whether you would prefer it to be integrated into the existing Freebox plugin or exposed as a separate companion plugin.

Describe alternatives you've considered

The main alternatives I considered are:

  1. Extending the existing Freebox device-scanner plugin directly.
  2. Adding a small companion Freebox telephony plugin using the existing Freebox pairing/token.
  3. Monitoring the telephone service outside NetAlertX.

A companion plugin may fit the current plugin model better because telephony interfaces are not normal network devices with MAC/IP identities, but I would prefer to follow the maintainers' preferred architecture before implementing anything.

Anything else?

I have already tested the underlying Freebox API read-only calls successfully.

The current Freebox integration uses API v6, and the same existing NetAlertX token was able to retrieve telephone service and phone-interface status without any additional pairing.

The intended scope would be monitoring only. No telephony configuration or call data would be included.

If this feature is considered useful, I am willing to prepare the implementation and tests against next_release following the project contribution guidelines.

Am I willing to test this? 🧪
  • I will do my best to test this feature on the netlertx-dev image when requested within 48h and report bugs to help deliver a great user experience for everyone and not to break existing installations.
Can I help implement this? 👩‍💻👨‍💻
  • Yes
  • No
Dominant language
Python
Stars
7.2k
Forks
456
Avg merge
17h 59m
Merged PRs (30d)
26

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from netalertx/NetAlertX

All issues in netalertx/NetAlertX

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.