com.microsoft.azure.sdk.iotcentral.device

Class IoTCClient

java.lang.Object

com.microsoft.azure.sdk.iotcentral.device.IoTCClient

All Implemented Interfaces:

IIoTCClient

public class IoTCClient
extends Object
implements IIoTCClient

Constructor Summary

Constructors

Constructor and Description
IoTCClient(String id, String scopeId, IOTC_CONNECT authenticationType, Object options)
IoTCClient(String id, String scopeId, IOTC_CONNECT authenticationType, Object options, ILogger logger)

Method Summary

Modifier and Type	Method and Description
void	Connect() Connect device.
void	Disconnect(IoTCCallback callback) Disconnect device.
void	on(IOTC_EVENTS event, IoTCCallback callback) Listen to events.
void	SendEvent(Object payload, IoTCCallback callback) Send events
void	SendProperty(Object payload, IoTCCallback callback) Send update values to properties.
void	SendState(Object payload, IoTCCallback callback) Send a state message
void	SendTelemetry(Object payload, IoTCCallback callback) Send a telemetry message.
void	SetGlobalEndpoint(String endpoint) Set DPS global endpoint.
void	SetLogging(IOTC_LOGGING logLevel) Set logging level (FULL, API_ONLY, DISABLED).
void	SetProtocol(IOTC_PROTOCOL transport) Set connection protocol (MQTT, AMQP, HTTPS).
void	SetProxy(HTTP_PROXY_OPTIONS options) Set network proxy Must be called before Connect().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IoTCClient

public IoTCClient(String id,
                  String scopeId,
                  IOTC_CONNECT authenticationType,
                  Object options)

IoTCClient

public IoTCClient(String id,
                  String scopeId,
                  IOTC_CONNECT authenticationType,
                  Object options,
                  ILogger logger)

Method Detail

SetLogging

public void SetLogging(IOTC_LOGGING logLevel)

Description copied from interface: IIoTCClient

Set logging level (FULL, API_ONLY, DISABLED). Can be changed at any time.

Specified by:

SetLogging in interface IIoTCClient

Parameters:

logLevel - the logger to set

SetProtocol

public void SetProtocol(IOTC_PROTOCOL transport)

Description copied from interface: IIoTCClient

Set connection protocol (MQTT, AMQP, HTTPS). Must be called before Connect().

Specified by:

SetProtocol in interface IIoTCClient

Parameters:

transport - Trasport to set. Default: MQTT

SetGlobalEndpoint

public void SetGlobalEndpoint(String endpoint)

Description copied from interface: IIoTCClient

Set DPS global endpoint. Must be called before Connect()

Specified by:

SetGlobalEndpoint in interface IIoTCClient

Parameters:

endpoint - Endpoint of DPS server. Default: "global.azure-devices-provisioning.net"

SetProxy

public void SetProxy(HTTP_PROXY_OPTIONS options)

Description copied from interface: IIoTCClient

Set network proxy Must be called before Connect(). Default: no proxy

Specified by:

SetProxy in interface IIoTCClient

Parameters:

options - Proxy options

Disconnect

public void Disconnect(IoTCCallback callback)
                throws IoTCentralException

Description copied from interface: IIoTCClient

Disconnect device.

Specified by:

Disconnect in interface IIoTCClient

Parameters:

callback - Callback executing when device successfully disconnect.

Throws:

IoTCentralException - if disconnection fails

Connect

public void Connect()
             throws IoTCentralException

Description copied from interface: IIoTCClient

Connect device.

Specified by:

Connect in interface IIoTCClient

Throws:

IoTCentralException - if connection fails

SendTelemetry

public void SendTelemetry(Object payload,
                          IoTCCallback callback)

Description copied from interface: IIoTCClient

Send a telemetry message.

Specified by:

SendTelemetry in interface IIoTCClient

Parameters:

payload - The telemetry object. Can include multiple values in a flatten object. It can be a map, a POJO or a JSON string

callback - The callback to execute when message is delivered to the hub

SendState

public void SendState(Object payload,
                      IoTCCallback callback)

Description copied from interface: IIoTCClient

Send a state message

Specified by:

SendState in interface IIoTCClient

Parameters:

payload - The state object. Can include multiple values in a flatten object. It can be a map, a POJO or a JSON string

callback - The callback to execute when message is delivered to the hub

SendEvent

public void SendEvent(Object payload,
                      IoTCCallback callback)

Description copied from interface: IIoTCClient

Send events

Specified by:

SendEvent in interface IIoTCClient

Parameters:

payload - The event object. Can include multiple events in a flatten object. It can be a map, a POJO or a JSON string

callback - The callback to execute when message is delivered to the hub

SendProperty

public void SendProperty(Object payload,
                         IoTCCallback callback)
                  throws IoTCentralException

Description copied from interface: IIoTCClient

Send update values to properties.

Specified by:

SendProperty in interface IIoTCClient

Parameters:

payload - The property object. Can include multiple values in a flatten object. It can be a map, a POJO or a JSON string. If property is sent in the form {propertyName:{value:"value"}} and propertyName is the name of a command, then it sends updates to specific command tile in IoTCentral( e.g. command progress)

callback - The callback to execute when message is delivered to the hub

Throws:

IoTCentralException - if connection is dropped

on

public void on(IOTC_EVENTS event,
               IoTCCallback callback)

Description copied from interface: IIoTCClient

Listen to events.

Specified by:

on in interface IIoTCClient

Parameters:

event - The event to listen to.

callback - The callback to execute when the event is triggered