Jan Beran

View on GitHub

Úkol 5: ESP-NOW chatovací místnost


Wi-Fi se skvěle hodí na připojení k internetu, ale potřebuje přístupový bod (router) a kvůli navazování spojení má režii navíc. Co když chcete, aby si několik desek ESP32 povídalo přímo mezi sebou?

Co je vlastně ESP-NOW?

ESP-NOW je bezspojový protokol s malou režií, který Espressif postavil nad Wi-Fi rádiem. Než sáhneme na kód, hodí se vědět pár věcí:

V tomhle úkolu si uděláme chatovací místnost. Zprávy ostatním deskám pošlete ze sériového monitoru — nebo jim budete ovládat LED!

Tentokrát začněte novým projektem. ESP-NOW nepotřebuje Wi-Fi provisioning ani OTA kód z Úkolů 3–4:

idf.py create-project esp_now_chat
cd esp_now_chat
idf.py set-target esp32c5
idf.py add-dependency "espressif/led_strip^3.0.3"
idf.py reconfigure

Zkopírujte chatroom.c a chatroom.h do složky main/.

Do main/CMakeLists.txt přidejte chatroom.c a komponenty, které chat používá:

idf_component_register(SRCS "esp_now_chat.c" "chatroom.c"
                       INCLUDE_DIRS "."
                       REQUIRES led_strip esp_wifi esp_event esp_netif nvs_flash)

Nový hlavní soubor (esp_now_chat.c) začíná takhle:

#include <stdio.h>

void app_main(void)
{

}

idf.py create-project pojmenuje zdrojový soubor podle projektu, takže váš je main/esp_now_chat.c.

1. Psaní kódu

Jako předtím postavíme main/esp_now_chat.c po částech, místo abychom ho vložili celý najednou. Chatovací místnost odsud volá tři funkce, které napíšete vy: broadcast, odeslání na jednu MAC adresu a zapamatování MAC adresy jako peeru. Sama esp_now_* nevolá.

1.1 Kostra

#include <stdio.h>

// (A) Headers and the broadcast address
// (B) Receive callback: hand the packet to the chat room
// (C) espnow_broadcast, espnow_send, espnow_add_peer

void app_main(void)
{
    // (D) Initialize NVS
    // (E) Turn the Wi-Fi radio on (station mode, no router)
    // (F) Initialize ESP-NOW, register the receive callback, add the broadcast peer
    // (G) Start the chat room
}

1.2 Část (A): hlavičky a broadcast adresa

#include <stdio.h>
#include <string.h>
#include "esp_event.h"
#include "esp_log.h"
#include "esp_mac.h"
#include "esp_netif.h"
#include "esp_now.h"
#include "esp_wifi.h"
#include "nvs_flash.h"
#include "chatroom.h"

/* Každá deska si jméno vytvoří sama: 4písmenné zvíře vybrané podle MAC adresy a poslední dva bajty
 * MAC v hex, například "bear83e8". To je přesně 8 malých ASCII znaků a díky hex části je jméno
 * v místnosti v praxi jedinečné. */
static const char *const s_animals[] = {
    "bear", "wolf", "lynx", "seal", "crab", "frog", "duck", "goat",
    "hawk", "mole", "newt", "swan", "toad", "moth", "deer", "orca",
};

static void make_node_name(char name[CHATROOM_NAME_LEN + 1])
{
    uint8_t mac[6];
    ESP_ERROR_CHECK(esp_read_mac(mac, ESP_MAC_WIFI_STA));
    const char *animal = s_animals[(mac[3] ^ mac[4] ^ mac[5]) % (sizeof(s_animals) / sizeof(s_animals[0]))];
    snprintf(name, CHATROOM_NAME_LEN + 1, "%s%02x%02x", animal, mac[4], mac[5]);
}

static const char *TAG = "espnow";

static const uint8_t s_broadcast_mac[6] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};

Broadcast MAC adresa je v protokolu ESP-NOW FF:FF:FF:FF:FF:FF. Každé další zařízení s ESP-NOW poslouchá zprávy poslané na tuhle adresu.

Chat room potřebuje pro každou desku jméno: přesně 8 znaků ASCII, v místnosti jedinečné. Nikdo ho nemusí vymýšlet, protože ho make_node_name() sestaví z MAC adresy desky: 4písmenné zvíře plus poslední dva bajty MAC v hex, třeba bear83e8 nebo wolf1f42. Dvě desky v jedné místnosti mohou skončit se stejným zvířetem, ale hex část srážku činí velmi nepravděpodobnou. Vaše deska své jméno vypíše při startu a list ukáže jména ostatních.

1.3 Část (B): callback pro příjem

ESP-NOW tuhle funkci zavolá z Wi-Fi úlohy, kdykoli přijde paket. Payload je surový buffer s délkou, ne céčkový řetězec. Tady ho nerozebíráme — to dělá chatroom_on_recv, která si z src_addr přečte i MAC adresu odesílatele.

static void on_data_recv(const esp_now_recv_info_t *recv_info, const uint8_t *data, int data_len)
{
    if (recv_info == NULL || recv_info->src_addr == NULL) {
        return;
    }
    /* Běží ve Wi-Fi úloze: rychle předat a vrátit se. */
    chatroom_on_recv(recv_info->src_addr, data, data_len);
}

1.4 Část (C): odeslání a přidání peeru

esp_now_send() předá rádiu len bajtů a vrátí se. Nečeká, až je někdo přijme — není tu spojení, na které by se čekalo. Stejné volání je broadcast, nebo zpráva jedné desce, podle toho, jakou MAC adresu předáte.

Odeslání konkrétní desce funguje jen pro MAC adresu zaregistrovanou přes esp_now_add_peer(). Chatovací místnost to udělá, když nějakou desku uslyší poprvé. channel = 0 znamená „kanál, na kterém rádio už je“. U broadcast peeru nelze zapnout encrypt.

esp_err_t espnow_broadcast(const uint8_t *data, size_t len)
{
    return espnow_send(s_broadcast_mac, data, len);
}

esp_err_t espnow_send(const uint8_t mac[6], const uint8_t *data, size_t len)
{
    return esp_now_send(mac, data, len);
}

esp_err_t espnow_add_peer(const uint8_t mac[6])
{
    /* Přidat dvakrát nejde; známé desky přeskočit. */
    if (esp_now_is_peer_exist(mac)) {
        return ESP_OK;
    }

    esp_now_peer_info_t peer = { 0 };
    memcpy(peer.peer_addr, mac, 6);
    peer.channel = 0;   /* current channel */
    peer.encrypt = false; /* v tomhle workshopu bez šifrování */
    return esp_now_add_peer(&peer);
}

1.5 Části (D)–(G): app_main

ESP-NOW potřebuje zapnutou Wi-Fi periferii v režimu station, i když se k routeru nikdy nepřipojíme. esp_wifi_start() rádio jen zapne. NVS musí být první, stejně jako v úkolech s Wi-Fi, protože ovladač Wi-Fi si do něj ukládá kalibrační data.

Broadcast peer se musí přidat před prvním odesláním, jinak esp_now_send() na FF:FF:FF:FF:FF:FF skončí chybou „peer not found“. chatroom_start() je klávesnice a kód, který vypisuje přijaté řádky; všechno, co vysílá, jde zpátky přes část (C).

void app_main(void)
{
    // (D) Initialize NVS
    esp_err_t ret = nvs_flash_init();
    /* Flash se mazala nebo se změnil layout; začít s čistou NVS. */
    if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) {
        ESP_ERROR_CHECK(nvs_flash_erase());
        ret = nvs_flash_init();
    }
    ESP_ERROR_CHECK(ret);

    // (E) Turn the Wi-Fi radio on (station mode, no router)
    ESP_ERROR_CHECK(esp_netif_init()); /* TCP/IP stack */
    ESP_ERROR_CHECK(esp_event_loop_create_default()); /* smyčka, do které Wi-Fi posílá události */
    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
    ESP_ERROR_CHECK(esp_wifi_init(&cfg));
    ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA)); /* režim station, ale k routeru se nikdy nepřipojíme */
    ESP_ERROR_CHECK(esp_wifi_start()); /* rádio zapnuto; zatím bez připojení */

    // (F) Initialize ESP-NOW, register the receive callback, add the broadcast peer
    ESP_ERROR_CHECK(esp_now_init());
    /* Každý paket skončí v části (B). */
    ESP_ERROR_CHECK(esp_now_register_recv_cb(on_data_recv));

    esp_now_peer_info_t broadcast = { 0 };
    memcpy(broadcast.peer_addr, s_broadcast_mac, 6);
    broadcast.channel = 0;
    broadcast.encrypt = false; /* broadcast traffic cannot be encrypted */
    ESP_ERROR_CHECK(esp_now_add_peer(&broadcast));

    // (G) Start the chat room: klávesnice dovnitř, řádky chatu ven; odesílání jde přes část (C)
    char node_name[CHATROOM_NAME_LEN + 1];
    make_node_name(node_name);
    chatroom_start(node_name);
    ESP_LOGI(TAG, "ESP-NOW is up. Type in this monitor.");
}

1.6 Celý kód

examples/C5/assignment-05-esp-now má tenhle program v main/esp_now_chat.c a k němu dvojici chatroom.c / chatroom.h.

2. Build, flash a monitor

idf.py build flash monitor

idf.py monitor je sériový terminál oběma směry. Řádky, které deska vypíše, se ukážou tady, a klávesy, které stisknete, se pošlou na desku (kromě Ctrl-], kterým monitor skončí, a Ctrl-T, kterým se otevře jeho menu). Deska znaky, které píšete, opisuje zpátky. Zpráva od někoho jiného se může vypsat doprostřed rozepsaného řádku; deska přesto dostane jen vaše stisky a Enter odešle řádek, který jste napsali.

Nahrajte druhou desku (nebo desku souseda). Každá deska si jméno vytvoří z MAC adresy, takže nic needitujete. V příkladech níže je vaše deska bear83e8 a jejich wolf1f42; skutečná jména najdete na řádku This board is "..." ve vlastním monitoru.

Řádek, který není ASCII, se odmítne. Paket delší než 250 bajtů se před odesláním ořízne. Deska svůj vlastní broadcast nepřijme.

Další krok

Podíváme se na poslední vlastnost ESP32-C5: low-power jádro!

Úkol 6: LP-core