Skip to main content

Host-side tools that interact with the ESP-IDF firmware.

Project description

Host Python Tools

This folder contains host-side Python code that interacts with the ESP-IDF firmware (e.g., over serial, sockets, or file exchange). It is kept separate from the firmware build to avoid mixing tool dependencies with ESP-IDF.

Quick start

python -m venv .venv
source .venv/bin/activate
pip install -e .

enode-host --help
enode-host socket 127.0.0.1 3333 "hello"
enode-host gui --port 3333
enode-host map-server --port 8081

Notes

  • Add runtime dependencies to pyproject.toml under project.dependencies.
  • Keep device/transport details in small modules so they can be shared by scripts and tests.
  • The GUI uses wxPython; install it if you plan to run enode-host gui.
  • The GUI needs an active X11/Wayland display. On headless hosts, use xvfb-run enode-host gui.
  • If the GUI aborts with WebView/EGL errors on Linux, try WEBKIT_DISABLE_DMABUF_RENDERER=1 enode-host gui.
  • If WebView still fails, you can disable the map panel with ENODE_DISABLE_WEBVIEW=1 enode-host gui.
  • enode-host map-server serves fixed-size RGB viewports assembled from OpenStreetMap tiles so an ESP32 client can show a static map without embedding a full web map stack.
  • The default tile URL points at tile.openstreetmap.org. That is acceptable for light development use, but for sustained use you should switch the proxy to your own tile service or self-hosted tiles.

Protocol (TCP, length-prefixed)

Frame format: 1 byte message type, 2 bytes big-endian payload length, payload.

Message types:

  • 0x10 COMMAND (host -> device)
  • 0x20 STATUS (device -> host)
  • 0x30 ACK (either direction)
  • 0x40 DATA (device -> host, ACC batch)
  • 0x41 PPS (device -> host, immediate PPS)

Commands (payload begins with command_id):

  • 0x01 start_daq
  • 0x02 stop_daq
  • 0x03 set_mode (1 byte: 0 realtime, 1 past)
  • 0x04 start_realtime_stream
  • 0x05 stop_realtime_stream

Status payload (16 bytes):

  • node_type: uint8
  • node_number: uint8
  • level: uint8
  • parent_mac: 6 bytes
  • self_mac: 6 bytes
  • rssi: int8

DATA payload:

  • node_type: uint8
  • node_number: uint8
  • sample_count: uint8
  • repeated samples (count):
    • cc: uint64 (big-endian)
    • acc_x: float32 (big-endian)
    • acc_y: float32 (big-endian)
    • acc_z: float32 (big-endian)

PPS payload:

  • node_type: uint8
  • node_number: uint8
  • cc: uint64 (big-endian)
  • epoch: int64 (big-endian)

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

enode_host-0.1.10.tar.gz (123.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enode_host-0.1.10-py3-none-any.whl (136.3 kB view details)

Uploaded Python 3

File details

Details for the file enode_host-0.1.10.tar.gz.

File metadata

  • Download URL: enode_host-0.1.10.tar.gz
  • Upload date:
  • Size: 123.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for enode_host-0.1.10.tar.gz
Algorithm Hash digest
SHA256 2db06869d75a91c6c4782e1cb65c797176d2c718ba4f49b333c47975f48294ee
MD5 358f6c2fef73ec6386465e336b78db85
BLAKE2b-256 0f03df5acf7abb9ab924da7b4e4881597c34c835e920dd44bd08f7dc24ce7b86

See more details on using hashes here.

File details

Details for the file enode_host-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: enode_host-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 136.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for enode_host-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a9fcffbb80150e23d24b17fa670657da9bb3f8ee6847b20a45fd7298d6ba1ead
MD5 247731a9c934075c9096a57aa2c8d845
BLAKE2b-256 c62806e623effab60c4ceaa769c5e76e51a4dc23c84bcfc87bd70d9dca7f1d54

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