Documentation for m2mb_mqtt functionalities

This group includes all the information about m2mb_mqtt configuration and usage *. More...

#define	m2mb_mqtt_conf_(h, args...)   m2mb_mqtt_conf( h, CMDS( args ) )
enum	M2MB_MQTT_IND_E { M2MB_MQTT_INDICATION_DISCONNECT }
	MQTT Indications enum.
enum	M2MB_MQTT_RESPONSE_E {   M2MB_MQTT_SUCCESS = 0, M2MB_MQTT_ERROR_BAD_ARG = -1, M2MB_MQTT_ERROR_OUT_OF_BUFFER = -2, M2MB_MQTT_ERROR_MALFORMED_DATA = -3,   M2MB_MQTT_ERROR_PACKET_TYPE = -4, M2MB_MQTT_ERROR_PACKET_ID = -5, M2MB_MQTT_ERROR_TLS_CONNECT = -6, M2MB_MQTT_ERROR_TIMEOUT = -7,   M2MB_MQTT_ERROR_NETWORK = -8, M2MB_MQTT_ERROR_MEMORY = -9, M2MB_MQTT_ERROR_STAT = -10, M2MB_MQTT_ERROR_PROPERTY = -11,   M2MB_MQTT_ERROR_SERVER_PROP = -12, M2MB_MQTT_ERROR_CALLBACK = -13, M2MB_MQTT_ERROR_TOPIC_LIST = -15, M2MB_MQTT_ERROR_ASYNC_THREAD = -16,   M2MB_MQTT_CONTINUE = -101, M2MB_MQTT_STDIN_WAKE = -102 }
	MQTT APIs response enum. More...
enum	M2MB_MQTT_STATUS_E {   M2MB_MQTT_NOT_CONNECTED, M2MB_MQTT_CLIENT_CONNECTED, M2MB_MQTT_CONN_RESET_BY_PEER, M2MB_MQTT_PINGREQ_TIMEOUT_FAIL,   M2MB_MQTT_CONNACK_TIMEOUT, M2MB_MQTT_CONNECT_TIMEOUT, M2MB_MQTT_FATAL_ERROR, M2MB_MQTT_NETWORK_ERROR,   M2MB_MQTT_STATUS_UNKNOWN = 0xFF }
	mqtt client status enum More...
enum	M2MB_MQTT_ACTION_E {   M2MB_MQTT_SET_CLIENT_ID, M2MB_MQTT_SET_TIMEOUT_MS, M2MB_MQTT_SECURE_OPT, M2MB_MQTT_SET_KEEPALIVE_SEC,   M2MB_MQTT_SET_CLEAN_SESSION, M2MB_MQTT_SET_PROTOCOL_LEVEL, M2MB_MQTT_SET_LAST_WILL, M2MB_MQTT_SET_USERNAME,   M2MB_MQTT_SET_PASSWORD, M2MB_MQTT_SET_DISCONNECT_CALLBACK, M2MB_MQTT_SET_PDP_CONTEXT, M2MB_MQTT_GET_CLIENT_ID,   M2MB_MQTT_GET_TIMEOUT_MS, M2MB_MQTT_GET_KEEPALIVE_SEC, M2MB_MQTT_GET_CLEAN_SESSION, M2MB_MQTT_GET_PROTOCOL_LEVEL,   M2MB_MQTT_GET_LAST_WILL, M2MB_MQTT_GET_PDP_CONTEXT }
	MQTT actions enum List of actions performed through m2mb_mqtt_conf API. More...
enum	M2MB_MQTT_QOS_E { M2MB_MQTT_QOS_0 = 0, M2MB_MQTT_QOS_1 = 1, M2MB_MQTT_QOS_2 = 2 }
	MQTT QoS Enum. More...
enum	M2MB_MQTT_RX_STATUS_E { M2MB_MQTT_RX_FINISHED, M2MB_MQTT_RX_MORE_DATA }
	MQTT Receive Data Status Enum. More...
typedef HANDLE	M2MB_MQTT_HANDLE
	MQTT context handle. This is obtained from m2mb_mqtt_init API and then used in subsequent MQTT APIs.
typedef void(*	m2mb_mqtt_ind_callback) (M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata)
	MQTT call back prototype. More...
typedef void(*	M2MB_MQTT_MSG_HNDLR_CB_T) (M2MB_MQTT_HANDLE Handle, void *arg, const CHAR *topic, UINT16 topic_length, const CHAR *msg, UINT32 msg_length, M2MB_MQTT_RX_STATUS_E status)
	MQTT message handler call back prototype. More...
typedef struct M2MB_MQTT_TOPIC	M2MB_MQTT_TOPIC_T
	MQTT Topic Structure This is used in m2mb_mqtt_subscribe and m2mb_mqtt_unsubscribe API.
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_init (M2MB_MQTT_HANDLE *h, m2mb_mqtt_ind_callback callback, void *userdata)
	m2mb_mqtt_init is called to initialize MQTT context. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_deinit (M2MB_MQTT_HANDLE Handle)
	m2mb_mqtt_deinit deinitializes MQTT service for specified MQTT client. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_conf (M2MB_MQTT_HANDLE Handle, UINT8 nCmds,...)
	m2mb_mqtt_conf sets/gets some MQTT parameters and configurations. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_connect (M2MB_MQTT_HANDLE Handle, const CHAR *host, UINT32 port)
	m2mb_mqtt_connect is called to connect to the specified MQTT broker. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_disconnect (M2MB_MQTT_HANDLE Handle)
	m2mb_mqtt_disconnect is called to disconnect from the MQTT broker. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_publish (M2MB_MQTT_HANDLE Handle, M2MB_MQTT_QOS_E qos, UINT8 retain, UINT16 message_id, const CHAR *topic, const CHAR *data, UINT32 data_len)
	m2mb_mqtt_publish is called to Publishes a message to the MQTT broker. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_subscribe (M2MB_MQTT_HANDLE Handle, UINT16 message_id, UINT32 topic_count, M2MB_MQTT_TOPIC_T *pTopics)
	m2mb_mqtt_subscribe is called to Subscribe. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_unsubscribe (M2MB_MQTT_HANDLE Handle, UINT16 message_id, UINT32 topic_count, M2MB_MQTT_TOPIC_T *topics)
	MqttClient_Unsubscribe is called to unsubscribe. More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_ping (M2MB_MQTT_HANDLE Handle)
	m2mb_mqtt_ping is called to ping More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_getClientStatus (M2MB_MQTT_HANDLE handle, M2MB_MQTT_STATUS_E *status)
	m2mb_mqtt_getClientStatus gets MQTT client current status More...
M2MB_MQTT_RESPONSE_E	m2mb_mqtt_setClientStatus (M2MB_MQTT_HANDLE handle, M2MB_MQTT_STATUS_E status)
	m2mb_mqtt_setClientStatus sets MQTT client current status More...

Detailed Description

This group includes all the information about m2mb_mqtt configuration and usage *.

Typedef Documentation

m2mb_mqtt_ind_callback

typedef void( * m2mb_mqtt_ind_callback) (M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata)

MQTT call back prototype.

This callback is triggered when MQTT client receives any event.

Parameters

[in]	Handle	handle to the MQTT client instance on which MQTT message is received
[in]	event	event indication for which the callback has been triggered
[in]	resp_size	size of the data sent
[in]	resp	response
[in]	userdata	user data returned by callback function

Returns

None

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 ) );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

M2MB_MQTT_MSG_HNDLR_CB_T

typedef void( * M2MB_MQTT_MSG_HNDLR_CB_T) (M2MB_MQTT_HANDLE Handle, void *arg, const CHAR *topic, UINT16 topic_length, const CHAR *msg, UINT32 msg_length, M2MB_MQTT_RX_STATUS_E status)

MQTT message handler call back prototype.

This callback function is called when a message is received on a subscribed topic. This is registered while subscribing to a topic.

Parameters

[in]	Handle	The mqtt handle associated with the client for which data is received
[in]	arg	User defined pointer, set while registering the callback
[in]	topic	The topic string
[in]	topic_Length	The topic string len
[in]	msg	The received payload
[in]	msg_Length	The payload size in bytes
[in]	status	Status whethe more data is pending.

Returns

None

Note

If the message payload is larger than receive data buffer (1024), this callback will be called multiple times for the same message recived. Parameter status is used to identify if there is pending data.

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
static void mqtt_topic_cb( M2MB_MQTT_HANDLE handle, void* arg, const CHAR* topic, UINT16 topic_length, const CHAR* msg, UINT32 msg_length, M2MB_MQTT_RX_STATUS_E status )
{
  UINT8 buf[1024];
  memcpy(buf, topic, topic_length);
  buf[topic_length] = '\0'; // Make sure its null terminated
 
  printf("MQTT Message: Topic %s, Len %d\r\n", buf, msg_length);
 
  memcpy(buf, msg, msg_length);
  buf[msg_length] = '\0'; // Make sure its null terminated
  printf("Message: %s",  buf);
 
  if(status == M2MB_MQTT_RX_MORE_DATA)
  {
    printf("More data to be received");
  }
}
 
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf(p_mqtt, CMDS(M2MB_MQTT_SET_PASSWORD, "1234567890"));
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  result = m2mb_mqtt_publish( p_mqtt, 0, 0, 10, "things/aabbcc/property/temp", "123", 3 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_publish succeeded");
  }
 
  M2MB_MQTT_TOPIC_T topics[2] = {0};
 
  CHAR* topic1 = "things/topic1";
  CHAR* topic2 = "things/topic2";
 
  topics[0].topic_filter = topic1;
  topics[0].qos = 0;
  topics[0].cb = mqtt_topic_cb;
 
  topics[1].topic_filter = topic2;
  topics[1].qos = 1;
  topics[1].cb = mqtt_topic_cb;
 
  result = m2mb_mqtt_subscribe( p_mqtt, 11, 2, topics );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_subscribe succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

Enumeration Type Documentation

M2MB_MQTT_ACTION_E

enum M2MB_MQTT_ACTION_E

MQTT actions enum List of actions performed through m2mb_mqtt_conf API.

Enumerator
M2MB_MQTT_SET_CLIENT_ID	To set client id of the device. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) ); or m2mb_mqtt_conf_( p_mqtt, M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" );
M2MB_MQTT_SET_TIMEOUT_MS	To set Timeout for MQTT operations in milliseconds. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
M2MB_MQTT_SECURE_OPT	To enable SSL and set SSL configurations. If this is not set, SSL is not enabled. M2MB_SSL_CONFIG_HANDLE sslConfigHndl; M2MB_SSL_CTXT_HANDLE sslCtxtHndl; Get sslConfigHndl and sslCtxtHndl using m2mb_ssl_create_config, m2mb_ssl_create_ctxt API respectively Perform required SSL configurations. m2mb_mqtt_conf(p_mqtt, CMDS(M2MB_MQTT_SECURE_OPT, sslConfigHndl, sslCtxtHndl));
M2MB_MQTT_SET_KEEPALIVE_SEC	To set keep alive interval of the connection in seconds m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
M2MB_MQTT_SET_CLEAN_SESSION	Set clean session flag that will be used by the MQTT core. User has to specify value to be set. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLEAN_SESSION, 1 ) );
M2MB_MQTT_SET_PROTOCOL_LEVEL	Set MQTT Protocol level: Protocol version: 4=v3.1.1 (default), 5=v5.0 m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PROTOCOL_LEVEL, 4 ) );
M2MB_MQTT_SET_LAST_WILL	Set MQTT Protocol will flag that will be used by the MQTT core. If third parameter is 1, Optional Last will and testament will be enabled. In that case also give the following parameters: Fourth parameter is the variable containing the will QoS value to be set. Fifth parmeter is the variable containing the will retain value to be set. Sixth parmeter is the variable containing the will topic string to be set. Seventh parmeter is the variable containing the will message string to be set. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_LAST_WILL, 1, MQTT_QOS_1, 1, "things/topic1", "Will Message" ) );
M2MB_MQTT_SET_USERNAME	Set the MQTT client username that will be used by the MQTT core. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
M2MB_MQTT_SET_PASSWORD	The MQTT client username that will be used by the MQTT core. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
M2MB_MQTT_SET_DISCONNECT_CALLBACK	To set Disconnect callback. static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata ); { (void)handle; switch(event) { case M2MB_MQTT_INDICATION_DISCONNECT: printf("Disconnect Callback: event = %d", event); break; default : printf("default case"); break; } } m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_DISCONNECT_CALLBACK, m2mb_mqtt_ind_callback, NULL ) );
M2MB_MQTT_SET_PDP_CONTEXT	To set pdp conetxt to be used for the MQTT client. m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PDP_CONTEXT, 2 ) );
M2MB_MQTT_GET_CLIENT_ID	To retrieve client id of the device configured by the user. UINT8* cid; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_GET_CLIENT_ID, &cid ) ); printf("Cid = %s", cid);
M2MB_MQTT_GET_TIMEOUT_MS	To retrieve timeout of the MQTT operations in milliseconds. UINT32 timeout; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, &timeout ) ); printf("timeout = %d ms", timeout);
M2MB_MQTT_GET_KEEPALIVE_SEC	To retrieve Keepalive interval in seconds. UINT32 keepalive; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, &keepalive ) ); printf("keepalive = %d ms", keepalive);
M2MB_MQTT_GET_CLEAN_SESSION	To retrieve configured clean session flag that will be used by the MQTT core. UINT8 clean_session; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLEAN_SESSION, &clean_session ) ); printf("clean session = %d", clean_session);
M2MB_MQTT_GET_PROTOCOL_LEVEL	To retrieve MQTT protocol version as configured by the user. UINT32 version; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_GET_PROTOCOL_LEVEL, &version ) ); printf("protocol version = %d", version);
M2MB_MQTT_GET_LAST_WILL	To retrieve Last will and testament settings used by MQTT core UINT8 will; M2MB_MQTT_QOS_E qos; UINT8 retain; UINT8* topic; UINT8* message; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_GET_LAST_WILL, &will, &qos, &retain, &topic, &message ) ); printf("last will = %d\r\n", will); printf("will qos = %d\r\n", qos); printf("will retain = %d\r\n", retain); printf("will topic = %s\r\n", topic); printf("will message = %s\r\n", message);
M2MB_MQTT_GET_PDP_CONTEXT	To retrieve pdp conetxt to be used for the MQTT client. UINT8* pdp; m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_GET_PDP_CONTEXT, &pdp ) ); printf("pdp = %d", pdp);

M2MB_MQTT_QOS_E

enum M2MB_MQTT_QOS_E

MQTT QoS Enum.

Enumerator
M2MB_MQTT_QOS_0	At most once delivery
M2MB_MQTT_QOS_1	At least once delivery
M2MB_MQTT_QOS_2	Exactly once delivery

M2MB_MQTT_RESPONSE_E

enum M2MB_MQTT_RESPONSE_E

MQTT APIs response enum.

Enumerator
M2MB_MQTT_SUCCESS	Response is success
M2MB_MQTT_ERROR_BAD_ARG	Bad argument was passed by the user
M2MB_MQTT_ERROR_OUT_OF_BUFFER	Out of buffer
M2MB_MQTT_ERROR_MALFORMED_DATA	Malformed Data
M2MB_MQTT_ERROR_PACKET_TYPE	Wrong packet type
M2MB_MQTT_ERROR_PACKET_ID	Wrong packet Id
M2MB_MQTT_ERROR_TLS_CONNECT	Error in TCP connection
M2MB_MQTT_ERROR_TIMEOUT	Timeout occurred
M2MB_MQTT_ERROR_NETWORK	Error in Network
M2MB_MQTT_ERROR_MEMORY	Out of Memory
M2MB_MQTT_ERROR_STAT	Error in Stats
M2MB_MQTT_ERROR_PROPERTY	Error in Properties
M2MB_MQTT_ERROR_SERVER_PROP	Error in Server Properties
M2MB_MQTT_ERROR_CALLBACK	Callback Error
M2MB_MQTT_ERROR_TOPIC_LIST	Error related to list of subscribed topics
M2MB_MQTT_ERROR_ASYNC_THREAD	Error inAsync thread
M2MB_MQTT_CONTINUE	MQTT Continue
M2MB_MQTT_STDIN_WAKE	MQTT STDIN Wake

M2MB_MQTT_RX_STATUS_E

enum M2MB_MQTT_RX_STATUS_E

MQTT Receive Data Status Enum.

Enumerator
M2MB_MQTT_RX_FINISHED	Entire data is received
M2MB_MQTT_RX_MORE_DATA	Partial data is pending

M2MB_MQTT_STATUS_E

enum M2MB_MQTT_STATUS_E

mqtt client status enum

Enumerator
M2MB_MQTT_NOT_CONNECTED	Client is initialized but not connected
M2MB_MQTT_CLIENT_CONNECTED	Client performed MQTT authentication with broker
M2MB_MQTT_CONN_RESET_BY_PEER	Connection closed or reset by the server
M2MB_MQTT_PINGREQ_TIMEOUT_FAIL	The answer to the ping request packet was not received
M2MB_MQTT_CONNACK_TIMEOUT	The CONNACK packet was not received
M2MB_MQTT_CONNECT_TIMEOUT	The CONNECT packet was not delivered
M2MB_MQTT_FATAL_ERROR	Failure in the m2mb APIs
M2MB_MQTT_NETWORK_ERROR	Socket timeout or read error
M2MB_MQTT_STATUS_UNKNOWN	Unknown state or client not initialized

Function Documentation

m2mb_mqtt_conf()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_conf	(	M2MB_MQTT_HANDLE	Handle,
		UINT8	nCmds,
			...
	)

m2mb_mqtt_conf sets/gets some MQTT parameters and configurations.

m2mb_mqtt_conf sets/gets MQTT parameters listed in the M2MB_MQTT_ACTION_E enum. These are to be performed before m2mb_mqtt_connect.

Parameters

[in]	Handle	handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.
[in]	argc	determines the number of parameters that follows
[in]	action	(among the ones listed in M2MB_MQTT_ACTION_E), while the parameters that follow depend on the action (see following note for further details)

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Action: M2MB_MQTT_SET_CLIENT_ID refer m2mb_mqtt_conf_ to avoid specifiying number of arguments or without using CMDS

Description: set the Unique clinet ID in order to connect to the MQTT broker. This setting could be performed only before m2mb_mqtt_connect.

Params(in): h(M2MB_MQTT_HANDLE), action(M2MB_MQTT_ACTION_E), format(UINT8*)

• example: set the CId 2

m2mb_mqtt_conf_( h, M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ); or m2mb_mqtt_conf( h, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );

Example

static void m2mb_mqtt_ind_callback(M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_connect()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_connect	(	M2MB_MQTT_HANDLE	Handle,
		const CHAR *	host,
		UINT32	port
	)

m2mb_mqtt_connect is called to connect to the specified MQTT broker.

m2mb_mqtt_connect performs MQTT connection to the URL specified in host.

Parameters

[in]	Handle	handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.
[in]	host	URL of the remote MQTT Broker that MQTT client needs to connect.(Ex: "api-dev.devicewise.com")
[in]	port	Port number of the remote MQTT Broker that MQTT client needs to connect.(Ex: 1883)

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_deinit()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_deinit

(

M2MB_MQTT_HANDLE

Handle

)

m2mb_mqtt_deinit deinitializes MQTT service for specified MQTT client.

m2mb_mqtt_deinit deinitialize MQTT service for specified MQTT client releasing the resources associated with the handle as first parameter. Calling the m2mb_mqtt_deinit is needed after having completed the usage of MQTT service to release reserved memory

Parameters

[in]

Handle

handle to the MQTT client service, that will be deinitialized by the function.

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if ( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_disconnect()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_disconnect

(

M2MB_MQTT_HANDLE

Handle

)

m2mb_mqtt_disconnect is called to disconnect from the MQTT broker.

m2mb_mqtt_disconnect disconnects the specified MQTT client from the Broker.

Parameters

[in]

Handle

handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_getClientStatus()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_getClientStatus	(	M2MB_MQTT_HANDLE	handle,
		M2MB_MQTT_STATUS_E *	status
	)

m2mb_mqtt_getClientStatus gets MQTT client current status

This function allows to retrieve current status of the specified client.

Parameters

[in]	handle	handle of the mqtt client
[out]	status	pointer to the variable that will be filled with current client status (refer to M2MB_MQTT_STATUS_E enum)

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
  M2MB_MQTT_STATUS_E status;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  m2mb_mqtt_getClientStatus( p_mqtt, &status );
  if(status == M2MB_MQTT_NOT_CONNECTED)
  {
    printf("Client is initialized but not connected");
  }
 
  //... Use MQTT APIs ....
}

m2mb_mqtt_init()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_init	(	M2MB_MQTT_HANDLE *	h,
		m2mb_mqtt_ind_callback	callback,
		void *	userdata
	)

m2mb_mqtt_init is called to initialize MQTT context.

m2mb_mqtt_init initialize MQTT client context returning the handle that must be passed as first parameter for all MQTT actions. Calling the m2mb_mqtt_init is mandatory before using the MQTT client service. It should be called once for each MQTT client.

Parameters

[out]	pHandle	pointer to MQTT context handle that is is initialized by the function. This is to be used in subsequent MQTT APIs.
[out]	callback	callback that will be called if client receives an event. (ex: server disconnect the client and disconnect event is triggered)
[out]	userdata	a pointer to generic user data that will be returned as it is in the callback.

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
 
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //... Use MQTT APIs ....
}

m2mb_mqtt_ping()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_ping

(

M2MB_MQTT_HANDLE

Handle

)

m2mb_mqtt_ping is called to ping

m2mb_mqtt_ping is called to ping the remote MQTT broker

Parameters

[in]

Handle

handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  result = m2mb_mqtt_ping( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_ping succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_publish()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_publish	(	M2MB_MQTT_HANDLE	Handle,
		M2MB_MQTT_QOS_E	qos,
		UINT8	retain,
		UINT16	message_id,
		const CHAR *	topic,
		const CHAR *	data,
		UINT32	data_len
	)

m2mb_mqtt_publish is called to Publishes a message to the MQTT broker.

m2mb_mqtt_publish Publishes a message on a given topic.

Parameters

[in]	Handle	handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function
[in]	qos	Integer value 0, 1, or 2 indicating the QOS to be used for msg.
[in]	retain	Set to TRUE to make the message retained
[in]	message_id	Message ID of the MQTT message
[in]	topic	Topic name
[in]	data	MQTT Message payload data
[in]	data_len	Data length

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  result = m2mb_mqtt_publish( p_mqtt, 0, 0, 10, "things/aabbcc/property/temp", "123", 3 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_publish succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_setClientStatus()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_setClientStatus	(	M2MB_MQTT_HANDLE	handle,
		M2MB_MQTT_STATUS_E	status
	)

m2mb_mqtt_setClientStatus sets MQTT client current status

This function allows to set current status of the specified client.

Parameters

[in]	Handle	handle of the mqtt client
[in]	status	set as current client status (refer to M2MB_MQTT_STATUS_E enum)

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  result = m2mb_mqtt_setClientStatus( p_mqtt, M2MB_MQTT_NOT_CONNECTED );
  if(result == M2MB_MQTT_SUCCESS)
  {
    printf("Client status set successfully");
  }
 
   //... Use MQTT APIs ....
}

m2mb_mqtt_subscribe()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_subscribe	(	M2MB_MQTT_HANDLE	Handle,
		UINT16	message_id,
		UINT32	topic_count,
		M2MB_MQTT_TOPIC_T *	pTopics
	)

m2mb_mqtt_subscribe is called to Subscribe.

m2mb_mqtt_subscribe Subscribes to one or multiple topics.

Parameters

[in]	Handle	handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.
[in]	message_id	Message ID of the MQTT message
[in]	topic_count	Number of topics to be subscribed
[in]	topics	Contiguous list of topics to subscribe to

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
 
static void mqtt_topic_cb( M2MB_MQTT_HANDLE handle, void* arg, const CHAR* topic, UINT16 topic_length, const CHAR* msg, UINT32 msg_length, M2MB_MQTT_RX_STATUS_E status )
{
  UINT8 buf[1024];
  memcpy(buf, topic, topic_length);
  buf[topic_length] = '\0'; // Make sure its null terminated
 
  printf("MQTT Message: Topic %s, Len %d\r\n", buf, msg_length);
 
  memcpy(buf, msg, msg_length);
  buf[msg_length] = '\0'; // Make sure its null terminated
  printf("Message: %s",  buf);
 
  if(status == M2MB_MQTT_RX_MORE_DATA)
  {
    printf("More data to be received");
  }
}
 
 
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  result = m2mb_mqtt_publish( p_mqtt, 0, 0, 10, "things/aabbcc/property/temp", "123", 3 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_publish succeeded");
  }
 
  M2MB_MQTT_TOPIC_T topics[2] = {0};
 
  CHAR* topic1 = "things/topic1";
  CHAR* topic2 = "things/topic2";
 
  topics[0].topic_filter = topic1;
  topics[0].qos = 0;
  topics[0].cb = mqtt_topic_cb;
 
  topics[1].topic_filter = topic2;
  topics[1].qos = 1;
  topics[1].cb = mqtt_topic_cb;
 
  result = m2mb_mqtt_subscribe( p_mqtt, 11, 2, topics );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_subscribe succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}

m2mb_mqtt_unsubscribe()

M2MB_MQTT_RESPONSE_E m2mb_mqtt_unsubscribe	(	M2MB_MQTT_HANDLE	Handle,
		UINT16	message_id,
		UINT32	topic_count,
		M2MB_MQTT_TOPIC_T *	topics
	)

MqttClient_Unsubscribe is called to unsubscribe.

MqttClient_Unsubscribe unsubscribes to one or multiple topics.

Parameters

[in]	Handle	handle to the MQTT client service, previously initialized by the m2mb_mqtt_init function.
[in]	message_id	Message ID of the MQTT message
[in]	topic_count	Number of topics to be subscribed
[in]	topics	Contiguous list of topics to unsubscribe to

Returns

M2MB_MQTT_RESPONSE_E values.

Note

Example

static void m2mb_mqtt_ind_callback( M2MB_MQTT_HANDLE Handle, M2MB_MQTT_IND_E event, UINT16 resp_size, void *resp, void *userdata );
{
  (void)handle;
  switch(event)
  {
    case M2MB_MQTT_INDICATION_DISCONNECT:
      printf("Disconnect Callback: event =  %d", event);
    break;
    default :
      printf("default case");
    break;
  }
}
void main(void)
{
  M2MB_MQTT_HANDLE* p_mqtt = NULL;
  M2MB_MQTT_RESPONSE_E result = 0;
 
  result = m2mb_mqtt_init( p_mqtt, m2mb_mqtt_ind_callback, NULL );
  if(result != M2MB_MQTT_SUCCESS)
  {
    return;
  }
  else
  {
    printf("m2mb_mqtt_init succeeded");
  }
 
  //Set Client ID
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_CLIENT_ID, "MQTT_demo" ) );
 
  //Set Timeout in milliseconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_TIMEOUT_MS, 10*1000 ) );
 
  //Set Keepalive in seconds
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_KEEPALIVE_SEC, 60 ) );
 
  //Set Username
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_USERNAME, "aabbcc" ) );
 
  //Set Password
  m2mb_mqtt_conf( p_mqtt, CMDS( M2MB_MQTT_SET_PASSWORD, "1234567890" ) );
 
  result = m2mb_mqtt_connect( p_mqtt, "api-dev.devicewise.com", 1883 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_connect succeeded");
  }
 
  result = m2mb_mqtt_publish( p_mqtt, 0, 0, 10, "things/aabbcc/property/temp", "123", 3 );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_publish succeeded");
  }
 
  M2MB_MQTT_TOPIC_T topics[2] = {0};
 
  CHAR* topic1 = "things/topic1";
  CHAR* topic2 = "things/topic2";
 
  topics[0].topic_filter = topic1;
  topics[0].qos = 0;
 
  topics[1].topic_filter = topic2;
  topics[1].qos = 1;
 
  result = m2mb_mqtt_subscribe( p_mqtt, 11, 2, topics );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_subscribe succeeded");
  }
 
  //... Use MQTT APIs ....
 
  result = m2mb_mqtt_unsubscribe( p_mqtt, 11, 2, topics );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_unsubscribe succeeded");
  }
 
  result = m2mb_mqtt_disconnect( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_disconnect succeeded");
  }
 
  result = m2mb_mqtt_deinit( p_mqtt );
  if( result == M2MB_MQTT_SUCCESS )
  {
    printf( "m2mb_mqtt_deinit succeeded");
  }
 
}