Functions#

sl_mqtt_client_init#

sl_status_t sl_mqtt_client_init (sl_mqtt_client_t * client, sl_mqtt_client_event_handler_t event_handler)

Initialize the MQTT client and register the event handler.

This function initializes the MQTT client by setting up the event handler, and initializing the subscription list. It also assigns the provided client structure to the global MQTT client pointer.

Returns

• sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_WIFI_NULL_PTR_ARG: The event_handler pointer was NULL.

sl_mqtt_client_deinit#

sl_status_t sl_mqtt_client_deinit (sl_mqtt_client_t * client)

Deinitialize the MQTT client.

This function deinitializes the MQTT client by clearing its state and resetting the global MQTT client pointer. It ensures that the client is in a disconnected state before deinitializing.

• The MQTT client must be in the disconnected state before calling this function.

Returns

• sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_INVALID_STATE: The client is not in the disconnected state.

sl_mqtt_client_connect#

sl_status_t sl_mqtt_client_connect (sl_mqtt_client_t * client, const sl_mqtt_broker_t * broker, const sl_mqtt_client_last_will_message_t * last_will_message, const sl_mqtt_client_configuration_t * configuration, uint32_t timeout)

Connect the client to an MQTT broker.

This function connects the MQTT client to the specified broker using the provided configuration and last will message. It supports both synchronous, and asynchronous operations based on the timeout value.

• sl_mqtt_client_init should be called before this API.

Returns

• sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_IN_PROGRESS: Operation is in progress (for asynchronous calls).

  • SL_STATUS_INVALID_PARAMETER: One or more parameters are invalid.

  • SL_STATUS_FAIL: Operation failed.

Note

• In subsequent calls to connect, it is optional to provide broker, last_will_message, and configuration parameters. If broker and configuration parameters are assigned as NULL, the values are retains from the first connect() call. For the last_will_message parameter, values assigned in each connect() call are considered. If the last_will_message parameter value is NULL, no will message are sent to the broker. is_clean_session, credential_id, client_id, and client_id_length of sl_mqtt_client_configuration_t are consider. The topic length of the last_will_message must be less than SI91X_MQTT_CLIENT_WILL_TOPIC_MAXIMUM_LENGTH. The client ID length should be less than SI91X_MQTT_CLIENT_CLIENT_ID_MAXIMUM_LENGTH. The username and password length must be less than SI91X_MQTT_CLIENT_USERNAME_MAXIMUM_LENGTH and SI91X_MQTT_CLIENT_PASSWORD_MAXIMUM_LENGTH, respectively.

sl_mqtt_client_disconnect#

sl_status_t sl_mqtt_client_disconnect (sl_mqtt_client_t * client, uint32_t timeout)

Disconnect the client from the MQTT broker.

This function disconnects the MQTT client from the broker and deinitializes the client context. It supports synchronous, and asynchronous operations based on the timeout value. The function ensures that the client is in a valid state before attempting to disconnect.

• Synchronous Mode: If the timeout value is non-zero then, the function waits for the disconnect operation to complete within the specified timeout period.

• Asynchronous Mode: If the timeout value is zero then, the function returns immediately, and the results are provided via the sl_mqtt_client_event_handler_t callback.

• sl_mqtt_client_connect should be called before this API.

Returns

• sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_IN_PROGRESS: Operation is in progress (for asynchronous calls).

  • SL_STATUS_INVALID_PARAMETER: One or more parameters are invalid.

  • SL_STATUS_INVALID_STATE: The client is not in a valid state to disconnect.

  • SL_STATUS_FAIL: Operation failed.

Note

• The function deinitializes the MQTT client context after the disconnection. The client must be in one of the following states to call this function: SL_MQTT_CLIENT_CONNECTED, SL_MQTT_CLIENT_TA_DISCONNECTED, or SL_MQTT_CLIENT_CONNECTION_FAILED.

sl_mqtt_client_publish#

sl_status_t sl_mqtt_client_publish (sl_mqtt_client_t * client, const sl_mqtt_client_message_t * message, uint32_t timeout, void * context)

Publishes the message to the MQTT broker.

This function publishes a message to the specified topic of the MQTT broker. It supports both synchronous, and asynchronous operations based on the timeout value. The function ensures that the client is in the connected state before attempting to publish the message.

• sl_mqtt_client_connect should be called before this API.

Returns

• 
  sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_IN_PROGRESS: Operation is in progress (for asynchronous calls).

  • SL_STATUS_INVALID_PARAMETER: One or more parameters are invalid.

  • SL_STATUS_INVALID_STATE: The client is not in a valid state to publish.

  • SL_STATUS_ALLOCATION_FAILED: Memory allocation failed.

  • SL_STATUS_FAIL: Operation failed.

Note

• The maximum length of the topic must be less than SI91X_MQTT_CLIENT_TOPIC_MAXIMUM_LENGTH. The function allocates memory for the publish request, and free the space after the operation.

sl_mqtt_client_subscribe#

sl_status_t sl_mqtt_client_subscribe (sl_mqtt_client_t * client, const uint8_t * topic, uint16_t topic_length, sl_mqtt_qos_t qos_level, uint32_t timeout, sl_mqtt_client_message_received_t message_handler, void * context)

Subscribe a client to a specific topic on the MQTT broker.

This function subscribes the specified client to a given topic on the MQTT broker. It supports both synchronous, and asynchronous operations based on the timeout value. The function ensures that the client is in a connected state before attempting to subscribe to the topic.

• sl_mqtt_client_connect should be called before this API.

Returns

• 
  sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_IN_PROGRESS: Operation is in progress (for asynchronous calls).

  • SL_STATUS_INVALID_PARAMETER: One or more parameters are invalid.

  • SL_STATUS_INVALID_STATE: The client is not in a valid state to subscribe.

  • SL_STATUS_ALLOCATION_FAILED: Memory allocation failed.

  • SL_STATUS_FAIL: Operation failed.

Note

• The maximum length of the topic should be less than SI91X_MQTT_CLIENT_TOPIC_MAXIMUM_LENGTH.

sl_mqtt_client_unsubscribe#

sl_status_t sl_mqtt_client_unsubscribe (sl_mqtt_client_t * client, const uint8_t * topic, uint16_t topic_length, uint32_t timeout, void * context)

Unsubscribe a client from a specific topic on the MQTT broker.

This function unsubscribes the specified client from a given topic on the MQTT broker. It supports both synchronous, and asynchronous operations based on the timeout value. The function ensures that the client is in a connected state before attempting to unsubscribe from the topic.

• sl_mqtt_client_subscribe should be called before this API.

Returns

• 
  sl_status_t - Status of the operation. For more details, see https://docs.silabs.com/gecko-platform/latest/platform-common/status.

  • SL_STATUS_OK: Operation successful.

  • SL_STATUS_IN_PROGRESS: Operation is in progress (for asynchronous calls).

  • SL_STATUS_INVALID_PARAMETER: One or more parameters are invalid.

  • SL_STATUS_INVALID_STATE: The client is not in a valid state to unsubscribe.

  • SL_STATUS_ALLOCATION_FAILED: Memory allocation failed.

  • SL_STATUS_FAIL: Operation failed.

Note

• The maximum length of the topic must be less than SI91X_MQTT_CLIENT_TOPIC_MAXIMUM_LENGTH.