Веб-сервер на ESP32 с помощью ESP-IDF


В этом уроке мы создадим веб-сервер на базе ESP32 с использованием ESP-IDF. Веб-сервер сможет управлять встроенным светодиодом ESP32, подключенным к GPIO2. Плата ESP32 будет размещать HTML- и CSS-файлы в виде строк и отвечать на запросы веб-клиента этими HTML- и CSS-файлами. Аналогичным образом, она будет принимать HTTP-запросы от веб-клиента и управлять встроенным светодиодом.

Также на нашем сайте вы можете посмотреть аналогичный проект веб-сервера на модуле ESP32 для управления светодиодом на основе Arduino IDE.

Обзор веб-сервера на ESP32

Веб-сервер отвечает простыми HTML- и CSS-файлами, которые отображают кнопки управления светодиодами, состояние светодиодов, заголовок «ESP32 WEB SERVER» и символ лампы. Пользователь будет нажимать эти кнопки для управления выходом ESP32, который будет представлять собой GPIO2, через который подключен встроенный светодиод. Пользователь может получить доступ к веб-серверу по IP-адресу с помощью любого веб-клиента, например, веб-браузера на ноутбуке или мобильном телефоне.

Внешний вид интерфейса веб-сервера на ESP32

Как работает веб-сервер?

Как уже упоминалось, ESP32 в нашем проекте выступает в роли веб-сервера и предоставляет HTML- и CSS-файлы веб-клиенту. Он также отвечает на запросы GET HTML для выполнения действий на GPIO2. В качестве клиента может выступать любой веб-браузер.

Мы создадим веб-сервер с помощью библиотеки HTTP-веб-сервера, доступной в esp-idf. Кроме того, мы создадим HTML- и CSS-файлы и сохраним их в ESP32 в виде массива символов. Когда пользователь отправит HTTP GET-запрос, введя IP-адрес в веб-браузере, ESP32 ответит буфером, содержащим HTML- и CSS-файлы.

На графическом интерфейсе пользователя есть две кнопки: “ON” («ВКЛ») и “OFF” («ВЫКЛ»). Пользователь сможет управлять выводами GPIO ESP32 с помощью этих кнопок. При нажатии кнопки «ВКЛ» URL-адрес перенаправляет на IP-адрес, за которым следует /led2on, и аналогично при нажатии кнопки «ВЫКЛ» URL-адрес перенаправляет на IP-адрес, за которым следует /led2off. Используя эти подпути URL-адреса, мы запускаем соответствующую функцию обратного вызова в нашем коде для управления светодиодом и отправки ответа веб-клиенту.

Принцип работы веб-сервера на ESP32

Веб-сервер на базе ESP32 с модулем ESP-IDF

В этом разделе мы создадим веб-сервер управления контактом ESP32 с использованием ESP-IDF. Плата ESP32 будет работать в режиме станции, подключаясь к сети Wi-Fi через маршрутизатор. После успешного подключения к точке доступа плате будет присвоен IP-адрес, который будет использоваться для доступа к веб-серверу.

Создание проекта

Откройте VS Code и перейдите в меню (View > Command Palette («Вид» > «Палитра команд»). Введите в строке поиска ESP-IDF: New Project и нажмите Enter.

Укажите название проекта и каталог. Мы назвали наш проект «ESP_IDF_WEB_SERVER». Для платы ESP-IDF мы выбрали опцию custom board («Пользовательская плата»). В качестве целевой платформы ESP-IDF мы выбрали модуль ESP32. Нажмите кнопку ‘Choose Template’ («Выбрать шаблон»), чтобы продолжить.

Создание нового проекта в VS Code

В разделе Extension («Расширение») выберите опцию ESP-IDF:

Выбор опции ESP-IDF в разделе Extension («Расширение»)

На вкладке get-started («Начало работы») мы щелкнем по пункту «sample_project». Затем нажмем ‘Create project using template sample_project’ («Создать проект, используя шаблон sample_project»).

Создание проекта с использованием шаблона sample_project

Вы получите уведомление о создании проекта. Чтобы открыть проект в новом окне, нажмите «Да».

Это открывает наш проект ESP_IDF_WEB_SERVER, который мы создали на вкладке EXPLORER. Внутри папки проекта находится несколько папок. Это справедливо для каждого проекта, который вы создадите с помощью ESP-IDF Explorer.

Конфигурация проекта

Создайте новый файл с именем ' Kconfig.projbuild ' в основной папке. Скопируйте приведенный ниже код  в этот новый файл.

Создание файла с именем ' Kconfig.projbuild ' в основной папке нашего проектаТеперь перейдите в меню menuconfig. Щелкните значок, показанный ниже. Откроется редактор конфигурации ESP-IDF SDK.

Кнопка для открытия меню menuconfig в VS Code

Прокрутите вниз и откройте Example Configuration. Здесь мы можем установить параметры конфигурации для этого примера в соответствии с нашими потребностями. Это включает в себя SSID сети Wi-Fi, пароль сети Wi-Fi и максимальное количество попыток повтора. Укажите SSID и пароль вашей сети Wi-Fi, к которой будет подключаться плата ESP32. По умолчанию максимальное количество попыток установлено на 5. Вы можете изменить это значение по своему усмотрению. После указания параметров конфигурации нажмите кнопку «Сохранить» вверху.

Открытие Example Configuration в VS Code

Код веб-сервера для управления контактом GPIO на ESP32

В основной папке находится исходный код, то есть файл main.c будет расположен именно здесь .

Перейдите в папку main > main.c и откройте её. Скопируйте приведённый ниже код в свой файл main.c. Этот код создаст веб-сервер, размещённый на ESP32, с помощью которого пользователь сможет переключать встроенный светодиод с помощью кнопок.

Как работает код?

Для начала мы подключим необходимые библиотеки, включая библиотеки FreeRTOS для генерации задержек, создания задач и групп событий. Это esp_http_server.h для настройки HTTP-веб-сервера, esp_wifi.h для включения Wi-Fi-соединения, esp_event.h для мониторинга событий Wi-Fi, esp_log.h в качестве библиотеки для логирования, библиотека driver/gpio.h для управления цифровыми выходными контактами ESP32 и т.д.

Встроенный светодиод ESP32 подключен к выводу GPIO2. Поэтому мы определим переменную с именем 'LED_PIN', которая будет хранить значение GPIO2. Она будет использоваться позже в коде для управления светодиодом.

HTML и CSS для создания веб-сервера

Затем у нас есть массив, содержащий HTML и CSS скрипт для ответа на включение. Он включает в себя заголовок веб-сервера, иконку лампочки вместе с управляемым GPIO, абзац, описывающий состояние GPIO, и две кнопки (ВКЛ и ВЫКЛ).

HTML-код задаётся внутри тегов <html></html>. Внутри тегов <style></style> задаётся стиль веб-страницы. Это включает в себя семейство шрифтов, размер шрифта, позиционирование текста, размер и цвет кнопок и т.д.

Как вы могли заметить, весь текст набран шрифтом Arial и выровнен по центру веб-страницы. Цвет и отступы заголовка h1 также заданы. На нашей веб-странице две кнопки. Одна — кнопка «ВКЛ», а вторая — кнопка «ВЫКЛ». Обе кнопки имеют разные цвета, но остальное оформление одинаково, включая радиус скругления углов, цвет текста, отступы, курсор и т. д. Кроме того, карточка содержит состояние GPIO, кнопки и значок лампочки. Мы задаем размер и цвет заголовка карточки, а также общее оформление карточки, включая цвет фона, тень и т. д.

После этого мы указываем заголовок веб-страницы. Он размещается внутри тегов <title> </title>. В нашем случае мы установили заголовок веб-страницы как «ESP32 WEB SERVER». Он будет отображаться в строке заголовка браузера.

Следующий метатег позволит отображать наш веб-сервер на разных устройствах.

Как мы уже упоминали, мы хотим добавить на нашу веб-страницу иконку лампочки. Поэтому следующий тег ссылки получит иконку из FontAwesome .

Внутри тегов <body> </body> будут размещены заголовок, абзацы и кнопки.

Заголовок нашего веб-сервера — «ESP32 WEB SERVER», он размещен внутри тегов <h2></h2>.

После заголовка следует абзац, в котором отображается значок лампы и контакт GPIO2, которым мы управляем.

Для создания шрифта мы будем использовать сайт Fontawesome. Иконка лампы взята с этого сайта. Давайте покажем, как это сделать. Сначала откройте сайт Fontawesome. Теперь введите ‘light’, как показано ниже, и нажмите Enter.

Различные иконки на сайте Fontawesome

В зависимости от результатов поиска будут отображаться различные значки. Щелкните по тому, который хотите добавить. Ссылка появится в окне.

Выбор нужной нам иконки на сайте Fontawesome

Этот код будет использоваться внутри нашего HTML-скрипта, как показано ниже:

Во втором абзаце будет отображено состояние GPIO, которое в данном случае равно «ВКЛ».

Наконец, у нас есть абзац, описывающий две кнопки. Первая кнопка отображает текст «ВКЛ» и при нажатии перенаправляет на веб-страницу по адресу /led2on. Вторая кнопка отображает текст «ВЫКЛ» и перенаправляет на веб-страницу по адресу /led2off.

Затем у нас есть массив, содержащий HTML и CSS скрипт для ответа «ВЫКЛ». Он похож на массив ответа «ВКЛ», определенный ранее, однако на этот раз в абзаце, отображающем состояние GPIO, будет указано «ВЫКЛ».

Этот код использует информационное логирование. Функция логирования принимает два аргумента. Первый аргумент — это тег, а второй — отформатированная строка. Поэтому эта глобальная переменная будет полезна при вызове функций ESP_LOGI(). Здесь «espressif» — это тег, который будет использоваться при логировании.

Кроме того, целочисленная переменная 'led_state' хранит текущее состояние светодиода. Изначально она имеет значение 0.

Далее мы определили параметры конфигурации, которые задали в menuconfig. Если вы уже определили эти параметры в конфигурации проекта, то нет необходимости жестко прописывать значения здесь. Однако, если вы хотите определить эти параметры в файле main.c, то укажите их в двойных кавычках. Например: #define EXAMPLE_ESP_WIFI_SSID “YOUR_SSID”

Подключение через Wi-Fi

Далее мы объявляем переменную 's_wifi-event_group' для хранения созданной группы событий FreeRTOS. Эта группа событий FreeRTOS используется для оповещения о подключении к Wi-Fi.

Затем мы определяем два бита для важных для нас событий Wi-Fi. К ним относятся бит, обозначающий успешное подключение к точке доступа Wi-Fi, и бит, обозначающий неудачное подключение к точке доступа Wi-Fi после истечения максимального количества попыток.

event_handler()

Затем у нас есть функция event_handler(), которая обрабатывает события Wi-Fi. Она выступает в качестве функции обратного вызова при возникновении события Wi-Fi или события IP.

Событие IP происходит, когда плата ESP32 подключается к нашей точке доступа, и маршрутизатор назначает ей IP-адрес. События IP могут быть одного из следующих типов. Но здесь мы используем только IP_EVENT_STA_GOT_IP.

Во-первых, когда происходят события Wi-Fi (WIFI_EVENT и WIFI_EVENT_STA_START), мы подключаем ESP32 к точке доступа. Для этого мы используем функцию  esp_wifi_connect().

Если плата ESP32 не может подключиться к точке доступа в течение установленного максимального количества попыток, она снова пытается подключиться к точке доступа и регистрирует сообщение «повторная попытка подключения к точке доступа». Однако, если ESP32 не может установить соединение с точкой доступа после истечения максимального количества попыток, она регистрирует сообщение «сбой подключения к точке доступа» и устанавливает бит WIFI_FAIL_BIT. Теперь, если плата ESP32 успешно подключается к точке доступа, это означает, что произошли оба события IP (IP_EVENT и IP_EVENT_STA_GOT_IP). В этом случае она выводит IP-адрес в качестве результата. Кроме того, она также устанавливает бит WIFI_CONNECTED_BIT.

connect_wifi()

Функция connect_wifi() будет вызываться внутри функции app_main() для инициализации Wi-Fi в режиме станции для ESP32.

Для начала создадим группу событий FreeRTOS для мониторинга соединения. Эта функция возвращает дескриптор группы событий.

ESP-IDF предоставляет полезный макрос ESP_ERROR_CHECK(), который используется для проверки наличия или отсутствия ошибки. Если функция, переданная в него, не возвращает ESP_OK, то мы проверяем наличие ошибки и записываем её в лог.

Здесь мы инициализируем lwIP с помощью функции esp_netif_init() и создаём задачу IwIP, также известную как задача TCP/IP. lwIP — это стек библиотек TCP/IP, предоставляемый ESP-IDF, который используется для выполнения различных протоколов, таких как TCP, UDP, DHCP и т. д.

Далее мы создаём цикл обработки событий по умолчанию, который позволяет отправлять системные события в задачу обработки событий.

Кроме того, следующая строка используется для инициализации Wi-Fi по умолчанию в режиме станции. Этот API используется для инициализации, а также регистрации обработчиков событий для интерфейса по умолчанию, которым в нашем случае является станция. Он создает экземпляр сетевого интерфейса, связывающий драйвер Wi-Fi и стек TCP/IP. Когда станция находится в процессе подключения к точке доступа, различные процессы автоматически обрабатываются с помощью этой функции.

Затем мы инициализируем ресурс выделения Wi-Fi для драйвера Wi-Fi. Он отвечает за запуск задачи Wi-Fi. Он принимает единственный параметр cfg, который является указателем на уже инициализированную структуру конфигурации Wi-Fi, установленную в значение WIFI_INIT_CONFIG_DEFAULT(), так что инициализация конфигурации происходит со значениями по умолчанию. Здесь wifi_init_config_t — это структура, обозначающая параметры конфигурации стека Wi-Fi, которые передаются в функцию esp_wifi_init().

Далее мы создаём два обработчика событий: один с именем 'instance_any_id' для всех событий Wi-Fi, а другой с именем 'instance_any_ip' — для событий, когда станция получает IP-адрес.

Далее, у нас есть два регистра для экземпляров обработчика событий, которые мы настроили. Таким образом, задача приложения может зарегистрироваться для обратного вызова, который будет прослушивать события для Wi-Fi и TCP/IP. Первое событие — «ESP_EVENT_ANY_ID», а второе — «IP_EVENT_STA_GOT_IP». Следовательно, она будет прослушивать все события Wi-Fi (ESP_EVENT_ANY_ID) и событие IP, когда станция получит свой IP-адрес (IP_EVENT_STA_GOT_IP). Таким образом, функция обратного вызова  event_handler будет вызвана, если произойдет любое из этих двух событий.

Другие события Wi-Fi, которые мы можем использовать в нашем коде, включают:

В этой части мы задаём SSID и пароль сети, к которой хотим подключить наш ESP32, а также назначаем параметры безопасности.

Кроме того, мы устанавливаем режим Wi-Fi как «станция». Для этого мы используем функцию esp_wifi_set_mode() и передаем в качестве параметра параметр WiFI_MODE_STA.

Затем мы назначаем SSID и пароль нашей сети. Таким образом, драйвер Wi-Fi настраивается с использованием учетных данных сети точки доступа и режима Wi-Fi. После этого мы запускаем Wi-Fi-соединение с заданными параметрами.

На этом этапе в журнале информации появляется сообщение «wifi_init_sta finished». Процесс инициализации Wi-Fi в режиме станции завершен.

Далее приложение переходит в заблокированное состояние, ожидая установки одного из битов в группе событий. Это происходит после инициализации и запуска Wi-Fi. Приложение остается в заблокированном состоянии до тех пор, пока не будет установлено соединение Wi-Fi (контролируется битом WIFI_CONNECTED_BIT) или пока соединение Wi-Fi не будет разорвано в течение максимального количества попыток (контролируется битом WIFI_FAIL_BIT).

Если функция event_handler() устанавливает значение WIFI_CONNECTED_BIT, указывающее на успешное подключение ESP32 к точке доступа, то в информационном журнале будет указано, что соединение установлено с SSID и паролем указанной точки доступа. Если же функция event_handler() устанавливает значение WIFI_FAIL_BIT, указывающее на невозможность подключения ESP32 к точке доступа даже после достижения максимального количества попыток, то в информационном журнале будет указано, что соединение с SSID и паролем указанной точки доступа не удалось.

Кроме того, мы удаляем группу событий 's_wifi_event_group' с помощью функции vEventGroupDelete(). Она была создана ранее с помощью вызова функции xEventGroupCreate().

API-интерфейсы esp_http_server.h для размещения веб-сервера на ESP32

Функция send_web_page() отвечает за отправку полного HTTP-ответа путем вызова функции httpd_resp_send(). API httpd_resp_send() принимает три параметра. Первый параметр — это запрос, на который должен быть дан ответ. Второй параметр — это буфер, из которого необходимо получить контекст. Третий параметр — это длина буфера. В функции send_web_page() возвращается HTTP-ответ 'off_resp', если состояние светодиода равно 0. В противном случае возвращается HTTP-ответ 'on_resp'.

Ниже представлена ​​структура обработчика uri-get. Выбранный метод — HTTP_GET, URL — «/», а обработчик — get_req_handler, который возвращает ответ send_web_page().

У нас есть структура uri_on, показанная ниже. Выбранный метод — HTTP_GET, URL — «/led2on», а обработчик для этого — led_on_handler, который возвращает ответ send_web_page() и устанавливает уровень LED_PIN и 'led_state' в 1.

У нас есть структура uri_off, показанная ниже. Выбранный метод — HTTP_GET, URL — «/led2off», а обработчик для этого — led_off_handler, который возвращает ответ send_web_page() и устанавливает уровень LED_PIN и 'led_state' в 0.

Следующая функция запустит HTTP-веб-сервер и вернет сервер, который будет являться HTTP-дескриптором.

Процесс начинается с определения конфигурации по умолчанию и присваивает пустое значение дескриптору HTTP-сервера. Оно устанавливается как NULL.

Функция httpd_start() запускает HTTP-сервер. Она принимает два параметра: конфигурацию для нового экземпляра сервера и дескриптор этого экземпляра. Если экземпляр был успешно создан, что означает, что функция вернула ESP_OK, то мы регистрируем обработчики URI. Функция принимает два параметра. Первый параметр — это дескриптор экземпляра HTTP-сервера, в данном случае 'server'. Второй параметр — это указатель на обработчик, который мы хотим зарегистрировать. Мы регистрируем три обработчика URI: uri_get, uri_on и uri_off.

app_main()

Внутри функции app_main() сначала инициализируется NVS путем вызова функции nvs_flash_init(). Затем проверяется, не содержит ли раздел NVS пустых страниц или содержит ли он данные в формате, отличном от текущей версии кода. Если выполняется хотя бы одно из этих условий, то с помощью функции nvs_flash_erase() происходит очистка флэш-памяти NVS и повторная инициализация.

Затем мы выведем в терминале “ESP_WIFI_MODE_STA” и вызовем функцию connect_wifi() для подключения к Wi-Fi в режиме станции.

Следующий шаг — настройка контакта LED_PIN в качестве выхода GPIO. Для этого мы воспользуемся функцией gpio_pad_select_gpio(). Укажите вывод LED_PIN в качестве параметра внутри этой функции. Затем мы установим направление вывода как выходное с помощью функции gpio_set_direction(). Эта функция принимает два аргумента. Первый аргумент — это вывод GPIO, а второй — режим (вход или выход), в котором мы хотим установить вывод. В нашем случае мы хотим установить вывод LED_PIN как выходной вывод.

Переменная led_state устанавливается в значение 0. В этот момент терминал выводит сообщение «Веб-сервер управления светодиодами запущен… …». Вызывается функция setup_server() для запуска HTTP-веб-сервера.

Компиляция скетча

Для прошивки микросхемы введите следующую команду в последовательном терминале. Не забудьте заменить COM-порт на тот, через который подключена ваша плата.

Ввод команды для компиляции нашего скетча

После успешной прошивки кода вы можете просмотреть все информационные журналы. Сначала инициализируется Wi-Fi станции. Затем мы можем просмотреть esp_netif_handlers, который включает IP-адрес, маску и адрес шлюза. Затем мы получаем запись «получен IP-адрес», за которой следует сам IP-адрес. Мы будем использовать этот IP-адрес для доступа к веб-серверу.

Тестирование работы нашего проекта в терминале

Откройте новый веб-браузер и введите IP-адрес, полученный в терминале, затем нажмите Enter. Откроется веб-сервер ESP32, на экране которого отобразятся две кнопки для управления GPIO2. Изначально светодиод выключен, что также отображается на веб-сервере.

Теперь нажмите кнопки ВКЛ и ВЫКЛ, и светодиод будет включаться/выключаться соответственно. Аналогичным образом, состояние GPIO2 также будет непрерывно обновляться на веб-сервере.

Тестирование работы нашего проекта на экране смартфона (часть 1)

Тестирование работы нашего проекта на экране смартфона (часть 2)

(Проголосуй первым!)
Загрузка...
4 просмотров

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *