fritzconnection 0.4.6

Communicate with the AVM FritzBox

fritzconnection

Python-Tool to communicate with the AVM FritzBox. Uses the TR-064 protocol.

Installation:

pip install fritzconnection

Dependencies

fritzconnection requires the python modules lxml and requests:

pip install lxml requests

Available Modules, Commands and Tools

fritzconnection.py makes the SOAP interface of the FRITZ!Box available on the command line. Shows all available services and actions when run with the argument -c.

fritzstatus.py is a command line interface to display status information of the FRITZ!Box. It also serves as an example on how to use the fritzconnection module.

fritzmonitor.py is a Tkinter GUI to display current IP as well as the upstream and downstream rates. It also makes it easy to reconnect and thus get a different IP from your ISP.

fritzhosts.py is a command line interface to display the hosts known by the FRITZ!Box with IP, name, MAC and status.

Other Files

fritztools.py contains some helper functions and test.py contains unit tests.

Quickstart

Inspect the API:

>>> import fritzconnection as fc
>>> fc.print_api(password='your_password')

An API-Call is made by the call_action-method of the FritzConnection-Class. This method takes the servicename, the actionname and optional arguments as parameter and may return a dictionary with the results (as described in the TR-064 protocoll description). A simple example is to reconnect for a new external ip:

>>> from fritzconnection import FritzConnection
>>> connection = FritzConnection()
>>> connection.call_action('WANIPConnection', 'ForceTermination')
# or more comfortable:
>>> connection.reconnect()

The latter wrapps the call_action-method. For a more complete example look at the fritzhosts.py souce-code.

Resources

Information on TR-064: - AVM’s manual First Steps with TR-064 http://www.avm.de/de/Extern/files/tr-064/AVM_TR-064_first_steps.pdf - TR-064 Technical Report DSL Forum http://www.broadband-forum.org/technical/download/TR-064.pdf