IOT-JavaClient

Getting started

Create your own account at https://my.iot-ticket.com/Dashboard/.

Register device

A device Id is automatically assigned to a newly registered device; the API Client should store this device Id as it uniquely identifies the device and will be used in subsequent calls. Client should avoid multiple registration call as this might result to duplicate devices being created. When in doubt, a good flow will be to get the list of already created devices and validate the device’s existence on the server through its name and attributes. Once the device is registered and the device id is obtained, clients can immediately start sending measurement values to the server.

    final String userName = "username";
    final String pwd = "password";
    final IOTAPIClient client = new IOTAPIClient("https://my.iot-ticket.com/api/v1", userName, pwd);

    Device d = new Device();
    d.setName("DeviceName");
    d.setManufacturer("Devicemanufacturer");
    d.setType("DeviceType");
    d.getAttributes().add(new DeviceAttribute("EngineSize", "2.4"));
    d.getAttributes().add(new DeviceAttribute("FuelType", "Benzene"));

    DeviceDetails deviceDetails = client.registerDevice(d);
    System.out.println("This is the device id that should be used in subsequent calls when sending measurement data: " + deviceDetails.getDeviceId());

Send measurement data

    Calendar cal = Calendar.getInstance(TimeZone.getTimeZone("UTC"));

    DatanodeWriteValue dnwrite = new DatanodeWriteValue();
    dnwrite.setName("Airflow");
    dnwrite.setPath("Engine/Primary");
    dnwrite.setUnit("l/s");
    dnwrite.setValue(85.2f);
    dnwrite.setTimestampMilliseconds(cal.getTimeInMillis());

    WriteDataResponse writeResult = client.writeData(deviceId, dnwrite);
     

Read measurement data

    DatanodeQueryCriteria crit = new DatanodeQueryCriteria(deviceId, "Engine/Primary/Airflow", "datapoint2", "datapoint3");
    crit.setLimit(50);
    crit.setSortOrder(Order.Descending);


    ProcessValues processValues = client.readProcessData(crit);
    Collection<DatanodeRead> datanodeReads = processValues.getDatanodeReads();
    for (DatanodeRead datanodeRead : datanodeReads) {

        for (DatanodeReadValue value : datanodeRead.getDatanodeReadValues()) {
            System.out.println("Value=" + value.getValue() + " @" +value.getTimestampMilliSeconds());

        }
    }
    

Read statistical data

		
	StatisticalDataQueryCriteria criteria = new StatisticalDataQueryCriteria("<deviceId>", Grouping.Minute, 1546293600000L, 1546293604000L, "number2");
	
	StatisticalDataValues values = client.readStatisticalData(criteria);
	
	Collection<StatisticalDataRead> reads = values.getStatisticalDataRead();
	for (StatisticalDataRead read: reads) {
		for (StatisticalDataReadValue value: read.getStatisticalDataReadValues()) {
			System.out.println("\nStatistics:\n");
			System.out.println(value.getMinimum());
			System.out.println(value.getMaximum());
			System.out.println(value.getAverage());
			System.out.println(value.getCount());
			System.out.println(value.getSum());
			System.out.println(value.getTimestampMilliSeconds());
		}
			
	}

Get root enterprises

		
	PagedResult<Enterprise> enterprises = client.getRootEnterprises(10, 0);
		
	for (Enterprise enterprise: enterprises.getResults()) {
		System.out.println("\nRoot enterprise:\n");
	
		System.out.println(enterprise.getUri().toString());
		System.out.println(enterprise.getName());
		System.out.println(enterprise.getResourceId());
		System.out.println(enterprise.getHasSubEnterprises());	
	}		

Get sub enterprises

		
	PagedResult<Enterprise> enterprises = client.getSubEnterprises("5506", 10, 0);
	
	for (Enterprise enterprise: enterprises.getResults()) {
		System.out.println("\nSub enterprise:\n");
		System.out.println(enterprise.getUri().toString());
		System.out.println(enterprise.getName());
		System.out.println(enterprise.getResourceId());
		System.out.println(enterprise.getHasSubEnterprises());	
	}		
}

API documentation

https://www.iot-ticket.com/images/Files/IoT-Ticket.com_IoT_API.pdf

Download JAR

https://github.com/IoT-Ticket/IoT-JavaClient/releases/latest