Skip to main content

Hakoniwa PDU communication library for Python

Project description

hakoniwa-pdu-python

This is a Python PDU communication library for the Hakoniwa simulator.
It allows easy sending/receiving of PDU binary data and conversion to/from JSON over WebSocket.


📦 Installation

pip install hakoniwa-pdu

Check the installed version:

pip show hakoniwa-pdu

🔧 Environment Variables

You can specify the directory containing .offset files used for PDU conversion:

export HAKO_BINARY_PATH=/your/path/to/offset

If not set, the default path will be:

/usr/local/lib/hakoniwa/hako_binary/offset

🚀 Example Usage

Read a PDU from drone using test script

The following sample script receives the pos PDU from the drone and converts it into JSON.

tests/sample.py:

# (your existing sample.py content goes here)

Run example

python tests/sample.py \
  --config ./config/pdudef/webavatar.json \
  --uri ws://localhost:8765

📁 Package Structure

hakoniwa_pdu/
├── pdu_manager.py                  # Manages PDU lifecycle
├── impl/
│   ├── websocket_communication_service.py  # WebSocket implementation
│   ├── pdu_convertor.py            # Binary ⇔ JSON conversion
│   ├── hako_binary/
│   │   └── *.py (Handles offsets and binary layout)
├── resources/
│   └── offset/                     # Offset definition files

🔗 Links


📚 Documentation

For detailed API usage, refer to the full API reference:

➡️ API Reference (api-doc.md)


📜 License

MIT License - see LICENSE for details.

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

hakoniwa_pdu-0.7.0.tar.gz (106.8 kB view details)

Uploaded Source

Built Distribution

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

hakoniwa_pdu-0.7.0-py3-none-any.whl (345.0 kB view details)

Uploaded Python 3

File details

Details for the file hakoniwa_pdu-0.7.0.tar.gz.

File metadata

  • Download URL: hakoniwa_pdu-0.7.0.tar.gz
  • Upload date:
  • Size: 106.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for hakoniwa_pdu-0.7.0.tar.gz
Algorithm Hash digest
SHA256 b6a55b6318f136022d4f1ff81e320966d776bdb762f669addd9fefe31debabb7
MD5 b63f82847000b5e8e036ef7761870f5a
BLAKE2b-256 b483601bbdd6cb543965be7e38f447331ab652b465736d9522933e4c89fc6681

See more details on using hashes here.

File details

Details for the file hakoniwa_pdu-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: hakoniwa_pdu-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 345.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for hakoniwa_pdu-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99081219ac944d23a8b2faa9845fc26336fa7e376deba66cf6f9788df6b80b2a
MD5 b5e98e28177d836102374bcc7addb81c
BLAKE2b-256 94d3ad3a18401023386bb6f61d793c2290eea39e15fb2bd7f2f00e5a07101e63

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