Skip to content

Latest commit

 

History

History
98 lines (77 loc) · 3.82 KB

README.md

File metadata and controls

98 lines (77 loc) · 3.82 KB
Raw

loxone-java Maven Central codecov

Java implementation of the Loxone™ communication protocol (Web Socket).

  • Supported miniservers: miniserver gen. 1, miniserver gen. 2, miniserver GO
  • Supported firmware: 10.4.0.0 and ongoing

Most of the library is trying to behave according to Loxone API documentation and Loxone webservices. However, there are also some reverse engineered parts, marked with @LoxoneNotDocumented annotation.

Disclaimer: The library is still far from complete coverage of Loxone behaviour, which means:

  • public APIs are subject to change with every new version
  • there can be serious bugs

Therefore, any feedback or help is welcomed.

Usage

Maven

<dependency>
    <groupId>cz.smarteon</groupId>
    <artifactId>loxone-java</artifactId>
    <version><!-- desired version --></version>
</dependency>

Gradle

compile group: 'cz.smarteon', name: 'loxone-java', version: 'desired version'

or

implementation("cz.smarteon", "loxone-java", "desired version")

Quick start

The main entry point of the library is the Loxone class.

// obtain loxone instance
final Loxone loxone = new Loxone(new LoxoneEndpoint(address), user, password, uiPassword);

// start interaction and wait for LoxoneApp fetched
loxone.start();

// do the job
loxone.sendControlOn(loxone.app().getControl(SwitchControl.class));

// obtain http or websocket classes for more low-level work
final LoxoneHttp loxoneHttp = loxone.http();
final LoxoneWebSocket loxoneWebSocket = loxone.webSocket();

// stop the session correctly
loxone.stop();

Study examples for detailed usage information.

Miniserver discovery

The library supports Loxone miniserver discovery, see MiniserverDiscoverer.

// find at least one miniserver, waiting for maximum 500 millis
Set<MiniserverDiscovery> discovered = new MiniserverDiscoverer().discover(1, 500);

Android specifics

On Android 6 and older, the java.util.Base64 is not available. Please use setBase64Codec to use different implementation.

Codec.setBase64Codec(..., ...);

Development & Contributions

Note: Build currently requires at least JDK 11 to be locally installed

Gradle wrapper is in the repository - should be available once you clone it. You can use the gradlew to do builds & tests

./gradlew build

This first build should succeed, this means the project is correctly setup and you can start contributing to it.

Note: When the MiniserverDiscovererTest fails this could be a firewall issue, this test opens up a random UDP port for the test

MiniserverDiscovererTest > should discover() FAILED
    strikt.internal.opentest4j.AssertionFailed at MiniserverDiscovererTest.kt:31

It is adviced to install the lombok plugin for your IDE of choice, this makes coding & debugging easier, you can find the instructions for installing the plugin for various IDE's on the following location https://projectlombok.org/setup/

Writing unit tests

We prefer Junit5 with Kotlin, Strikt and Mockk for writing unit testing. Please follow the guidelines and documentation on the internet. Kotlin is easy to grab fro Java programmers and in many cases it allows more concise code. However Java + Junit5 unit tests will be accepted as well.