Skip to main content

Asynchronous websocket client for ESP32 controller.

Project description

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-20220117-v1.18.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-20220117-v1.18.bin.

example

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

0.1.6

First release.

0.1.7

Websocket can send custom headers to server in handshake function. Author: pluzmedia

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

micropython-async_websocket_client-0.1.7.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file micropython-async_websocket_client-0.1.7.tar.gz.

File metadata

  • Download URL: micropython-async_websocket_client-0.1.7.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2

File hashes

Hashes for micropython-async_websocket_client-0.1.7.tar.gz
Algorithm Hash digest
SHA256 6fb4637075554908f5d1f14ae2b984c4bf54f0516130bc829346b1568e3492be
MD5 4dc69e6cb2502c3eda9a3b1d91c355b8
BLAKE2b-256 13df2ea8581ed43863dba54c64d94276e4c8e39d2dbbb46735b0a31df960af58

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page