mirror of
https://github.com/alexandrebobkov/ESP-Nodes.git
synced 2025-10-27 04:44:57 +00:00
mqtt
This commit is contained in:
@@ -1,9 +0,0 @@
|
||||
# The following four lines of boilerplate have to be in your project's CMakeLists
|
||||
# in this exact order for cmake to work correctly
|
||||
cmake_minimum_required(VERSION 3.16)
|
||||
|
||||
|
||||
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||
# "Trim" the build. Include the minimal set of components, main, and anything it depends on.
|
||||
idf_build_set_property(MINIMAL_BUILD ON)
|
||||
project(mqtt_ssl_psk)
|
||||
@@ -1,78 +0,0 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C5 | ESP32-C6 | ESP32-C61 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | --------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# ESP-MQTT SSL example with PSK verification
|
||||
|
||||
(See the README.md file in the upper level 'examples' directory for more information about examples.)
|
||||
|
||||
This example connects to a local broker configured to PSK authentication
|
||||
|
||||
## How to use example
|
||||
|
||||
### Hardware Required
|
||||
|
||||
This example can be executed on any ESP32 board, the only required interface is WiFi (or ethernet) to connect to a MQTT
|
||||
broker with preconfigured PSK verification method.
|
||||
|
||||
#### Mosquitto settings
|
||||
In case of using mosquitto broker, here is how to enable PSK authentication in `mosquitto.config`,
|
||||
```
|
||||
psk_hint hint
|
||||
psk_file path_to_your_psk_file
|
||||
allow_anonymous true
|
||||
```
|
||||
Note: Last line enables anonymous mode, as this example does not use mqtt username and password.
|
||||
|
||||
PSK file then has to contain pairs of hints and keys, as shown below:
|
||||
```
|
||||
hint:BAD123
|
||||
```
|
||||
|
||||
Important note: Keys are stored as text hexadecimal values in PSK file, while the example code stores key as plain binary
|
||||
as required by MQTT API. (See the example source for details: `"BAD123" -> 0xBA, 0xD1, 0x23`)
|
||||
|
||||
### Configure the project
|
||||
|
||||
* Run `idf.py menuconfig`
|
||||
* 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.
|
||||
|
||||
### Build and Flash
|
||||
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
|
||||
|
||||
## Example Output
|
||||
|
||||
```
|
||||
I (2160) example_connect: Ethernet Link Up
|
||||
I (4650) example_connect: Connected to Ethernet
|
||||
I (4650) example_connect: IPv4 address: 192.168.0.1
|
||||
I (4650) MQTTS_EXAMPLE: [APP] Free memory: 244792 bytes
|
||||
I (4660) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE
|
||||
D (4670) MQTT_CLIENT: MQTT client_id=ESP32_c6B4F8
|
||||
D (4680) MQTT_CLIENT: Core selection disabled
|
||||
I (4680) MQTTS_EXAMPLE: Other event id:7
|
||||
D (4680) esp-tls: host:192.168.0.2: strlen 13
|
||||
D (4700) esp-tls: ssl psk authentication
|
||||
D (4700) esp-tls: handshake in progress...
|
||||
D (4720) MQTT_CLIENT: Transport connected to mqtts://192.168.0.2:8883
|
||||
I (4720) MQTT_CLIENT: Sending MQTT CONNECT message, type: 1, id: 0000
|
||||
D (4720) MQTT_CLIENT: mqtt_message_receive: first byte: 0x20
|
||||
D (4730) MQTT_CLIENT: mqtt_message_receive: read "remaining length" byte: 0x2
|
||||
D (4730) MQTT_CLIENT: mqtt_message_receive: total message length: 4 (already read: 2)
|
||||
D (4740) MQTT_CLIENT: mqtt_message_receive: read_len=2
|
||||
D (4750) MQTT_CLIENT: mqtt_message_receive: transport_read():4 4
|
||||
D (4750) MQTT_CLIENT: Connected
|
||||
I (4760) MQTTS_EXAMPLE: MQTT_EVENT_CONNECTED
|
||||
D (4760) MQTT_CLIENT: mqtt_enqueue id: 4837, type=8 successful
|
||||
D (4770) OUTBOX: ENQUEUE msgid=4837, msg_type=8, len=18, size=18
|
||||
D (4770) MQTT_CLIENT: Sent subscribe topic=/topic/qos0, id: 4837, type=8 successful
|
||||
I (4780) MQTTS_EXAMPLE: sent subscribe successful, msg_id=4837
|
||||
D (4790) MQTT_CLIENT: mqtt_enqueue id: 58982, type=8 successful
|
||||
D (4790) OUTBOX: ENQUEUE msgid=58982, msg_type=8, len=18, size=36
|
||||
D (4800) MQTT_CLIENT: Sent subscribe topic=/topic/qos1, id: 58982, type=8 successful
|
||||
I (4810) MQTTS_EXAMPLE: sent subscribe successful, msg_id=58982
|
||||
```
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
idf_component_register(SRCS "app_main.c"
|
||||
PRIV_REQUIRES mqtt esp_wifi nvs_flash
|
||||
INCLUDE_DIRS ".")
|
||||
@@ -1,151 +0,0 @@
|
||||
/* MQTT over SSL Example
|
||||
|
||||
This example code is in the Public Domain (or CC0 licensed, at your option.)
|
||||
|
||||
Unless required by applicable law or agreed to in writing, this
|
||||
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
||||
CONDITIONS OF ANY KIND, either express or implied.
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdint.h>
|
||||
#include <stddef.h>
|
||||
#include <string.h>
|
||||
#include "esp_wifi.h"
|
||||
#include "esp_system.h"
|
||||
#include "nvs_flash.h"
|
||||
#include "esp_event.h"
|
||||
#include "esp_netif.h"
|
||||
#include "protocol_examples_common.h"
|
||||
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "freertos/semphr.h"
|
||||
#include "freertos/queue.h"
|
||||
|
||||
#include "lwip/sockets.h"
|
||||
#include "lwip/dns.h"
|
||||
#include "lwip/netdb.h"
|
||||
|
||||
#include "esp_log.h"
|
||||
#include "mqtt_client.h"
|
||||
#include "esp_tls.h"
|
||||
|
||||
/*
|
||||
* Add here URI of mqtt broker which supports PSK authentication
|
||||
*/
|
||||
#define EXAMPLE_BROKER_URI "mqtts://192.168.0.2"
|
||||
|
||||
static const char *TAG = "mqtts_example";
|
||||
|
||||
/*
|
||||
* Define psk key and hint as defined in mqtt broker
|
||||
* example for mosquitto server, content of psk_file:
|
||||
* hint:BAD123
|
||||
*
|
||||
*/
|
||||
static const uint8_t s_key[] = { 0xBA, 0xD1, 0x23 };
|
||||
|
||||
static const psk_hint_key_t psk_hint_key = {
|
||||
.key = s_key,
|
||||
.key_size = sizeof(s_key),
|
||||
.hint = "hint"
|
||||
};
|
||||
|
||||
/*
|
||||
* @brief Event handler registered to receive MQTT events
|
||||
*
|
||||
* This function is called by the MQTT client event loop.
|
||||
*
|
||||
* @param handler_args user data registered to the event.
|
||||
* @param base Event base for the handler(always MQTT Base in this example).
|
||||
* @param event_id The id for the received event.
|
||||
* @param event_data The data for the event, esp_mqtt_event_handle_t.
|
||||
*/
|
||||
static void mqtt_event_handler(void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data)
|
||||
{
|
||||
ESP_LOGD(TAG, "Event dispatched from event loop base=%s, event_id=%" PRIi32 "", base, event_id);
|
||||
esp_mqtt_event_handle_t event = event_data;
|
||||
esp_mqtt_client_handle_t client = event->client;
|
||||
int msg_id;
|
||||
switch ((esp_mqtt_event_id_t)event_id) {
|
||||
case MQTT_EVENT_CONNECTED:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_CONNECTED");
|
||||
msg_id = esp_mqtt_client_subscribe(client, "/topic/qos0", 0);
|
||||
ESP_LOGI(TAG, "sent subscribe successful, msg_id=%d", msg_id);
|
||||
|
||||
msg_id = esp_mqtt_client_subscribe(client, "/topic/qos1", 1);
|
||||
ESP_LOGI(TAG, "sent subscribe successful, msg_id=%d", msg_id);
|
||||
|
||||
msg_id = esp_mqtt_client_unsubscribe(client, "/topic/qos1");
|
||||
ESP_LOGI(TAG, "sent unsubscribe successful, msg_id=%d", msg_id);
|
||||
break;
|
||||
case MQTT_EVENT_DISCONNECTED:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_DISCONNECTED");
|
||||
break;
|
||||
|
||||
case MQTT_EVENT_SUBSCRIBED:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_SUBSCRIBED, msg_id=%d, return code=0x%02x ", event->msg_id, (uint8_t)*event->data);
|
||||
msg_id = esp_mqtt_client_publish(client, "/topic/qos0", "data", 0, 0, 0);
|
||||
ESP_LOGI(TAG, "sent publish successful, msg_id=%d", msg_id);
|
||||
break;
|
||||
case MQTT_EVENT_UNSUBSCRIBED:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_UNSUBSCRIBED, msg_id=%d", event->msg_id);
|
||||
break;
|
||||
case MQTT_EVENT_PUBLISHED:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_PUBLISHED, msg_id=%d", event->msg_id);
|
||||
break;
|
||||
case MQTT_EVENT_DATA:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_DATA");
|
||||
printf("TOPIC=%.*s\r\n", event->topic_len, event->topic);
|
||||
printf("DATA=%.*s\r\n", event->data_len, event->data);
|
||||
break;
|
||||
case MQTT_EVENT_ERROR:
|
||||
ESP_LOGI(TAG, "MQTT_EVENT_ERROR");
|
||||
break;
|
||||
default:
|
||||
ESP_LOGI(TAG, "Other event id:%d", event->event_id);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static void mqtt_app_start(void)
|
||||
{
|
||||
const esp_mqtt_client_config_t mqtt_cfg = {
|
||||
.broker.address.uri = EXAMPLE_BROKER_URI,
|
||||
.broker.verification.psk_hint_key = &psk_hint_key,
|
||||
};
|
||||
|
||||
ESP_LOGI(TAG, "[APP] Free memory: %" PRIu32 " bytes", esp_get_free_heap_size());
|
||||
esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
|
||||
/* The last argument may be used to pass data to the event handler, in this example mqtt_event_handler */
|
||||
esp_mqtt_client_register_event(client, ESP_EVENT_ANY_ID, mqtt_event_handler, NULL);
|
||||
esp_mqtt_client_start(client);
|
||||
}
|
||||
|
||||
void app_main(void)
|
||||
{
|
||||
ESP_LOGI(TAG, "[APP] Startup..");
|
||||
ESP_LOGI(TAG, "[APP] Free memory: %" PRIu32 " bytes", esp_get_free_heap_size());
|
||||
ESP_LOGI(TAG, "[APP] IDF version: %s", esp_get_idf_version());
|
||||
|
||||
esp_log_level_set("*", ESP_LOG_INFO);
|
||||
esp_log_level_set("mqtt_client", ESP_LOG_VERBOSE);
|
||||
esp_log_level_set("transport_base", ESP_LOG_VERBOSE);
|
||||
esp_log_level_set("esp-tls", ESP_LOG_VERBOSE);
|
||||
esp_log_level_set("transport", ESP_LOG_VERBOSE);
|
||||
esp_log_level_set("outbox", ESP_LOG_VERBOSE);
|
||||
|
||||
ESP_ERROR_CHECK(nvs_flash_init());
|
||||
ESP_ERROR_CHECK(esp_netif_init());
|
||||
ESP_ERROR_CHECK(esp_event_loop_create_default());
|
||||
|
||||
/* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
|
||||
* Read "Establishing Wi-Fi or Ethernet Connection" section in
|
||||
* examples/protocols/README.md for more information about this function.
|
||||
*/
|
||||
ESP_ERROR_CHECK(example_connect());
|
||||
|
||||
mqtt_app_start();
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
dependencies:
|
||||
espressif/mqtt:
|
||||
version: '*'
|
||||
protocol_examples_common:
|
||||
path: ${IDF_PATH}/examples/common_components/protocol_examples_common
|
||||
@@ -1 +0,0 @@
|
||||
CONFIG_ESP_TLS_PSK_VERIFICATION=y
|
||||
@@ -1 +0,0 @@
|
||||
CONFIG_PARTITION_TABLE_SINGLE_APP_LARGE=y
|
||||
@@ -1 +0,0 @@
|
||||
CONFIG_PARTITION_TABLE_SINGLE_APP_LARGE=y
|
||||
@@ -1 +0,0 @@
|
||||
CONFIG_PARTITION_TABLE_SINGLE_APP_LARGE=y
|
||||
Reference in New Issue
Block a user