com.github.lucadruda.iotc.device

Interface IIoTCClient

All Known Implementing Classes:

IoTCClient

public interface IIoTCClient

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().

Method Detail

SetProtocol

void SetProtocol(IOTC_PROTOCOL transport)

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

Parameters:

transport - Trasport to set. Default: MQTT

SetGlobalEndpoint

void SetGlobalEndpoint(String endpoint)

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

Parameters:

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

SetProxy

void SetProxy(HTTP_PROXY_OPTIONS options)

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

Parameters:

options - Proxy options

SetLogging

void SetLogging(IOTC_LOGGING logLevel)

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

Parameters:

logLevel - The logging level. Default: DISABLED

Disconnect

void Disconnect(IoTCCallback callback)
         throws IoTCentralException

Disconnect device.

Parameters:

callback - Callback executing when device successfully disconnect.

Throws:

IoTCentralException - if disconnection fails

Connect

void Connect()
      throws IoTCentralException

Connect device.

Throws:

IoTCentralException - if connection fails

SendTelemetry

void SendTelemetry(Object payload,
                   IoTCCallback callback)
            throws IoTCentralException

Send a telemetry message.

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

Throws:

IoTCentralException - if connection is dropped

SendState

void SendState(Object payload,
               IoTCCallback callback)
        throws IoTCentralException

Send a state message

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

Throws:

IoTCentralException - if connection is dropped

SendEvent

void SendEvent(Object payload,
               IoTCCallback callback)
        throws IoTCentralException

Send events

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

Throws:

IoTCentralException - if connection is dropped

SendProperty

void SendProperty(Object payload,
                  IoTCCallback callback)
           throws IoTCentralException

Send update values to properties.

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

void on(IOTC_EVENTS event,
        IoTCCallback callback)

Listen to events.

Parameters:

event - The event to listen to.

callback - The callback to execute when the event is triggered