openhop-core 1.1.1__tar.gz

openhop_core-1.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lloyd Newton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openhop_core-1.1.1/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include src *.py
+recursive-exclude src __pycache__
+recursive-exclude src *.pyc
+recursive-exclude src *.pyo

openhop_core-1.1.1/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: openhop_core
+Version: 1.1.1
+Summary: A Python MeshCore library with SPI LoRa radio support
+Author-email: Rightup <rightup@openhop.dev>
+License: MIT
+Project-URL: Homepage, https://github.com/pyMC-dev/openhop-core/
+Project-URL: Documentation, https://rightup.github.io/pymc_dev/openhop-core
+Project-URL: Repository, https://github.com/pyMC-dev/openhop-core.git
+Project-URL: Issues, https://github.com/pyMC-dev/openhop-core/issues
+Keywords: mesh,networking,lora,radio,iot,communication
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pycryptodome>=3.23.0
+Requires-Dist: PyNaCl>=1.5.0
+Requires-Dist: pyyaml>=6.0.0
+Provides-Extra: radio
+Requires-Dist: pyserial>=3.5; extra == "radio"
+Provides-Extra: hardware
+Requires-Dist: python-periphery>=2.4.1; extra == "hardware"
+Requires-Dist: spidev>=3.5; extra == "hardware"
+Requires-Dist: pyserial>=3.5; extra == "hardware"
+Requires-Dist: pyusb>=1.2.1; extra == "hardware"
+Provides-Extra: gpiod
+Requires-Dist: gpiod>=2.4.0; extra == "gpiod"
+Provides-Extra: websocket
+Requires-Dist: websockets>=11.0.0; extra == "websocket"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pyserial>=3.5; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.0; extra == "docs"
+Requires-Dist: mkdocs-git-committers-plugin-2>=1.2.0; extra == "docs"
+Provides-Extra: all
+Requires-Dist: openhop_core[dev,docs,hardware,websocket]; extra == "all"
+Dynamic: license-file
+
+# openHop Core
+
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://pymc-dev.github.io/openhop-core/)
+[![PyPI](https://img.shields.io/pypi/v/openhop-core)](https://pypi.org/project/openhop-core/)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+**openHop Core** is a Python reimplementation of [MeshCore](https://github.com/meshcore-dev/meshcore) — a lightweight, portable C++ library for multi-hop packet routing using LoRa radios. Designed for **Raspberry Pi** and similar hardware, openHop Core communicates with LoRa modules over **SPI**.
+
+> openHop Core is under active development. It's compatible with the original MeshCore protocol, but not yet as optimized or elegant as its C++ counterpart.
+
+## Documentation
+
+**Complete documentation is available at **[https://rightup.github.io/openhop-core/](https://pymc-dev.github.io/openhop-core/)**
+
+### Quick Links
+- [Node Usage Guide](https://pymc-dev.github.io/openhop-core/node/) - Guide for using MeshNode
+- [Examples](https://pymc-dev.github.io/openhop-core/examples/) - Working code examples
+- [API Reference](https://pymc-dev.github.io/openhop-core/api/) - Detailed API documentation
+
+## Quick Start
+
+### Installation
+
+> **Important**: On modern Python installations (Ubuntu 22.04+, Debian 12+), you may encounter `externally-managed-environment` errors when installing packages system-wide. Create a virtual environment first:
+>
+> ```bash
+> # Create virtual environment
+> python3 -m venv openhop_env
+>
+> # Activate virtual environment
+> # On Linux/Mac:
+> source openhop_env/bin/activate
+> # On Windows:
+> openhop_env\Scripts\activate
+> ```
+
+```bash
+# Install from PyPI
+pip install openhop-core
+
+# For hardware support (SX1262 radios)
+pip install openhop-core[hardware]
+
+# Install all dependencies
+pip install openhop-core[all]
+```
+
+### Basic Usage
+
+```python
+import asyncio
+from openhop_core import MeshNode, LocalIdentity
+from openhop_core.hardware.sx1262_wrapper import SX1262Radio
+
+async def main():
+    # Create radio (Waveshare HAT example)
+    radio = SX1262Radio(
+        bus_id=0, cs_pin=21, reset_pin=18,
+        busy_pin=20, irq_pin=16, txen_pin=6,
+        frequency=869525000, tx_power=22
+    )
+    radio.begin()
+
+    # Create mesh node
+    identity = LocalIdentity()
+    node = MeshNode(radio=radio, local_identity=identity)
+    await node.start()
+
+    print("Mesh node started!")
+
+asyncio.run(main())
+```
+
+For examples, see the [documentation](https://pymc-dev.github.io/openhop-core/examples/).
+
+## Hardware Support
+
+### Supported Radios
+- **Waveshare SX1262 LoRaWAN/GNSS HAT** - Popular Raspberry Pi LoRa module
+- **HackerGadgets uConsole** - All-in-one extension board with LoRa support
+- **FrequencyLabs meshadv-mini** - Raspberry Pi hat with E22-900M22S LoRa module
+
+### Requirements
+- Raspberry Pi (or compatible SBC)
+- SX1262 LoRa module
+- SPI interface enabled
+- Python 3.8+
+
+## What is MeshCore?
+
+MeshCore enables **long-range, decentralized communication** using **multi-hop packet routing**. Devices (nodes) forward packets through neighboring nodes to reach distant ones — no central infrastructure required.
+
+It occupies a middle ground between:
+
+| Project | Focus |
+|---------|-------|
+| [Meshtastic](https://meshtastic.org/) | Casual LoRa messaging |
+| [Reticulum](https://reticulum.network/) | Full encrypted networking stack |
+
+### Use Cases
+- Off-grid and emergency communication
+- Tactical or field mesh deployments
+- IoT mesh networks
+- Remote monitoring systems
+
+## Architecture
+
+```
+┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
+│   Application   │    │   MeshNode      │    │   Hardware      │
+│                 │    │                 │    │                 │
+│ • Text Messages │◄──►│ • Packet Routing│◄──►│ • SX1262 Radio  │
+│ • Advertisements│    │ • Identity Mgmt │    │ • SPI Interface │
+│ • Telemetry     │    │ • Event Service │    │ • GPIO Control  │
+│ • Group Channels│    │ • Repeater Mgmt │    │                 │
+└─────────────────┘    └─────────────────┘    └─────────────────┘
+```
+
+## Security
+
+- **Ed25519/X25519 cryptographic identities**
+- **End-to-end encryption** for messages
+- **CRC validation** for data integrity
+- **Secure key exchange** protocols
+
+## Project Structure
+
+```
+openHop Core/
+├── src/openhop_core/          # Main package
+│   ├── hardware/           # Radio hardware interfaces
+│   ├── node/               # MeshNode implementation
+│   ├── protocol/           # Packet protocols
+│   └── events/             # Event handling
+├── examples/               # Working examples
+│   ├── common.py           # Shared utilities
+│   ├── send_flood_advert.py
+│   ├── send_direct_advert.py
+│   └── ...
+├── docs/                   # MkDocs documentation
+│   ├── docs/               # Documentation source files
+│   ├── mkdocs.yml          # MkDocs configuration
+│   ├── requirements.txt    # Documentation dependencies
+│   └── serve-docs.sh       # Local development script
+├── .github/workflows/      # GitHub Actions
+│   └── deploy-docs.yml     # Documentation deployment pipeline
+└── tests/                  # Unit tests
+```
+
+## Contributing
+
+Contributions are welcome! Please see our [contributing guide](https://pymc-dev.github.io/openhop-core/contributing/) for details.
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/rightup/openHop Core.git
+cd openHop Core
+
+# Install development dependencies
+pip install -e .[dev]
+
+
+```
+
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Original [MeshCore](https://github.com/meshcore-dev/meshcore) C++ implementation
+- Waveshare and HackerGadgets for hardware support
+
+## Support
+
+- [Documentation](https://pymc-dev.github.io/openhop-core/)
+- [Issues](https://github.com/pymc-dev/openHop Core/issues)
+- [Discussions](https://github.com/pymc-dev/openHop Core/discussions)
+- [pyMC Discord](https://discord.gg/3s8MMaSTzq)
+- [Meshcore Discord](https://meshcore.gg/)
+
+---
+
+*Built with ❤️ for mesh networking enthusiasts*</content>

openhop_core-1.1.1/README.md

@@ -0,0 +1,188 @@
+# openHop Core
+
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://pymc-dev.github.io/openhop-core/)
+[![PyPI](https://img.shields.io/pypi/v/openhop-core)](https://pypi.org/project/openhop-core/)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+**openHop Core** is a Python reimplementation of [MeshCore](https://github.com/meshcore-dev/meshcore) — a lightweight, portable C++ library for multi-hop packet routing using LoRa radios. Designed for **Raspberry Pi** and similar hardware, openHop Core communicates with LoRa modules over **SPI**.
+
+> openHop Core is under active development. It's compatible with the original MeshCore protocol, but not yet as optimized or elegant as its C++ counterpart.
+
+## Documentation
+
+**Complete documentation is available at **[https://rightup.github.io/openhop-core/](https://pymc-dev.github.io/openhop-core/)**
+
+### Quick Links
+- [Node Usage Guide](https://pymc-dev.github.io/openhop-core/node/) - Guide for using MeshNode
+- [Examples](https://pymc-dev.github.io/openhop-core/examples/) - Working code examples
+- [API Reference](https://pymc-dev.github.io/openhop-core/api/) - Detailed API documentation
+
+## Quick Start
+
+### Installation
+
+> **Important**: On modern Python installations (Ubuntu 22.04+, Debian 12+), you may encounter `externally-managed-environment` errors when installing packages system-wide. Create a virtual environment first:
+>
+> ```bash
+> # Create virtual environment
+> python3 -m venv openhop_env
+>
+> # Activate virtual environment
+> # On Linux/Mac:
+> source openhop_env/bin/activate
+> # On Windows:
+> openhop_env\Scripts\activate
+> ```
+
+```bash
+# Install from PyPI
+pip install openhop-core
+
+# For hardware support (SX1262 radios)
+pip install openhop-core[hardware]
+
+# Install all dependencies
+pip install openhop-core[all]
+```
+
+### Basic Usage
+
+```python
+import asyncio
+from openhop_core import MeshNode, LocalIdentity
+from openhop_core.hardware.sx1262_wrapper import SX1262Radio
+
+async def main():
+    # Create radio (Waveshare HAT example)
+    radio = SX1262Radio(
+        bus_id=0, cs_pin=21, reset_pin=18,
+        busy_pin=20, irq_pin=16, txen_pin=6,
+        frequency=869525000, tx_power=22
+    )
+    radio.begin()
+
+    # Create mesh node
+    identity = LocalIdentity()
+    node = MeshNode(radio=radio, local_identity=identity)
+    await node.start()
+
+    print("Mesh node started!")
+
+asyncio.run(main())
+```
+
+For examples, see the [documentation](https://pymc-dev.github.io/openhop-core/examples/).
+
+## Hardware Support
+
+### Supported Radios
+- **Waveshare SX1262 LoRaWAN/GNSS HAT** - Popular Raspberry Pi LoRa module
+- **HackerGadgets uConsole** - All-in-one extension board with LoRa support
+- **FrequencyLabs meshadv-mini** - Raspberry Pi hat with E22-900M22S LoRa module
+
+### Requirements
+- Raspberry Pi (or compatible SBC)
+- SX1262 LoRa module
+- SPI interface enabled
+- Python 3.8+
+
+## What is MeshCore?
+
+MeshCore enables **long-range, decentralized communication** using **multi-hop packet routing**. Devices (nodes) forward packets through neighboring nodes to reach distant ones — no central infrastructure required.
+
+It occupies a middle ground between:
+
+| Project | Focus |
+|---------|-------|
+| [Meshtastic](https://meshtastic.org/) | Casual LoRa messaging |
+| [Reticulum](https://reticulum.network/) | Full encrypted networking stack |
+
+### Use Cases
+- Off-grid and emergency communication
+- Tactical or field mesh deployments
+- IoT mesh networks
+- Remote monitoring systems
+
+## Architecture
+
+```
+┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
+│   Application   │    │   MeshNode      │    │   Hardware      │
+│                 │    │                 │    │                 │
+│ • Text Messages │◄──►│ • Packet Routing│◄──►│ • SX1262 Radio  │
+│ • Advertisements│    │ • Identity Mgmt │    │ • SPI Interface │
+│ • Telemetry     │    │ • Event Service │    │ • GPIO Control  │
+│ • Group Channels│    │ • Repeater Mgmt │    │                 │
+└─────────────────┘    └─────────────────┘    └─────────────────┘
+```
+
+## Security
+
+- **Ed25519/X25519 cryptographic identities**
+- **End-to-end encryption** for messages
+- **CRC validation** for data integrity
+- **Secure key exchange** protocols
+
+## Project Structure
+
+```
+openHop Core/
+├── src/openhop_core/          # Main package
+│   ├── hardware/           # Radio hardware interfaces
+│   ├── node/               # MeshNode implementation
+│   ├── protocol/           # Packet protocols
+│   └── events/             # Event handling
+├── examples/               # Working examples
+│   ├── common.py           # Shared utilities
+│   ├── send_flood_advert.py
+│   ├── send_direct_advert.py
+│   └── ...
+├── docs/                   # MkDocs documentation
+│   ├── docs/               # Documentation source files
+│   ├── mkdocs.yml          # MkDocs configuration
+│   ├── requirements.txt    # Documentation dependencies
+│   └── serve-docs.sh       # Local development script
+├── .github/workflows/      # GitHub Actions
+│   └── deploy-docs.yml     # Documentation deployment pipeline
+└── tests/                  # Unit tests
+```
+
+## Contributing
+
+Contributions are welcome! Please see our [contributing guide](https://pymc-dev.github.io/openhop-core/contributing/) for details.
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/rightup/openHop Core.git
+cd openHop Core
+
+# Install development dependencies
+pip install -e .[dev]
+
+
+```
+
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Original [MeshCore](https://github.com/meshcore-dev/meshcore) C++ implementation
+- Waveshare and HackerGadgets for hardware support
+
+## Support
+
+- [Documentation](https://pymc-dev.github.io/openhop-core/)
+- [Issues](https://github.com/pymc-dev/openHop Core/issues)
+- [Discussions](https://github.com/pymc-dev/openHop Core/discussions)
+- [pyMC Discord](https://discord.gg/3s8MMaSTzq)
+- [Meshcore Discord](https://meshcore.gg/)
+
+---
+
+*Built with ❤️ for mesh networking enthusiasts*</content>

openhop_core-1.1.1/pyproject.toml

@@ -0,0 +1,110 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openhop_core"
+version = "1.1.1"
+authors = [
+    {name = "Rightup", email = "rightup@openhop.dev"},
+]
+description = "A Python MeshCore library with SPI LoRa radio support"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications",
+    "Topic :: System :: Networking",
+]
+keywords = ["mesh", "networking", "lora", "radio", "iot", "communication"]
+dependencies = [
+    "pycryptodome>=3.23.0",
+    "PyNaCl>=1.5.0",
+    "pyyaml>=6.0.0",
+]
+
+[project.optional-dependencies]
+radio = ["pyserial>=3.5"]
+hardware = [
+    "python-periphery>=2.4.1",
+    "spidev>=3.5",
+    "pyserial>=3.5",
+    "pyusb>=1.2.1",
+]
+
+gpiod = ["gpiod>=2.4.0"]
+
+websocket = [
+    "websockets>=11.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pyserial>=3.5",
+    "black>=23.0.0",
+    "isort>=5.12.0",
+    "flake8>=6.0.0",
+    "mypy>=1.0.0",
+    "pre-commit>=3.0.0",
+]
+docs = [
+    "mkdocs>=1.5.0",
+    "mkdocs-material>=9.0.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.2.0",
+    "mkdocs-git-committers-plugin-2>=1.2.0",
+]
+all = ["openhop_core[hardware,websocket,dev,docs]"]
+
+[project.urls]
+Homepage = "https://github.com/pyMC-dev/openhop-core/"
+Documentation = "https://rightup.github.io/pymc_dev/openhop-core"
+Repository = "https://github.com/pyMC-dev/openhop-core.git"
+Issues = "https://github.com/pyMC-dev/openhop-core/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["openhop_core*"]
+exclude = ["__pycache__*", "*.pyc", "*.pyo"]
+
+[tool.black]
+line-length = 100
+target-version = ['py38']
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.flake8]
+max-line-length = 100
+extend-ignore = ["E203", "W503"]
+exclude = [
+    "src/openhop_core/hardware/lora/",
+    "examples/",
+    "__pycache__",
+    ".git",
+    ".tox",
+    "dist",
+    "*.egg-info"
+]
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "-ra -q"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+asyncio_mode = "auto"

openhop_core-1.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openhop_core-1.1.1/src/openhop_core/__init__.py

@@ -0,0 +1,37 @@
+"""
+openHop Core - A Python MeshCore library with SPI LoRa radio support
+Clean, simple API for building mesh network applications.
+"""
+
+__version__ = "1.1.1"
+
+# Core mesh functionality
+from .node.node import MeshNode
+from .protocol.crypto import CryptoUtils
+from .protocol.identity import LocalIdentity
+from .protocol.packet import Packet
+
+__all__ = [
+    # Core API
+    "MeshNode",
+    "LocalIdentity",
+    "Packet",
+    "CryptoUtils",
+    # Version
+    "__version__",
+]
+
+# Conditional import for CompanionRadio
+try:
+    from .companion.companion_radio import CompanionRadio
+
+    _COMPANION_AVAILABLE = True
+except ImportError:
+    _COMPANION_AVAILABLE = False
+    CompanionRadio = None
+
+if _COMPANION_AVAILABLE:
+    __all__.append("CompanionRadio")
+
+
+# End of mesh package exports