OsProject
id
state
owner
title	Java API for Fritzbox
url	https://github.com/BITPlan/com.bitplan.fritzbox
version	0.0.1
description
date
since
until

API

see https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf
see https://stackoverflow.com/tags/fritzbox/info (with Links to Implementations)

Unit tests

The unit tests can be run with:

mvn test

If you did not setup your configuration file yet there will be a warning: You might want to set your application properties in $HOME.fritzbox/application.properties When the application properties are set more tests are run. E.g. one test should show "Logged in with session id ..."

Configuration File

You might want to set your application properties in $HOME/.fritzbox/application.properties

fritzbox.url=http://fritz.box:443
fritzbox.username=user
fritzbox.password=secret

Code Example

see https://github.com/WolfgangFahl/fritzbox-java-api/blob/master/src/main/java/com/github/kaklakariada/fritzbox/TestDriver.java

 final Config config = ConfigService.readConfig();

    LOG.info("Logging in to '{}' with username '{}'", config.baseUrl,
        config.username);
    final HomeAutomation homeAutomation = HomeAutomation.connect(config);

    final DeviceList devices = homeAutomation.getDeviceListInfos();
    LOG.info("Found {} devices", devices.getDevices().size());
    for (final Device device : devices.getDevices()) {
      LOG.info("\t{}", device);
    }

    final List<String> ids = homeAutomation.getSwitchList();
    LOG.info("Found {} device ids: {}", ids.size(), ids);

    if (devices.getDevices().isEmpty()) {
      homeAutomation.logout();
      return;
    }

    for (final String ain : ids) {
      testHomeAutomation(homeAutomation, ain);
      // testEnergyStats(homeAutomation.getSession(), ain);
}

CmdLine

Help / Usage

java -jar fritzbox-java.jar -h

Help
FritzBox Java API Command Line Version: 0.0.1

github: https://github.com/BITPlan/com.bitplan.fritzbox

  usage: java -jar fritzbox.jar
 -d (--debug)         : debug
                        create additional debug output if this switch is used
                        (Vorgabe: false)
 -h (--help)          : help
                        show this usage (Vorgabe: true)
 -l (--list)          : list
                        list devices (Vorgabe: false)
 -r (--read) STRING[] : read
                        read the given devices
 -s (--set) STRING[]  : set
                        set the given devices to the givnen states e.g. main off
 -v (--version)       : showVersion
                        show current version if this switch is used (Vorgabe:
                        false)

List devices

java -jar fritzbox-java-api-0.4.2.jar -l
                Name |         By |         Product | Identifier
---------------------+------------+-----------------+-------------------------
            Aquarium |        AVM |  FRITZ!DECT 200 | 08761 0033476
          Wohnzimmer |        AVM |  FRITZ!DECT 200 | 08761 0092893

read devices

java -jar fritzbox.jar -r Aquarium Wohnzimmer
 name: Aquarium
   id: 087610033476 
alive: true
   on: false
 uses:     0     W
 used:   940,882 kWh
 temp:    25,0   °C

 name: Wohnzimmer
   id: 087610092893 
alive: true
   on: true
 uses:     1     W
 used:    35,510 kWh
 temp:    24,5   °C

set devices

java -jar fritzbox-java-api-0.4.2.jar -s Aquarium off  Wohnzimmer on
switching Aquarium off
switching Wohnzimmer on

Links

History

and was used at BITPlan internally for a while until we got unhappy with the license and the details of the implementation. Therefore we started a new implementation "from scratch".

C# version

The code at:

https://github.com/WolfgangFahl/fritz-csharp-api

is a starting point. It reads the same application.properties and gets a session id to work with.

Fritzbox-java-api

Contents

API