search

Vovaman / micropython_async_websocket_client

This websocket client allows to interchange (read/write) data with server. It is created to run on ESP32 controllers.
Apache License 2.0
36 stars 8 forks source link

readme

micropython-async_websocket_client

This module is designed for ESP32 (and other) controllers. Goal: create and keep alive connection channel with websocket server. You may send captured data from controlled devices through this channel to server and accept managing signals on your controller. This data channel works as background task while main control cycle is running too. The break of websocket channel doesn't corrupt main cycle of control.

This project based on: https://github.com/danni/uwebsockets https://github.com/peterhinch/micropython-async

My gratitudes to authors.

requirements

This module is designed and tested on ESP32S-WROOM-32. Development and tests were done based on esp32-20220618-v1.19.1.bin.

installation

Run this commands on your controller: You have to reflash your board with [micropython](https://micropython.org/). Details are explained in https://github.com/Vovaman/start_ESP32_with_micropython. You may use VSCode as explained in link above or use `picocom` tool (also explained) to connect your board and run python console (REPL) on it. So, after you are in your board... 
>>> import network
>>> wifi = network.WLAN(network.STA_IF)
>>> wifi.active(1)
>>> wifi.connect(<name_of_your_wifi_net>, <wifi_password>)
>>> import upip
>>> upip.install('micropython-async-websocket-client')

All needed dependencies are in esp32-20220618-v1.19.1.bin.

example

Sample using of this module is in https://github.com/Vovaman/example_async_websocket.