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.8.0.tar.gz (107.0 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.8.0-py3-none-any.whl (345.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hakoniwa_pdu-0.8.0.tar.gz
  • Upload date:
  • Size: 107.0 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.8.0.tar.gz
Algorithm Hash digest
SHA256 907b7e38e09f1306705eb6ec5d4e48d2dfb859e443978e9aae1addf6cf97b548
MD5 4f4adca73da140802d893f3fe0ccbb81
BLAKE2b-256 88cfdf7b25f75125102b30f4e64b470d5ed3f46da268fea1d2e5af125f455fea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hakoniwa_pdu-0.8.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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e7b6db776d71917695c75b70f514841d387d51a028aa41b2a53f4b0837d1e6d
MD5 1a800e13706bb8218e971194bad48b61
BLAKE2b-256 4154f8ad1f2a1ae46fd72103ad0e6a54367ad5d291982331cfe19a4e409128d7

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