Взаимодействие с API OpenWeatherMap с помощью ESP32 и ESP-IDF


В данной статье мы рассмотрим, как выполнить HTTP GET-запрос к API OpenWeatherMap с ESP32, используя ESP-IDF. Таким образом, мы разработаем бессенсорную метеостанцию на основе платформы OpenWeatherMap, с помощью которой будем получать данные о погоде, включая температуру, давление, влажность, скорость и направление ветра, облачность и осадки.

Бессенсорная метеостанция на основе OpenWeatherMap, ESP32 и ESP-IDF

Мы будем использовать библиотеку HTTP-клиента, доступную в ESP-IDF, для выполнения HTTP GET-запросов к API OpenWeatherMap.

Также ранее на нашем сайте мы рассматривали и другие проекты метеостанций:

Введение в API OpenWeatherMap

API OpenWeatherMap предоставляет разнообразные данные о погоде для разных местоположений, включая текущие погодные условия, прогнозы погоды, исторические данные о погоде и карты погоды. Доступна следующая информация:

  • Текущие погодные условия, включая температуру, давление, влажность, скорость и направление ветра, облачность и осадки.
  • Прогноз погоды на срок до 16 дней с данными о температуре, давлении, влажности, скорости и направлении ветра, а также об осадках.
  • Исторические данные о погоде, включая температуру, давление, влажность, скорость и направление ветра, а также количество осадков за указанную дату.
  • Метеорологические карты, включающие данные о температуре, осадках, ветре, давлении и облачности для различных регионов мира.

Помимо основных данных о погоде, API OpenWeatherMap также предоставляет информацию о времени восхода и захода солнца, УФ-индексе и уровне загрязнения воздуха для конкретного местоположения.

Использование API OpenWeatherMap

Логотип OpenWeatherMap

Перейдите на страницу API по адресу https://openweathermap.org/appid/. После загрузки веб-страницы откроется окно. Чтобы зарегистрироваться, нажмите на ссылку “here”, обозначенную красной рамкой на следующем рисунке.

Страница для начала регистрации на OpenWeatherMap

На странице, на которую вы будете перенаправлены, вам потребуется ввести имя пользователя, пароль и другую необходимую информацию для создания учетной записи. После заполнения всех данных отметьте необходимые поля и нажмите кнопку “Create Account” («Создать учетную запись»), чтобы завершить процесс.

Заполнение данных об аккаунте на OpenWeatherMap

После подтверждения адреса электронной почты отобразится сообщение о том, что ваша учетная запись успешно создана.

Сообщение об успешном создании учетной записи на OpenWeatherMap

Следующий шаг — перейти на вкладку “API keys” («Ключи API»), где вы найдете окно с вашим уникальным ключом API.

Получение уникального API-ключа на OpenWeatherMap

Ваш уникальный API-ключ, выделенный красным цветом, будет отображаться на вкладке «API-ключи». Важно надежно сохранить этот ключ и никому его не передавать в целях безопасности.

Как использовать API OpenWeatherMap

Теперь, когда мы создали учетную запись в OpenWeatherMap и получили уникальный ключ, давайте посмотрим, как получать обновления погоды для конкретного местоположения. Для этого просто введите следующий URL-адрес в новой вкладке:

Для получения информации о погоде в нужном месте по URL-адресу необходимо ввести три параметра: название города (указывается как «q=your_city»), код страны города (указывается как «your_country_code») и ваш уникальный API-ключ (полученный на вкладке «API-ключи»).

Например, если мы хотим получить информацию о погоде в Сеуле, Южная Корея, мы можем ввести следующий URL-адрес:

Откройте новое окно и вставьте URL-адрес. Появится текущий прогноз погоды для Сеула, Южная Корея, со всеми подробностями.

Прогноз платформы для Сеула с платформы OpenWeatherMap

Как показано на рисунке выше, HTTP-ответ имеет формат JSON. Мы проанализируем это JSON-сообщение в коде ESP32, чтобы получить температуру, давление и влажность.

Создание в ESP-IDF проекта бессенсорной метеостанции на базе API OpenWeatherMap

В этом разделе давайте создадим проект ESP-IDF для бессенсорной метеостанции на основе API OpenWeatherMap.

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

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

Создание в ESP-IDF проекта бессенсорной метеостанции на базе API OpenWeatherMap

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

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

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

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

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

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

Код ESP32 для бессенсорной метеостанции на базе OpenWeatherMap

Этот код для ESP32 ESP-IDF получает данные о погоде из API OpenWeatherMap, обрабатывает их и выводит температуру, давление и влажность для конкретного города. Он использует библиотеку HTTP-клиента для выполнения HTTP GET-запросов к API и обработки ответа.

Программа обрабатывает HTTP GET-ответ от API OpenWeatherMap, извлекая необходимые данные. Ответ представляет собой JSON-сообщение. Программа анализирует JSON-строку, извлекает значения температуры, давления и влажности и отображает их в консоли.

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

Эти строки кода содержат несколько заголовочных файлов, таких как «stdio.h», «string.h» и «stdlib.h», которые предоставляют базовые операции ввода/вывода, функции обработки строк и выделения памяти соответственно.

В него также входят заголовочные файлы, специфичные для микроконтроллера ESP32, такие как «esp_log.h», «nvs_flash.h», «esp_event.h» и «esp_netif.h». Эти заголовочные файлы предоставляют функции для ведения журналов, энергонезависимой памяти, обработки событий, управления сетевым интерфейсом и анализа сообщений JSON.

Определите глобальные переменные, например, open_weather_map_api_key — это ключ API от OpenWeatherMap. Это место, откуда можно получить информацию о погоде для указанного города и страны (код страны указан в глобальных переменных city и country_code).

Функция HTTP Get-запроса к API OpenWeatherMap

Функция openweather_api_http() является основной функцией, выполняющей функциональность HTTP-клиента. Она инициализирует клиент, устанавливает заголовки и выполняет запрос к API OpenWeatherMap. Для анализа полученных данных и отображения информации она вызывает функцию get_temp_pressure_humidity.

Объявляет символьный массив open_weather_map_url размером 200, который используется для хранения URL-адреса конечной точки API OpenWeatherMap для выполнения HTTP GET-запроса.

Формирует URL-адрес для конечной точки API OpenWeatherMap путем конкатенации различных строковых литералов и значений city, country_code и open_weather_map_api_key. Результат сохраняется в массиве open_weather_map_url.

Объявляет структуру конфигурации типа esp_http_client_config_t и инициализирует её значениями переменной open_weather_map_url, HTTP_METHOD_GET и адресом функции обработчика HTTP-ответа. Функция обратного вызова _http_event_handler будет срабатывать всякий раз, когда мы получаем ответ от API OpenWeatherMap после выполнения HTTP GET-запроса.

Вызовите функцию esp_http_client_init, передав ей указатель на структуру конфигурации, и сохраните полученный дескриптор клиента в переменной client.

Вызывает функцию esp_http_client_set_header, передавая ей дескриптор клиента и строковый литерал, для установки значения заголовка Content-Type для запроса.

Наконец, выполняется HTTP-запрос с помощью функции esp_http_client_perform() и результат присваивается переменной err.

В конце кода проверяется, равна ли переменная err значению ESP_OK, что указывает на успешность HTTP-запроса к API OpenWeatherMap. Если err равно ESP_OK, код проверяет код состояния ответа. Если код состояния равен 200, выводится сообщение об успешной отправке HTTP-запроса. Если код состояния не равен 200, выводится сообщение о неудачной отправке HTTP-запроса.

Если err не равен ESP_OK, это означает, что HTTP-запрос не был успешным, и выводится сообщение о том, что отправка сообщения не удалась.

Функция esp_http_client_cleanup вызывается для освобождения ресурсов, связанных с переменной клиента. Функция vTaskDelete(NULL) вызывается для удаления текущей задачи.

В итоге:

Функция openweather_api_http выполняет HTTP GET-запрос к API OpenWeatherMap для получения информации о погоде. URL-адрес для запроса к API формируется путем конкатенации нескольких строк, включая конечную точку API, город, код страны и ключ API. Запрос настраивается с помощью структуры esp_http_client_config_t и инициализируется с помощью esp_http_client_init(). Затем запросу добавляется заголовок Content-Type перед отправкой с помощью esp_http_client_perform(). Проверяется код состояния ответа, чтобы определить, был ли запрос успешным или нет.

Функция обработчика HTTP-ответов API OpenWeatherMap

Функция _http_event_handler является обработчиком событий HTTP. Она обрабатывает два основных события – “HTTP_EVENT_ON_DATA” и “HTTP_EVENT_ON_FINISH”.

Событие HTTP_EVENT_ON_DATA срабатывает, когда ESP32 получает ответ на HTTP-запрос от API OpenWeatherMap. В HTTP-коммуникациях используются несколько фрагментов данных для обработки больших объемов информации, поскольку получить все данные за один запрос может быть невозможно. Использование нескольких фрагментов позволяет разбить данные на более мелкие, управляемые части, снижая риск нехватки памяти или других ошибок. В данном случае событие HTTP_EVENT_ON_DATA обрабатывается путем выделения памяти и копирования полученного фрагмента данных в буфер.

Когда срабатывает событие “HTTP_EVENT_ON_FINISH”, это означает, что все фрагменты данных получены. Код регистрирует все полученные данные и вызывает функцию “get_temp_pressure_humidity”, передавая полученные данные в качестве аргумента.

Функция получения значений метеостанции

Функция get_temp_pressure_humidity принимает на вход строку JSON и извлекает из неё значения температуры, давления и влажности.

Функция использует библиотеку cJSON для анализа JSON-строки и извлечения значений температуры, давления и влажности из данных JSON. Затем значения выводятся в определенном формате, который включает температуру в градусах Фаренгейта, давление в гПа и влажность в процентах.

После извлечения значений функция удаляет объект cJSON и освобождает память, используемую для хранения данных ответа.

Основная функция

Функция «app_main» является точкой входа в приложение. Она инициализирует энергонезависимую флэш-память (NVS) микроконтроллера ESP32, используемую для хранения данных, которые должны сохраняться после выключения и включения питания. После этого вызывается функция «nvs_flash_init» для инициализации NVS-флэш-памяти и проверяется возвращаемое значение. Если возвращаемое значение равно «ESP_ERR_NVS_NO_FREE_PAGES» или «ESP_ERR_NVS_NEW_VERSION_FOUND», это означает, что NVS-флэш-память необходимо стереть и инициализировать заново. Затем вызывается функция «ESP_ERROR_CHECK» для проверки наличия ошибок при инициализации NVS-флэш-памяти.

Подключается к сети Wi-Fi, вызывая функцию «connect_wifi()».

Если подключение к Wi-Fi установлено успешно, создается задача «openweather_api_http», которая отправляет HTTP-запрос GET к API OpenWeatherMap.

Примечание: в этом проекте есть один заголовочный файл с именем «connect_wifi.h», мы создали его в предыдущих уроках. Вам также необходимо добавить этот файл. Вы можете скачать полный проект по ссылке для скачивания в следующем разделе.

Демонстрация работы проекта

В этом разделе мы рассмотрим демонстрацию работы бессенсорной метеостанции на основе API OpenWeatherMap. Для начала загрузите полный проект по следующей ссылке и соберите его.

Настройка учетных данных Wi-Fi

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

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

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

Настройка примера конфигурации

Отключение ESP TLS

Мы используем HTTP вместо HTTPS, поэтому нам необходимо отключить компонент ESP-TLS в settings->Components Config>ESP-TL.

Отключение ESP TLS в ESP-IDF

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

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

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

Если всё работает исправно, на консоли отобразятся значения температуры, давления и влажности.

Демонстрация работы проекта в окне терминала

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

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

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