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 server --port 3333 --interactive
enode-host gui --port 3333

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 or run enode-host server instead.
  • 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.

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.5.tar.gz (68.1 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.5-py3-none-any.whl (80.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for enode_host-0.1.5.tar.gz
Algorithm Hash digest
SHA256 169fed073c1f1a81ac06af9d37c93de3b4d53646155a1ebdaa2c5a8880ca165e
MD5 68d82e9c562fb64a50c923d01a43cf2a
BLAKE2b-256 ef243dc3bd9eedeeb4a97a1613222624058ce18f6c79193607d4a2e1ef90eec7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for enode_host-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b3d29cb3feb96de32cef026d3d9101a9309f421bda7cbd37416e1bafed2c5365
MD5 503ebfa742894b5345cd068804556c90
BLAKE2b-256 4444d5eae27e9a92dada8108e2c5bbce6ea2974cd91e53362448b3de6009716c

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