MicroPyServer простой HTTP сервер для ESP8266 и ESP32

Промо


Всем привет!


Хочу рассказать о библиотеке MicroPyServer написанной на Python, которая позволяет взаимодействовать с устройствами ESP8266 и ESP32 посредством простого HTTP сервера.


Что такое MicroPyServer?


MicroPyServer это простой HTTP сервер предназначенный для проектов написанных на Micropython.


Основная концепция работы с библиотекой — это перехватывание запросов к устройству при помощи создания роутов (route) и функций обработчиков (handler).


Основные действия с библиотекой:


  • Создание сервера


    srv = MicroPyServer()

    По умолчанию сервер работает на 80-ом порту.


  • Добавление роута, который будет обрабатывать запросы по заданному урлу


    def do_something(request):
      pass()
    srv.add_route("/url_path", do_something)

    По умолчанию обрабатываются GET запросы.


  • Отправка данных клиенту


    def do_something(request):
     srv.send("OK")

    По умолчанию отправляется код ответа 200 и Content-Type: text/plain.


  • Запуск сервера


    srv.start()


Исходники MicroPyServer можно скачать тут https://github.com/troublegum/micropyserver


Список методов MicroPyServer


Конструктор — srv = MicroPyServer(host="0.0.0.0", port=80)
Запустить сервер — srv.start()
Добавление роута — srv.add_route(path, handler, method="GET")
Отправить ответ — srv.send(response, status=200, content_type="Content-Type: text/plain", extra_headers=[])
Отправить 404-ю ошибку — srv.not_found()
Отправить 500-ю ошибку — srv.internal_error(error)


Примеры


Рассмотрим несколько небольших примеров работы с библиотекой MicroPyServer.


Hello world


Классический пример hello world.


from micropyserver import MicroPyServer
import esp
import network

''' Код подключения к WiFi '''
wlan_id = "Your WiFi"
wlan_pass = "Your WiFi password"

wlan = network.WLAN(network.STA_IF)
wlan.active(True)
if wlan.isconnected() == False:
    wlan.connect(wlan_id, wlan_pass)
    while wlan.isconnected() == False:
        time.sleep(1)
print('Device IP:', wlan.ifconfig()[0])

def show_message(request):
    ''' request handler '''
    server.send("HELLO WORLD!")

server = MicroPyServer()
''' add request handler '''
server.add_route("/", show_message)
''' start server '''
server.start()

Набрав у браузере адрес http://IP_вашего_устройства/ вы получите сообщение "HELLO WORLD!"


Простой пример настройки роутинга и управления выводом GPIO


В данном примере настроим обработку двух урлов которые будут делать: "включение" (/on) и "выключение" (/off) светодиода подключенного к выходу D7 ESP8266.


схема подключения светодиода


from machine import Pin
from micropyserver import MicroPyServer

''' Тут должен быть код подключения к WiFi '''

def do_on(request):
    ''' on request handler '''
    pin.value(1)
    server.send("ON")

def do_off(request):
    ''' off request handler '''
    pin.value(0)
    server.send("OFF")

pin = machine.Pin(13, machine.Pin.OUT)
server = MicroPyServer()
''' add request handlers '''
server.add_route("/on", do_on)
server.add_route("/off", do_off)
''' start server '''
server.start()

В итоге набрав у браузере адрес http://IP_вашего_устройства/on вы включите подключенный к выходу D7 светодиод и в браузере выведется сообщение "ON". Соответственно набрав у браузере адрес http://IP_вашего_устройства/off вы выключите светодиод.


Вывод информации с датчика DHT в JSON


В данном примере показано как получить данные с датчика влажности и температуры DHT22 в виде JSON.


схема подключения датчика


import json
import dht
from machine import Pin
from micropyserver import MicroPyServer

''' Тут должен быть код подключения к WiFi '''

def show_data(request):
    ''' request handler '''
    d = dht.DHT22(machine.Pin(4))
    d.measure()
    data = {"temperature":  d.temperature(), "humidity": d.humidity()}
    json_str = json.dumps(data)
    server.send(json_str,  content_type="Content-Type: application/json")

server = MicroPyServer()
''' add request handler '''
server.add_route("/data", show_data)
''' start server '''
server.start()

Набрав у браузере адрес http://IP_вашего_устройства/data получим JSON строку с данными


Опыт использования


Данная библиотека используется в нескольких моих устройствах, которые работают в режиме 24/7 уже более полугода. На данный момент никаких проблем с сервером я не обнаружил и надеюсь, что в будущем код сервера будет работать также без проблем как и сейчас.

Share post
AdBlock has stolen the banner, but banners are not teeth — they will be back

More
Ads

Comments 19

    0
    Почему бы вместо JSON не выдать HTML. Готовая метеостанция с вебинтерфейсом.
      0

      Или в MQTT-топики публиковать — питоновский MQTT-клиент paho весьма функционален (по крайней мере, в десктопном варианте — хотя в нем и нет в отличие от Java setAutoReconnect).
      А для просмотра в MQTT-клиенте можно настроить интерфейс по своему желанию, начиная с такого спартанского варианта:
      image
      Недостаток — потребуется использовать стороннего брокера или развернуть свой "москито", что удобнее — на VPS.

      +2
      Вот эта строка
      return str(self._connect.recv(4096), "utf8")

      при определенных условиях сможет подарить вам несколько незабываемых часов отладки, причем даже если запрос будет меньше 4096 байт размером.
        +3

        А как правильно?

        +1

        Не в качестве критики, но чем это решение лучше использования готовой прошивки (ESPHome или Tasmota), которую просто потом донастроить для различных датчиков или даже шаговых двигателей?

          0
          Думаю что размером выполняемого кода.
          0
          Есть облачные сервисы которые неплохо работают с IoT
          Нарпимер, thingspeak — бесплатный (с лимитами) API как раз для таких штук.
          Настроили отправку раз в 2-5-10 минут и можно смотреть и текущее значение и историю, даже не находясь в локальной сети.
          При желании можно к тому же облачному API можео прикрутить веб морду которая будет от него забирать данные.
          Использовал с esp8266 года полтора, без каких либо проблем.
            +2
            Есть облачные сервисы которые неплохо работают с IoT

            А через n лет эти облака перестают существовать)
              0
              Вопрос лишь в соотношении трудозатрат к результату и требованиям.
              Потеря данных о температуре в спальне n лет назад конечно печальна, но не критична.
              А вот из коробки вы получаете и публичный API с ключом, и хранилище, и начальную аналитику, и доступ из любого места где сеть есть.
              Да это все можно сделать вручную, особенно если важен сам процесс. Да, я бы не стал подключать публичные сервисы если ардуино контролирует что-то, как например замок от двери итд.
              Но для не критичных данных это быстный и довольно удобный выход.
              0

              Облака это не всегда хорошее решение, и не везде подходит. Как показывает практика, лучше иметь свою экосистему. Облако завтра может быть закрыто по любой причине (даже у Гугла внезапно закрываются сервисы). Самое надёжное поставить малину как сервис и завести на ней все что угодно, при этом будет и в мир смотреть

              0
              поедет это все на esp8266-esp01? все-таки nodemcu жирновато для датчика…
                0
                На обоих версиях (512 кб и 1мб) должно поднятся, только в первой не будет возможности отдавать html файлы
                  0
                  Да, будет работать. Все остальное зависит от размера вашего кода.
                    0
                    Чем вы шьете esp? ide? fstool?
                      0
                      nodemcu-pyflasher например
                  0
                  Как captive portal эту штуку настроить можно? Чтоб и https на страницу авторизации направлял.
                    0
                    Уже существуют проекты github.com/jczic/MicroWebSrv и github.com/jczic/MicroWebSrv2. Правда ESP8266 похоже не поддерживается (могу ошибаться).
                      0
                      Да, есть такие проекты, но работают они только с ESP32. И размер кода библиотеки к сожалению довольно большой.
                      0
                      Отличный пример того, как весь инет читает твою домашнюю информацию. ) Иначе слабо представляю удобство такого использования. Можно конечно дальше сервер на сервер натянуть, собирать данные с них в одно место, которое будет с ограниченным доступом, но тогда получается сомнительность такой нагрузки/потребления на ESP (и как следствие, более узкая область использования).

                      Only users with full accounts can post comments. Log in, please.