fritzbox-java-api

Java API for managing FritzBox HomeAutomation using AVM Home Automation HTTP Interface inspired by grundid's fritzbox-java-api.

Important: Migration to Maven Central

Due to the deprecation of JCenter new versions will be published to Maven Central. In your build script please use

repositories {
    mavenCentral()
}

Information for Users

• CHANGELOG.md
• JavaDoc
• Test Results
• Test Coverage Report

Usage

Gradle

• Add Maven Central maven repository:

  repositories {
      mavenCentral()
  }

• Add dependency

  dependencies {
      compile 'com.github.kaklakariada:fritzbox-java-api:2.0.0'
  }

Maven

<dependency>
  <groupId>com.github.kaklakariada</groupId>
  <artifactId>fritzbox-java-api</artifactId>
  <version>2.0.0</version>
</dependency>

Run sample program

1. Create file application.properties with the following content and enter settings for your device:

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

2. Run example class TestDriver.

Development

Generate / update license header

./gradlew licenseFormat

Check if dependencies are up-to-date

./gradlew dependencyUpdates

Check dependencies for vulnerabilities

Add the following to your ~/.gradle/gradle.properties:

ossIndexUsername = <user>
ossIndexToken = <token>

./gradlew ossIndexAudit

Building

Install to local maven repository:

./gradlew clean publishToMavenLocal

Creating a Release

Preparations

1. Checkout the main branch, create a new branch.
2. Update version number in build.gradle and README.md.
3. Add changes in new version to CHANGELOG.md.
4. Commit and push changes.
5. Create a new pull request, have it reviewed and merged to main.

Perform the Release

1. Start the release workflow

• Run command gh workflow run release.yml --repo kaklakariada/fritzbox-java-api --ref main
• or go to GitHub Actions and start the release.yml workflow on branch main.

2. Update title and description of the newly created GitHub release.
3. After some time the release will be available at Maven Central.