Skip to main content

Communicate with the AVM FRITZ!Box

Project description

fritzconnection

Python-Interface to communicate with the AVM Fritz!Box. Supports the TR-064 protocol, the (AHA-)HTTP-Interface and also allows call-monitoring.

Installation

For installation use pip:

    $ pip install fritzconnection
      or
    $ pip install fritzconnection[qr]

The latter will install the segno package to enable QR-code creation for wifi login.

Quickstart

Using fritzconnection is as easy as:

    from fritzconnection import FritzConnection

    fc = FritzConnection(address="192.168.178.1", user="user", password="pw")
    print(fc)  # print router model information

    # tr-064 interface: reconnect for a new ip
    fc.call_action("WANIPConn1", "ForceTermination")

    # http interface: gets history data from a device with given 'ain'
    fc.call_http("getbasicdevicestats", "12345 7891011")

FritzConnection provides two basic commands to communicate with the router APIs: call_action() for the TR-064-Interface and call_http() for the (AHA)-HTTP-Interface. Both APIs can be used on the same FritzConnection instance side by side.

call_action

call_action() expects a TR-064 service- and an action-name (and optional arguments). In general FritzConnection can execute every service and action provided by the (model-specific) API as documented by AVM. For i.e. this can be network settings, status informations, access to home automation devices and much more. The call_action() method returns the response from the router as a dictionary with the values already converted to the matching Python datatypes.

call_http

call_http() expects a command for the http-interface like "getbasicdevicestats" and, depending on the command, additional arguments like a device "ain" (identifier). A call to the method returns a dictionary with the content-type, the encoding and the response data of the http-response. The content-type of the response-data is typical "text/plain" or "text/xml" and may need further processing.

Username and password

To avoid hardcoding the arguments user and password in applications FritzConnection can read both from the environment variables FRITZ_USERNAME and FRITZ_PASSWORD.

Caching

On instantiation FritzConnection has to inspect the model-specific router-API. This causes a lot of network requests and can take some seconds. To avoid this FritzConnection provides a cache that can get activated by the use_cache parameter:

    fc = FritzConnection(..., use_cache=True)

This argument defaults to False. After creating the cache FritzConnection will start up much more faster.

Library

The package comes with library-modules to make some API calls easier and also demonstrates how to implement applications on top of FritzConnection.

Documentation

The full documentation and release notes are at https://fritzconnection.readthedocs.org

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fritzconnection-1.14.0.tar.gz (57.2 kB view details)

Uploaded Source

Built Distribution

fritzconnection-1.14.0-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

Details for the file fritzconnection-1.14.0.tar.gz.

File metadata

  • Download URL: fritzconnection-1.14.0.tar.gz
  • Upload date:
  • Size: 57.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for fritzconnection-1.14.0.tar.gz
Algorithm Hash digest
SHA256 95dacaf9bed6b52d809169006c0994bc55cc893dbe0a014bcf9535ae9d00982f
MD5 19f57a24af063ad913957656ce11bae7
BLAKE2b-256 2bd3ab3940b245f0555882a4cc3b85005ad3b6444a13fb88dcf076311835da9e

See more details on using hashes here.

File details

Details for the file fritzconnection-1.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fritzconnection-1.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0cbc1977f21a04630773244eb1ca985af15c345aef4bbd5757b8fb124e7de1d
MD5 6d4adc6d4ad0faf1f103b1a4ff725c77
BLAKE2b-256 86b9a5895d2708dd70185a5db6b469af9af792d8680d6e2c88739d5a4322eb2b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page