README.md
1# ESP-MQTT SSL Sample application
2
3(See the README.md file in the upper level 'examples' directory for more information about examples.)
4
5This example connects to the broker mqtt.eclipseprojects.io using ssl transport and as a demonstration subscribes/unsubscribes and send a message on certain topic.
6(Please note that the public broker is maintained by the community so may not be always available, for details please see this [disclaimer](https://iot.eclipse.org/getting-started/#sandboxes))
7
8It uses ESP-MQTT library which implements mqtt client to connect to mqtt broker.
9
10## How to use example
11
12### Hardware Required
13
14This example can be executed on any ESP32 board, the only required interface is WiFi and connection to internet.
15
16### Configure the project
17
18* Open the project configuration menu (`idf.py menuconfig`)
19* Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.
20* When using Make build system, set `Default serial port` under `Serial flasher config`.
21
22PEM certificate for this example could be extracted from an openssl `s_client` command connecting to mqtt.eclipseprojects.io.
23In case a host operating system has `openssl` and `sed` packages installed, one could execute the following command to download and save the root certificate to a file (Note for Windows users: Both Linux like environment or Windows native packages may be used).
24```
25echo "" | openssl s_client -showcerts -connect mqtt.eclipseprojects.io:8883 | sed -n "1,/Root/d; /BEGIN/,/END/p" | openssl x509 -outform PEM >mqtt_eclipse_org.pem
26```
27Please note that this is not a general command for downloading a root certificate for an arbitrary host;
28this command works with mqtt.eclipseprojects.io as the site provides root certificate in the chain, which then could be extracted
29with text operation.
30
31### Build and Flash
32
33Build the project and flash it to the board, then run monitor tool to view serial output:
34
35```
36idf.py -p PORT flash monitor
37```
38
39(To exit the serial monitor, type ``Ctrl-]``.)
40
41See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
42
43## Example Output
44
45```
46I (3714) event: sta ip: 192.168.0.139, mask: 255.255.255.0, gw: 192.168.0.2
47I (3714) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE
48I (3964) MQTT_CLIENT: Sending MQTT CONNECT message, type: 1, id: 0000
49I (4164) MQTTS_EXAMPLE: MQTT_EVENT_CONNECTED
50I (4174) MQTTS_EXAMPLE: sent publish successful, msg_id=41464
51I (4174) MQTTS_EXAMPLE: sent subscribe successful, msg_id=17886
52I (4174) MQTTS_EXAMPLE: sent subscribe successful, msg_id=42970
53I (4184) MQTTS_EXAMPLE: sent unsubscribe successful, msg_id=50241
54I (4314) MQTTS_EXAMPLE: MQTT_EVENT_PUBLISHED, msg_id=41464
55I (4484) MQTTS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=17886
56I (4484) MQTTS_EXAMPLE: sent publish successful, msg_id=0
57I (4684) MQTTS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=42970
58I (4684) MQTTS_EXAMPLE: sent publish successful, msg_id=0
59I (4884) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19
60I (4884) MQTTS_EXAMPLE: MQTT_EVENT_DATA
61TOPIC=/topic/qos0
62DATA=data
63I (5194) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19
64I (5194) MQTTS_EXAMPLE: MQTT_EVENT_DATA
65TOPIC=/topic/qos0
66DATA=data
67```
68
69