ISchwarz23/FritzBox-API


Access your FritzBox from any Java application using this lightweight API.

Download


Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"
        
    

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]
        
    

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.ISchwarz23:FritzBox-API:'
	}
	dependencies {
		implementation("com.github.ISchwarz23:FritzBox-API:")
	}
	<dependency>
	    <groupId>com.github.ISchwarz23</groupId>
	    <artifactId>FritzBox-API</artifactId>
	    <version></version>
	</dependency>

                            
    libraryDependencies += "com.github.ISchwarz23" % "FritzBox-API" % ""
        
        

                            
    :dependencies [[com.github.ISchwarz23/FritzBox-API ""]]
        
        

Readme


FritzBox-API

Access your FritzBox from any Java application using this API. Tested on Fritz!Box 7390 (Fritz!OS 06.20)

This API is using the WebApp running on the FritzBox for interaction. So whether Telnet nor UPnP have to be activated.

Functionalities

  • log in
  • get public IP
  • reconnect to internet (get new IP)
  • turn on guest WiFi access point
  • configure guest WiFi access point
  • receive caller list

Usage Examples

Receiving new IP

final FritzBoxInterface fritzBox = new FritzBoxConnector().login("myPassword");
System.out.println("Old IP: " + fritzBox.getInternetIP());
fritzBox.reconnectToInternet();
System.out.println("New IP: " + fritzBox.getInternetIP());

Receiving caller list

final FritzBoxInterface fritzBox = new FritzBoxConnector().login("myPassword");
final List<Call> callList = fritzBox.getCallList();
for (final Call call : callList) {
	System.out.println(call);
}

Turn on Guest WiFi (simple mode)

final FritzBoxInterface fritzBox = new FritzBoxConnector().login("myPassword");
fritzBox.turnOnGuestWiFi("MyGuest WiFi", "myPassword");

Turn on Guest WiFi (advanced mode)

final boolean activatePushService = true;
final boolean limitOnWebAccess = true;
final boolean allowCommunicationBetweenClients = false;
final FritzBoxInterface fritzBox = new FritzBoxConnector().login("myPassword");
fritzBox.turnOnGuestWiFi("MyGuest WiFi", SecurityMode.WPA2, "myPassword", activatePushService, limitOnWebAccess, allowCommunicationBetweenClients);

Turn off Guest WiFi

final FritzBoxInterface fritzBox = new FritzBoxConnector().login("myPassword");
fritzBox.turnOffGuestWiFi();

Dependencies

  • slf4j-api-1.7.10
  • slf4j-simple-1.7.10