|
1 | 1 | menu "MQTT"
|
2 | 2 |
|
3 |
| -choice MQTT_LIBRARY_CHOOSE |
4 |
| - prompt "Choose MQTT library" |
5 |
| - default MQTT_USING_ESP |
6 |
| - help |
7 |
| - Choose the MQTT library which you want to use. |
8 |
| - |
9 |
| - Currently we support ESP-MQTT and IBM-MQTT(paho). |
10 |
| - |
11 |
| -config MQTT_USING_ESP |
12 |
| - bool "ESP-MQTT(Recommended)" |
13 |
| -config MQTT_USING_IBM |
14 |
| - bool "IBM-MQTT(not recommended and will be removed at v3.4)" |
15 |
| -endchoice |
16 |
| - |
17 |
| -menu "IBM-MQTT(paho)" |
18 |
| - depends on MQTT_USING_IBM |
19 |
| - |
20 |
| -choice MQTT_VERSION |
21 |
| - prompt "MQTT version" |
22 |
| - default V3_1 |
23 |
| - help |
24 |
| - Current supported MQTT version. |
25 |
| - |
26 |
| -config V3_1 |
27 |
| - bool "V3.1" |
28 |
| -config V3_1_1 |
29 |
| - bool "V3.1.1" |
30 |
| -endchoice |
31 |
| - |
32 |
| -config DEFAULT_MQTT_VERSION |
33 |
| - int |
34 |
| - default 3 if V3_1 |
35 |
| - default 4 if V3_1_1 |
36 |
| - |
37 |
| -config MQTT_CLIENT_ID |
38 |
| - string "MQTT client ID" |
39 |
| - default "espressif_sample" |
40 |
| - help |
41 |
| - MQTT client ID for MQTT broker to identify ESP device. |
42 |
| - |
43 |
| -config MQTT_KEEP_ALIVE |
44 |
| - int "MQTT keep-alive(seconds)" |
45 |
| - default 30 |
46 |
| - help |
47 |
| - MQTT keep alive interval, Recommended value: 30s - 60s. |
48 |
| - The last MQTT packet timestamp will be recorded, |
49 |
| - a PING request will be sent if (current_timestamp - last_mqtt_packet_timestamp) > MQTT_KEEP_ALIVE. |
50 |
| - |
51 |
| -config MQTT_USERNAME |
52 |
| - string "MQTT username" |
53 |
| - default "espressif" |
54 |
| - help |
55 |
| - Username used for logging to MQTT broker. |
56 |
| - Generally, you should use a valid MQTT_USERNAME if MQTT broker does not allow an anonymous login. |
57 |
| - |
58 |
| -config MQTT_PASSWORD |
59 |
| - string "MQTT password" |
60 |
| - default "admin" |
61 |
| - help |
62 |
| - Password used for logging to MQTT broker. |
63 |
| - Generally, you should use a valid MQTT_PASSWORD if MQTT broker does not allow an anonymous login. |
64 |
| - |
65 |
| -choice MQTT_SESSION |
66 |
| - prompt "MQTT Session" |
67 |
| - default CLEAN_SESSION |
68 |
| - help |
69 |
| - Clean session to start a new session. |
70 |
| - If clean-seesion is set, it will discard any previous session and start a new one. |
71 |
| - If keep-session is set, it will store session state and the communication can resume. |
72 |
| - |
73 |
| -config CLEAN_SESSION |
74 |
| - bool "Clean Session" |
75 |
| -config KEEP_SESSION |
76 |
| - bool "Keep Session" |
77 |
| -endchoice |
78 |
| - |
79 |
| -config DEFAULT_MQTT_SESSION |
80 |
| - int |
81 |
| - default 0 if KEEP_SESSION |
82 |
| - default 1 if CLEAN_SESSION |
83 |
| - |
84 |
| -choice MQTT_SECURITY |
85 |
| - prompt "MQTT over TCP/SSL/TLS feature" |
86 |
| - default NO_TLS |
87 |
| - help |
88 |
| - MQTT over TCP/SSL/TLS. |
89 |
| - MQTT_SECURITY=0: MQTT over TCP |
90 |
| - MQTT_SECURITY=1: MQTT over TLS with no verify |
91 |
| - MQTT_SECURITY=2: MQTT over TLS with verify peer |
92 |
| - MQTT_SECURITY=3: MQTT over TLS with verify client |
93 |
| - |
94 |
| -config NO_TLS |
95 |
| - bool "TCP" |
96 |
| -config TLS_VERIFY_NONE |
97 |
| - bool "TLS Verify None" |
98 |
| -config TLS_VERIFY_PEER |
99 |
| - bool "TLS Verify Peer" |
100 |
| -config TLS_VERIFY_CLIENT |
101 |
| - bool "TLS Verify Client" |
102 |
| -endchoice |
103 |
| - |
104 |
| -config DEFAULT_MQTT_SECURITY |
105 |
| - int |
106 |
| - default 0 if NO_TLS |
107 |
| - default 1 if TLS_VERIFY_NONE |
108 |
| - default 2 if TLS_VERIFY_PEER |
109 |
| - default 3 if TLS_VERIFY_CLIENT |
110 |
| - |
111 |
| -config MQTT_SEND_BUFFER |
112 |
| - int "MQTT send buffer" |
113 |
| - default 2048 |
114 |
| - help |
115 |
| - Recommended value: 1460 - 2048. |
116 |
| - Buffer used for sending MQTT messages, including MQTT header, MQTT topic, payload and etc. |
117 |
| - |
118 |
| -config MQTT_RECV_BUFFER |
119 |
| - int "MQTT recv buffer" |
120 |
| - default 2048 |
121 |
| - help |
122 |
| - Recommended value: 1460 - 2048. |
123 |
| - Buffer used for receiving MQTT messages, including MQTT header, MQTT topic, payload and etc. |
124 |
| - |
125 |
| -config MQTT_SEND_CYCLE |
126 |
| - int "MQTT send cycle(ms)" |
127 |
| - default 30000 |
128 |
| - help |
129 |
| - Recommended value: 30000 - 60000. |
130 |
| - MQTT send interval in every cycle. |
131 |
| - A MQTT packet should be sent out in MQTT_SEND_CYCLE, |
132 |
| - will block for MQTT_SEND_CYCLE if weak network, and return timeout. |
133 |
| - |
134 |
| -config MQTT_RECV_CYCLE |
135 |
| - int "MQTT recv cycle(ms)" |
136 |
| - default 0 |
137 |
| - help |
138 |
| - Recommended value: 0ms - 500ms. |
139 |
| - MQTT receive interval in every cycle. |
140 |
| - a MQTT packet should be received in MQTT_RECV_CYCLE, |
141 |
| - will block for MQTT_RECV_CYCLE if weak network , and return timeout. |
142 |
| - |
143 |
| -config MQTT_PING_TIMEOUT |
144 |
| - int "MQTT ping timeout(ms)" |
145 |
| - default 3000 |
146 |
| - help |
147 |
| - Recommended value: 3000ms - 10000ms. |
148 |
| - MQTT ping timeout. |
149 |
| - When MQTT_KEEP_ALIVE expired, it will start sending ping request. |
150 |
| - If the ESP device does not receive any ping response within MQTT_PING_TIMEOUT, |
151 |
| - it will terminate the MQTT connection. |
152 |
| - |
153 |
| -endmenu # IBM-MQTT(paho) |
154 |
| - |
155 |
| -menu "ESP-MQTT" |
156 |
| - depends on MQTT_USING_ESP |
157 |
| - |
158 | 3 | config MQTT_PROTOCOL_311
|
159 | 4 | bool "Enable MQTT protocol 3.1.1"
|
160 | 5 | default y
|
@@ -254,6 +99,5 @@ config MQTT_CUSTOM_OUTBOX
|
254 | 99 | help
|
255 | 100 | Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or similar).
|
256 | 101 |
|
257 |
| -endmenu # ESP-MQTT |
258 | 102 |
|
259 | 103 | endmenu
|
0 commit comments