ClearBlade IoT Core Java Client

Java library and samples for ClearBlade IoT Core.

Supported Java versions

Java 11 or above is required for using this client. Java 17 is the best choice for new development.

Usage

You can use the Maven artifact or do a Maven local installation and setup.

Maven artifact

If you are using the Maven artifact, add the following dependency to your pom.xml file in a newly created/generated Maven app:

<dependency>
  <groupId>io.github.clearblade</groupId>
  <artifactId>clearblade-cloud-iot</artifactId>
  <version>1.0.5</version>
</dependency>

Local installation and setup

For Maven local installation:

In the clearblade-cloud-iot folder, run the following command to install the libraries and build the Maven sample:

mvn clean install

Quickstart

From the ClearBlade Migration from Google IoT Core section migrate your existing Google IoT Core registries and devices into ClearBlade IoT Core or use the ClearBlade IoT Core Console, create a device registry and devices.
Add service accounts to a project and download the JSON file with your service account’s credentials.

Use the following to set your environment variables keys in your terminal or IDE environment configurations:

 export CLEARBLADE_CONFIGURATION=/path/to/file.json

Optional

 export CLEARBLADE_REGISTRY=[your-registry]
 export CLEARBLADE_REGION=[your-region]
 export BINARYDATA_AND_TIME_GOOGLE_FORMAT=true

Use the HTTP or MQTT samples in the samples folder.

ClearBlade IoT Core Java samples

The sample apps demonstrate registry and device creation for ClearBlade IoT Core. The samples folder contains all the Java samples demonstrating an overview of the ClearBlade IoT Core Platform.

Before running the sample, you must configure your development environment and terminal as described in the Quickstart above or the samples folder.

Before running the samples, you must set the CLEARBLADE_CONFIGURATION. Optionally, set the CLEARBLADE_REGISTRY and CLEARBLADE_REGION environment variables to avoid changing them in the sample app every time you run it.

If you set the BINARYDATA_AND_TIME_GOOGLE_FORMAT environment variable, then it will give the binaryData object's response in binary form and time in timestamp format, which will have seconds and nanoseconds, following Google's structure. It's applicable on the get device state list and modify and device config version methods. Cast the data in the proper format.

	ListDeviceStatesResponse response = deviceManagerClient.listDeviceStates(request);
	if(response != null) {
		for (DeviceState element : response.getDeviceStatesList()) {
			System.out.println(((ByteString)element.getBinaryData()).toByteArray());
			System.out.println(((ByteString)element.getBinaryData()).toStringUtf8());
			System.out.println(((Timestamp)element.getUpdateTime()).getSeconds());
			System.out.println(((Timestamp)element.getUpdateTime()).getNanos());
		}
	}

When switching to use new registries and regions, either:

Update the CLEARBLADE_REGISTRY and CLEARBLADE_REGION environment variables; or
Change the REGISTRY and REGION variables in the sample code/app.

Using the client library within an example app

public class App {

	public static String PROJECT = "";
	public static String LOCATION = "";
	public static String REGISTRY = "";
	static ConfigParameters configParameters = ConfigParameters.getInstance();

	public static void main(String[] args) {
		PROJECT = "your-project-id";
		LOCATION = "your-region";
		REGISTRY = "your-registry";
		if (REGISTRY != null) {
			configParameters.setRegistry(REGISTRY);
		}
		if (LOCATION != null) {
			configParameters.setRegion(LOCATION);
		}
		asyncDevicesList();
	}

	public static void asyncDevicesList() {
		DeviceManagerAsyncClient deviceManagerAsyncClient = new DeviceManagerAsyncClient();
		RegistryName parent = RegistryName.of(PROJECT, LOCATION, REGISTRY);
		DevicesListRequest request = DevicesListRequest.Builder.newBuilder().setParent(parent.toString())
				.setGatewayListOptions(GatewayListOptions.newBuilder().setGatewayType(GatewayType.NON_GATEWAY).build())
				.setPageSize(10)
				.build();
		DevicesListResponse response = deviceManagerAsyncClient.listDevices(request);

Running the sample: command line

The following command summarizes the sample usage:

First, compile the sample.

Run registry example:

mvn exec:java \
	-Dexec.cleanupDaemonThreads=false \
    -Dexec.mainClass="com.clearblade.cloud.iot.v1.samples.createdeviceregistry.SyncCreateDeviceRegistry" \
	-DprojectName="your-project-id" \
	-Dlocation="your-region" \
	-DregistryName="your-registry"

Run device example:

mvn exec:java \
	-Dexec.cleanupDaemonThreads=false \
    -Dexec.mainClass="com.clearblade.cloud.iot.v1.samples.createdevice.AsyncCreateDevice" \
	-DprojectName="your-project-id" \
	-Dlocation="your-region" \
	-DregistryName="your-registry" \
	-DdeviceName="your-device-id" \

ClearBlade / java-iot