powerstat / fbapi

FritzBox TR64 api generator

PowerStat's FBApiGenerator for FritzBox APIs

This FBApiGenerator reads the api description from a FritzBox and generates an java api for it.

See:

• AVM Entwicklungssupport (1.36 2020-09-16)

Please note that I am not related to AVM in any way and that AVM will not support this code in any way!

Installation

Because this library is only useful for developers, the installation depends on your build environment.

The first step would be to let the generator build the code from your FritzBox:

mvn clean install -Dfb.hostname=<fritz.box> -Dfb.port=49443 -Dfb.username=<admin> -Dfb.password=<TopSecret!>

After this you could use the following dependency within your projects:

<dependency>
  <groupId>de.powerstat.fb</groupId>
  <artifactId>api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Other build tools like gradle will work analogous.

Java platform module system:

module com.example.java.app
 {
  requires de.powerstat.fb;
 }

To compile this project yourself you could use:

mvn clean install org.pitest:pitest-maven:mutationCoverage site -Dfb.hostname=<fritz.box> -Dfb.port=49443 -Dfb.username=<admin> -Dfb.password=<TopSecret!>

To find newer dependencies:

mvn versions:display-dependency-updates

To find newer plugins:

mvn versions:display-plugin-updates

To make a new release:

mvn --batch-mode release:clean release:prepare release:perform -Dfb.hostname=<fritz.box> -Dfb.port=49443 -Dfb.username=<admin> -Dfb.password=<TopSecret!>
git push -–tags
git push origin master

To run checkstyle:

mvn checkstyle:check

To run pmd:

mvn pmd:check

To run spotbugs:

mvn spotbugs:check

To run arch-unit:

mvn arch-unit:arch-test

To run JDeprScan:

mvn jdeprscan:jdeprscan jdeprscan:test-jdeprscan

To run toolchain:

mvn toolchains:toolchain

If you use a sonar server:

mvn sonar:sonar -Dsonar.token=<token>

If you use [infer][https://fbinfer.com/]:

infer run -- mvn clean compile

Usage

For usage in your own projects please read the Javadoc's and follow the examples in the unittests.

Contributing

If you would like to contribute to this project please read How to contribute.

License

This code is licensed under the Apache License Version 2.0.