neufbox-client 1.0.0

Neufbox API Client

Neufbox API Client

This is a python API client library to interact with Neufbox NB4, NB5, NB6, NB6V, NB6VAC modem/routers sold by Neuf Telecom, SFR or Red by SFR companies.

See the API specification for details about the API itself.

Installation

To install the package:

pip install neufbox-client

Getting started

Here is a simple example that retrieves the neufbox "system" information:

from neufbox import Client, username_password
from pprint import pprint


client = Client('192.168.1.1')
system_info = client.system.get_info()
pprint(system_info)

We can also login to access private information from the neufbox. A username_password helper is provided by the library, which sends the credentials (in hashed format) to validate the token received by the client from the neufbox (only if the neufbox allows username/password authentication):

client.login(username_password('admin', 'p4ssw0rd'))
wlan_info = client.wlan.get_info()
pprint(wlan_info)

The client also allows changing some parameters of the neufbox by using the setters available in the different namespaces. See the API specification for details.

You can also have a look on the demo file to see a working example.

Support

This project is hosted on Github. Please report issues via the bug tracker.