A clean Java API to Broadlink devices!

This is a Java version of mjg59's python-broadlink library.

This API is distributed via Maven Central. You can import via adding this as dependency in Maven pom.xml or clone/download this as ZIP and import in IDE.

1. Via Maven Central: (Release Builds) Add the following to your pom.xml under <dependencies>

   <dependency> <groupId>com.github.mob41.blapi</groupId> <artifactId>broadlink-java-api</artifactId> <version>1.0.1</version> </dependency>

2. Via OSSRH Snapshots: (Development Builds) To access snapshots/development builds e.g. 1.0.1-SNAPSHOT, you have to add the OSSRH snapshot repository

   <profiles> <profile> <id>allow-snapshots</id> <activation><activeByDefault>true</activeByDefault></activation> <repositories> <repository> <id>snapshots-repo</id> <url>https://oss.sonatype.org/content/repositories/snapshots</url> <releases><enabled>false</enabled></releases> <snapshots><enabled>true</enabled></snapshots> </repository> </repositories> </profile> </profiles>

3. Via Cloning: (Eclipse) Clone the project via git clone https://github.com/mob41/broadlink-java-api.git or via the download ZIP and extract the ZIP to a folder.

   And add the project into your Eclipse IDE by right clicking the Package Explorer, and, Import... -> Maven -> Existing Maven Projects

   Select the folder you cloned/downloaded broadlink-java-api to. And select the pom.xml inside.

   The project should be added. And the following you have to do is add the following dependency to your pom.xml:

    <dependency> <groupId>com.github.mob41.blapi</groupId> <artifactId>broadlink-java-api</artifactId> <version>1.0.1</version> </dependency>

1. Import necessary libraries

   import com.github.mob41.blapi.BLDevice; import com.github.mob41.blapi.RM2Device; //Necessary if using <code>2.ii</code> import com.github.mob41.blapi.mac.Mac; //Necessary if using <code>2.ii</code>

2. Creating/Discovering BLDevice instances by two methods:

   // // === Method 1. By Discovering Devices In Local Network === // BLDevice[] devs = BLDevice.discoverDevices(); //Default with 10000 ms (10 sec) timeout, search for multiple devices //BLDevice[] devs = BLDevice.discoverDevices(0); //No timeout will block the thread and search for one device only //BLDevice[] devs = BLDevice.discoverDevices(5000); //With 5000 ms (5 sec) timeout //The BLDevice[] array stores the found devices in the local network System.out.println("Number of devices: " + devs.length); BLDevice blDevice = null; for (BLDevice dev : devs){ System.out.println("Type: " + Integer.toHexString(dev.getDeviceType()) + " Host: " + dev.getHost() + " Mac: " + dev.getMac()); } //BLDevice dev = devs[0] // // === Method 2. Create a "RM2Device" or another "BLDevice" child according to your device type === // BLDevice dev = new RM2Device("192.168.1.123", new Mac("01:12:23:34:43:320")); //~do stuff //dev.auth();

3. Before any commands like getTemp() and enterLearning(), BLDevice.auth() must be ran to connect and authenticate with the Broadlink device.

   boolean success = dev.auth(); System.out.println("Auth status: " + (success ? "Success!" : "Failed!"));

4. Every BLDevice has its very own methods. Please refer to their own source code in the repository (as the main documentation still not completed...). Here's an example:

   if (dev instanceof RM2Device){ RM2Device rm2 = (RM2Device) dev; boolean success = rm2.enterLearning(); System.out.println("Enter Learning status: " + (success ? "Success!" : "Failed!")); float temp = rm2.getTemp(); System.out.println("Current temperature reported from RM2: " + temp + " degrees"); } else { System.out.println("The \"dev\" is not a RM2Device instance."); }

tl;dr This project is licensed under the MIT License.