Embedded MQTT client#

Functions#

int32_t

rsi_emb_mqtt_client_init(int8_t *server_ip, uint32_t server_port, uint32_t client_port, uint16_t flags, uint16_t keep_alive_interval, int8_t *clientid, int8_t *username, int8_t *password)

Create MQTT objects. TCP level connection happens in this API. This is a blocking API.

int32_t

rsi_emb_mqtt_connect(uint8_t mqtt_flags, int8_t *will_topic, uint16_t will_message_len, int8_t *will_message)

Connect to MQTT Server/Broker. MQTT level connection happens in this API. This is a blocking API.

int32_t

rsi_emb_mqtt_publish(int8_t *topic, rsi_mqtt_pubmsg_t *publish_msg)

Publish the given message on the topic specified. This is a blocking API.

int32_t

rsi_emb_mqtt_subscribe(uint8_t qos, int8_t *topic)

Subscribe to the topic specified. Thus, MQTT client will receive any data that is published on this topic. This is a blocking API.

int32_t

rsi_emb_mqtt_unsubscribe(int8_t *topic)

Unsubscribe to the topic specified.Thus, MQTT client will not receive any data published on this topic. This is a blocking API.

int32_t

rsi_emb_mqtt_disconnect()

Disconnect the client from MQTT Server/Broker. TCP and MQTT level disconnection take place here. This is a blocking API.

int32_t

rsi_emb_mqtt_destroy()

Delete MQTT clients profile configuration. TCP level disconnection happens here, if required. This is a blocking API.

int32_t

rsi_emb_mqtt_register_call_back(uint32_t callback_id, void(*call_back_handler_ptr)(uint16_t status, uint8_t *buffer, const uint32_t length))

int32_t

rsi_cal_mqtt_packet_len(int32_t rem_len)

Adjusted length of MQTT packet. This is a non-blocking API.

Function Documentation#

rsi_emb_mqtt_client_init#

int32_t rsi_emb_mqtt_client_init (int8_t * server_ip, uint32_t server_port, uint32_t client_port, uint16_t flags, uint16_t keep_alive_interval, int8_t * clientid, int8_t * username, int8_t * password)

Create MQTT objects. TCP level connection happens in this API. This is a blocking API.

Parameters

[in]	server_ip	- MQTT client keep alive interval
[in]	server_port	- client_id of MQTT_client which should be unique for different clients.
[in]	client_port	- user_name of the MQTT_client which is a credential for logging to MQTT_server as an authentication
[in]	flags	- Password of the MQTT_client which is also credential for MQTT_server as an authentication
N/A	keep_alive_interval
N/A	clientid
N/A	username
N/A	password

rsi_config_ipaddress() API needs to be called before this API.


Flags	Description
BIT(0) - Clean Session	1 - Enable clean session for clearing the historic data
0 - Disable clean session
BIT(1) - SSL flag	1 - SSL Enable
0 - SSL Disable
BIT(2) - Server IP version	1 - IPV6
0 - IPV4

Returns

Zero - Success Negative Value - Failure -2 - Invalid parameters -3 - Command given in wrong state -4 - Packet allocation failure -5 - Command not supported -32 - Network command in progress -44 - Parameter length exceeds maximum value

Note

Refer to Error Codes section for the description of the above error codes Error Codes.
MQTT is not supported when the module is operating in concurrent mode.

Definition at line 60 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_connect#

int32_t rsi_emb_mqtt_connect (uint8_t mqtt_flags, int8_t * will_topic, uint16_t will_message_len, int8_t * will_message)

Connect to MQTT Server/Broker. MQTT level connection happens in this API. This is a blocking API.

Parameters

[in]

mqtt_flags

- Network flags. Each bit in the flag has its own significance


Flags	Description
BIT(6) - pwdFlag	1 - Enable pwdFlag
0 - Disable pwdFlag
BIT(7) - usrFlag	1 - Enable usrFlag
0 - Disable usrFlag

[in]

will_topic

- Will topic that the MQTT client wants the MQTT Server to publish when disconnected unexpectedly.

[in]

will_message_len

- Length of will_message

[in]

will_message

- Will message issued by the MQTT_Server for a broken client.

rsi_emb_mqtt_client_init() API needs to be called before this API.

Note

will_topic and will_message are not supported and should be NULL.

Returns

Zero - Success Negative Value - Failure -3 - Command given in wrong state -4 - Packet allocation failure -5 - Command not supported -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.
For connecting Embedded_MQTT(emb_mqtt) over SSL : Enable TCP_IP_FEAT_SSL in Opermode parameters as below #define RSI_TCP_IP_FEATURE_BIT_MAP (TCP_IP_FEAT_DHCPV4_CLIENT | TCP_IP_FEAT_SSL | TCP_IP_FEAT_DNS_CLIENT) Load the related SSL Certificates in the module using rsi_wlan_set_certificate() API.

Definition at line 241 of file network/protocols/rsi_emb_mqtt_client.c

References UNUSED_PARAMETER , RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_publish#

int32_t rsi_emb_mqtt_publish (int8_t * topic, rsi_mqtt_pubmsg_t * publish_msg)

Publish the given message on the topic specified. This is a blocking API.

Parameters

[in]	topic	- Topic string on which MQTT client wants to publish data
[in]	publish_msg	- Publish message

rsi_emb_mqtt_connect() API needs to be called before this API.

Returns

Zero - Success Negative Value - Failure -5 - Command not supported -2 - Invalid parameters -3 - Command given in wrong state -4 - Packet allocation failure -44 - Parameter length exceeds maximum value -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.

Definition at line 347 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , rsi_mqtt_pubmsg_s::qos , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_subscribe#

int32_t rsi_emb_mqtt_subscribe (uint8_t qos, int8_t * topic)

Subscribe to the topic specified. Thus, MQTT client will receive any data that is published on this topic. This is a blocking API.

Parameters

[in]	qos	- Quality of service of message at MQTT protocol level. Valid values are 0, 1, 2.
[in]	topic	- Topic string on which MQTT client wants to subscribe.

rsi_emb_mqtt_connect() API needs to be called before this API.

Returns

Zero - Success Negative Value - Failure -5 - Command not supported -2 - Invalid parameters -3 - Command given in wrong state -4 - Packet allocation failure -44 - Parameter length exceeds maximum value -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.

Definition at line 483 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_unsubscribe#

int32_t rsi_emb_mqtt_unsubscribe (int8_t * topic)

Unsubscribe to the topic specified.Thus, MQTT client will not receive any data published on this topic. This is a blocking API.

Parameters

[in]

topic

- Topic string to which MQTT client wants to unsubscribe.

rsi_emb_mqtt_connect() API needs to be called before this API.

Returns

Zero - Success Negative Value - Failure -5 - Command not supported -2 - Invalid parameters -3 - Command given in wrong state -4 - Packet allocation failure -44 - Parameter length exceeds maximum value -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.

Definition at line 592 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_disconnect#

int32_t rsi_emb_mqtt_disconnect ( Void)

Disconnect the client from MQTT Server/Broker. TCP and MQTT level disconnection take place here. This is a blocking API.

Parameters

[in] Void

rsi_emb_mqtt_connect() API needs to be called before this API.

Returns

Zero - Success Negative Value - Failure -5 - Command not supported -3 - Command given in wrong state -4 - Packet allocation failure -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.

Definition at line 698 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_destroy#

int32_t rsi_emb_mqtt_destroy ( Void)

Delete MQTT clients profile configuration. TCP level disconnection happens here, if required. This is a blocking API.

Parameters

[in] Void

rsi_emb_mqtt_client_init() API needs to be called before this API, based on requirement.This API can also be issued after rsi_emb_mqtt_disconnect() API.

Returns

Zero - Success Negative Value - Failure -5 - Command not supported -3 - Command given in wrong state -4 - Packet allocation failure -32 - Network command in progress

Note

Refer to Error Codes section for the description of the above error codes Error Codes.

Definition at line 786 of file network/protocols/rsi_emb_mqtt_client.c

References RSI_SUCCESS , SL_PRINTF , rsi_driver_cb_s::wlan_cb , rsi_wlan_cb_s::opermode , rsi_wlan_cb_s::state , and rsi_check_and_update_cmd_state

rsi_emb_mqtt_register_call_back#

int32_t rsi_emb_mqtt_register_call_back (uint32_t callback_id, void(*)(uint16_t status, uint8_t *buffer, const uint32_t length) call_back_handler_ptr, status, buffer, length)

Parameters

[in]	callback_id	- Callback id for MQTT responses
[in]	call_back_handler_ptr	- Callback function pointer
[out]	status	- Success - RSI_SUCCESS Failure - Possible error codes are : 0x0030, 0x0036, 0x0065, 0xBBF1, 0xBBF2, 0xBBF3, 0xFFF6
[out]	buffer	- Pointer to buffer which hold data
[out]	length	- Length of the buffer

Returns

Status of the call_back_handler_ptr is returned

Definition at line 866 of file network/protocols/rsi_emb_mqtt_client.c

References SL_PRINTF , rsi_wlan_cb_non_rom_s::nwk_callbacks , rsi_nwk_callback_s::rsi_emb_mqtt_remote_terminate_handler , rsi_nwk_callback_s::rsi_emb_mqtt_publish_message_callback , rsi_nwk_callback_s::rsi_emb_mqtt_keep_alive_timeout_callback , and RSI_SUCCESS

rsi_cal_mqtt_packet_len#

int32_t rsi_cal_mqtt_packet_len (int32_t rem_len)

Adjusted length of MQTT packet. This is a non-blocking API.

Parameters

[in]

rem_len

- Length

Returns

adjusted rem_len - Success

Definition at line 905 of file network/protocols/rsi_emb_mqtt_client.c