esp-mqtt/lib/include/mqtt_config.h

/*
 * This file is subject to the terms and conditions defined in
 * file 'LICENSE', which is part of this source code package.
 * Tuan PM <tuanpm at live dot com>
 */
#ifndef _MQTT_CONFIG_H_
#define _MQTT_CONFIG_H_

#include "sdkconfig.h"

#ifdef CONFIG_MQTT_PROTOCOL_311
#define MQTT_PROTOCOL_311
#endif

#ifdef CONFIG_MQTT_PROTOCOL_5
#define MQTT_PROTOCOL_5
#endif

#define MQTT_RECON_DEFAULT_MS       (10*1000)
#define MQTT_POLL_READ_TIMEOUT_MS   (1000)

#define MQTT_MSG_ID_INCREMENTAL     CONFIG_MQTT_MSG_ID_INCREMENTAL

#define MQTT_SKIP_PUBLISH_IF_DISCONNECTED CONFIG_MQTT_SKIP_PUBLISH_IF_DISCONNECTED

#define MQTT_REPORT_DELETED_MESSAGES CONFIG_MQTT_REPORT_DELETED_MESSAGES

#if CONFIG_MQTT_BUFFER_SIZE
#define MQTT_BUFFER_SIZE_BYTE       CONFIG_MQTT_BUFFER_SIZE
#else
#define MQTT_BUFFER_SIZE_BYTE       1024
#endif

#if CONFIG_MQTT_TASK_PRIORITY
#define MQTT_TASK_PRIORITY          CONFIG_MQTT_TASK_PRIORITY
#else
#define MQTT_TASK_PRIORITY          5
#endif

#if CONFIG_MQTT_TASK_STACK_SIZE
#define MQTT_TASK_STACK             CONFIG_MQTT_TASK_STACK_SIZE
#else
#define MQTT_TASK_STACK             (6*1024)
#endif

#define MQTT_KEEPALIVE_TICK         (120)
#define MQTT_NETWORK_TIMEOUT_MS     (10000)

#ifdef CONFIG_MQTT_TCP_DEFAULT_PORT
#define MQTT_TCP_DEFAULT_PORT       CONFIG_MQTT_TCP_DEFAULT_PORT
#else
#define MQTT_TCP_DEFAULT_PORT       1883
#endif

#ifdef CONFIG_MQTT_SSL_DEFAULT_PORT
#define MQTT_SSL_DEFAULT_PORT       CONFIG_MQTT_SSL_DEFAULT_PORT
#else
#define MQTT_SSL_DEFAULT_PORT       8883
#endif

#ifdef CONFIG_MQTT_WS_DEFAULT_PORT
#define MQTT_WS_DEFAULT_PORT        CONFIG_MQTT_WS_DEFAULT_PORT
#else
#define MQTT_WS_DEFAULT_PORT        80
#endif

#ifdef CONFIG_MQTT_WSS_DEFAULT_PORT
#define MQTT_WSS_DEFAULT_PORT       CONFIG_MQTT_WSS_DEFAULT_PORT
#else
#define MQTT_WSS_DEFAULT_PORT       443
#endif

#define MQTT_CORE_SELECTION_ENABLED CONFIG_MQTT_TASK_CORE_SELECTION_ENABLED

#ifdef  CONFIG_MQTT_DISABLE_API_LOCKS
#define MQTT_DISABLE_API_LOCKS          CONFIG_MQTT_DISABLE_API_LOCKS
#endif

#ifdef CONFIG_MQTT_USE_CORE_0
#define MQTT_TASK_CORE    0
#else
#ifdef CONFIG_MQTT_USE_CORE_1
#define MQTT_TASK_CORE 1
#else
#define MQTT_TASK_CORE 0
#endif
#endif

#ifdef  CONFIG_MQTT_OUTBOX_EXPIRED_TIMEOUT_MS
#define OUTBOX_EXPIRED_TIMEOUT_MS   CONFIG_MQTT_OUTBOX_EXPIRED_TIMEOUT_MS
#else
#define OUTBOX_EXPIRED_TIMEOUT_MS   (30*1000)
#endif

#define MQTT_ENABLE_SSL             CONFIG_MQTT_TRANSPORT_SSL
#define MQTT_ENABLE_WS              CONFIG_MQTT_TRANSPORT_WEBSOCKET
#define MQTT_ENABLE_WSS             CONFIG_MQTT_TRANSPORT_WEBSOCKET_SECURE

#ifdef CONFIG_MQTT_EVENT_QUEUE_SIZE
#define MQTT_EVENT_QUEUE_SIZE       CONFIG_MQTT_EVENT_QUEUE_SIZE
#else
#define MQTT_EVENT_QUEUE_SIZE       1
#endif

#define OUTBOX_MAX_SIZE             (4*1024)
#endif
Add header license 2018-02-17 11:42:41 +07:00			`/*`
			`* This file is subject to the terms and conditions defined in`
			`* file 'LICENSE', which is part of this source code package.`
			`* Tuan PM <tuanpm at live dot com>`
			`*/`
Initial Project 2016-09-11 10:10:24 +07:00			`#ifndef _MQTT_CONFIG_H_`
			`#define _MQTT_CONFIG_H_`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00
			`#include "sdkconfig.h"`

MQTT: Add runtime selection of mqtt protocol version Add config option for selecting protocol version at runtime. This also fixed MQTT protocol version 3.1 which wasnt working with the original implementation Closes https://github.com/espressif/esp-idf/issues/4448 Closes IDFGH-2311 Closes IDF-1320 2020-01-09 11:50:40 +08:00			`#ifdef CONFIG_MQTT_PROTOCOL_311`
			`#define MQTT_PROTOCOL_311`
			`#endif`

mqtt: Support MQTT5 protocol 2022-02-25 10:12:30 +08:00			`#ifdef CONFIG_MQTT_PROTOCOL_5`
			`#define MQTT_PROTOCOL_5`
			`#endif`

Add reconnect time as a configurable parameter. Closes IDF-1126 2019-11-18 14:43:44 +08:00			`#define MQTT_RECON_DEFAULT_MS (10*1000)`
added mqtt api locks, so methods can be executed from user context closes #67, closes #90, closes https://github.com/espressif/esp-idf/issues/2975 2018-12-21 13:52:48 +01:00			`#define MQTT_POLL_READ_TIMEOUT_MS (1000)`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00
Config: Add a new option to use incremental message id This option is off by default, so the client still uses random message id unless CONFIG_MQTT_MSG_ID_INCREMENTAL is set Closes https://github.com/espressif/esp-mqtt/issues/176 2020-12-06 11:46:36 +01:00			`#define MQTT_MSG_ID_INCREMENTAL CONFIG_MQTT_MSG_ID_INCREMENTAL`

Config: Add a new option to disable publishing when disconnected Related https://github.com/espressif/esp-mqtt/pull/177 2020-12-06 14:08:45 +01:00			`#define MQTT_SKIP_PUBLISH_IF_DISCONNECTED CONFIG_MQTT_SKIP_PUBLISH_IF_DISCONNECTED`

Events: Add new event to report deleted messages from outbox 2020-12-06 15:23:08 +01:00			`#define MQTT_REPORT_DELETED_MESSAGES CONFIG_MQTT_REPORT_DELETED_MESSAGES`

Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00			`#if CONFIG_MQTT_BUFFER_SIZE`
			`#define MQTT_BUFFER_SIZE_BYTE CONFIG_MQTT_BUFFER_SIZE`
			`#else`
Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`#define MQTT_BUFFER_SIZE_BYTE 1024`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00			`#endif`

config: option to configure mqtt task priority 2020-03-17 13:34:27 +01:00			`#if CONFIG_MQTT_TASK_PRIORITY`
			`#define MQTT_TASK_PRIORITY CONFIG_MQTT_TASK_PRIORITY`
			`#else`
Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`#define MQTT_TASK_PRIORITY 5`
config: option to configure mqtt task priority 2020-03-17 13:34:27 +01:00			`#endif`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00
			`#if CONFIG_MQTT_TASK_STACK_SIZE`
			`#define MQTT_TASK_STACK CONFIG_MQTT_TASK_STACK_SIZE`
			`#else`
Add mqtt over ssl sample 2018-02-16 22:00:57 +07:00			`#define MQTT_TASK_STACK (6*1024)`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00			`#endif`

Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`#define MQTT_KEEPALIVE_TICK (120)`
			`#define MQTT_NETWORK_TIMEOUT_MS (10000)`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00
			`#ifdef CONFIG_MQTT_TCP_DEFAULT_PORT`
			`#define MQTT_TCP_DEFAULT_PORT CONFIG_MQTT_TCP_DEFAULT_PORT`
			`#else`
			`#define MQTT_TCP_DEFAULT_PORT 1883`
			`#endif`

			`#ifdef CONFIG_MQTT_SSL_DEFAULT_PORT`
			`#define MQTT_SSL_DEFAULT_PORT CONFIG_MQTT_SSL_DEFAULT_PORT`
			`#else`
			`#define MQTT_SSL_DEFAULT_PORT 8883`
			`#endif`

			`#ifdef CONFIG_MQTT_WS_DEFAULT_PORT`
			`#define MQTT_WS_DEFAULT_PORT CONFIG_MQTT_WS_DEFAULT_PORT`
			`#else`
			`#define MQTT_WS_DEFAULT_PORT 80`
			`#endif`

Fix WSS default port selection through menuconfig. Evaluate the correct define to select default port. - Closes https://github.com/espressif/esp-mqtt/issues/223 2022-05-16 11:48:42 -03:00			`#ifdef CONFIG_MQTT_WSS_DEFAULT_PORT`
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00			`#define MQTT_WSS_DEFAULT_PORT CONFIG_MQTT_WSS_DEFAULT_PORT`
			`#else`
			`#define MQTT_WSS_DEFAULT_PORT 443`
			`#endif`

Adding ESP32 core selection for MQTT task (#53) * Adding core selection in KConfig and starting thread with those parameters * Updating for code consistency 2018-07-25 08:58:38 +02:00			`#define MQTT_CORE_SELECTION_ENABLED CONFIG_MQTT_TASK_CORE_SELECTION_ENABLED`

added mqtt api locks, so methods can be executed from user context closes #67, closes #90, closes https://github.com/espressif/esp-idf/issues/2975 2018-12-21 13:52:48 +01:00			`#ifdef CONFIG_MQTT_DISABLE_API_LOCKS`
			`#define MQTT_DISABLE_API_LOCKS CONFIG_MQTT_DISABLE_API_LOCKS`
			`#endif`

Adding ESP32 core selection for MQTT task (#53) * Adding core selection in KConfig and starting thread with those parameters * Updating for code consistency 2018-07-25 08:58:38 +02:00			`#ifdef CONFIG_MQTT_USE_CORE_0`
Fixed formatting for all files to comply with idf style formats 2019-05-06 13:45:33 +02:00			`#define MQTT_TASK_CORE 0`
Adding ESP32 core selection for MQTT task (#53) * Adding core selection in KConfig and starting thread with those parameters * Updating for code consistency 2018-07-25 08:58:38 +02:00			`#else`
Fixed formatting for all files to comply with idf style formats 2019-05-06 13:45:33 +02:00			`#ifdef CONFIG_MQTT_USE_CORE_1`
			`#define MQTT_TASK_CORE 1`
			`#else`
			`#define MQTT_TASK_CORE 0`
			`#endif`
Adding ESP32 core selection for MQTT task (#53) * Adding core selection in KConfig and starting thread with those parameters * Updating for code consistency 2018-07-25 08:58:38 +02:00			`#endif`

config: Fix typo for configuring OUTBOX_EXPIRED_TIMEOUT_MS In esp-idf, it uses CONFIG_MQTT_OUTBOX_EXPIRED_TIMEOUT_MS rather than CONFIG_OUTBOX_EXPIRED_TIMEOUT_MS. Signed-off-by: Axel Lin <axel.lin@ingics.com> 2020-11-09 16:07:10 +08:00			`#ifdef CONFIG_MQTT_OUTBOX_EXPIRED_TIMEOUT_MS`
			`#define OUTBOX_EXPIRED_TIMEOUT_MS CONFIG_MQTT_OUTBOX_EXPIRED_TIMEOUT_MS`
mqtt: deleted expired messages even when offline As long as the client was disconnect no cleanup were performed, consuming memory for every message published. Even if they were already expired and would be discarded when reconnected. Also moves delete of expired msgs before retransmit is done. This avoids situtations where a message could be sent even if it was expired. Closes https://github.com/espressif/esp-idf/issues/5668 2020-08-10 15:47:46 +08:00			`#else`
			`#define OUTBOX_EXPIRED_TIMEOUT_MS (30*1000)`
			`#endif`
Adding ESP32 core selection for MQTT task (#53) * Adding core selection in KConfig and starting thread with those parameters * Updating for code consistency 2018-07-25 08:58:38 +02:00
Add Kconfig, make easy to custom configurations 2018-03-01 23:07:26 +07:00			`#define MQTT_ENABLE_SSL CONFIG_MQTT_TRANSPORT_SSL`
Add error handling for mqtt, fixed some issues 2018-05-03 21:50:24 +07:00			`#define MQTT_ENABLE_WS CONFIG_MQTT_TRANSPORT_WEBSOCKET`
			`#define MQTT_ENABLE_WSS CONFIG_MQTT_TRANSPORT_WEBSOCKET_SECURE`
Add support ws and wss 2018-02-17 01:03:35 +07:00
client: Add support for user events Also supporting configurable queue size for the internal event loop. Closes https://github.com/espressif/esp-mqtt/issues/230 2022-07-24 21:10:38 +02:00			`#ifdef CONFIG_MQTT_EVENT_QUEUE_SIZE`
			`#define MQTT_EVENT_QUEUE_SIZE CONFIG_MQTT_EVENT_QUEUE_SIZE`
			`#else`
Fix the default configuration for event queue - Event queue should be disabled, making it an opt-in feature. 2022-11-23 20:40:31 +08:00			`#define MQTT_EVENT_QUEUE_SIZE 1`
client: Add support for user events Also supporting configurable queue size for the internal event loop. Closes https://github.com/espressif/esp-mqtt/issues/230 2022-07-24 21:10:38 +02:00			`#endif`
mqtt: deleted expired messages even when offline As long as the client was disconnect no cleanup were performed, consuming memory for every message published. Even if they were already expired and would be discarded when reconnected. Also moves delete of expired msgs before retransmit is done. This avoids situtations where a message could be sent even if it was expired. Closes https://github.com/espressif/esp-idf/issues/5668 2020-08-10 15:47:46 +08:00
Add support ws and wss 2018-02-17 01:03:35 +07:00			`#define OUTBOX_MAX_SIZE (4*1024)`
Initial Project 2016-09-11 10:10:24 +07:00			`#endif`