How provizio/provizio_dds works
Project Type and Purpose
• This is an open-source multi-language library (“provizio_dds”) providing a thin, high-level C++/Python API over eProsima Fast-DDS for real-time data distribution in robotics (Provizio products) and ROS2 interoperability. It also includes a point-cloud accumulation/fusion module in Python.
File‐Structure Analysis
• Top‐level build: CMakeLists.txt drives the C++ library build; setup.py and python/ folder drive the Python package.
• /provizio/dds: C++ headers for DomainParticipant, Publisher, Subscriber, QoS defaults, common utilities.
• src: core C++ implementations (e.g. domain_participant.cpp).
• python/: Python modules wrapping the C++ core (provizio_dds.py), plus utility modules (accumulation.py, gps_utils.py, point_cloud2.py), and __init__.py under inits for bootstrap.
• cache/, cmake/: build‐and‐dependency support.
• test/: C++ examples/tests (simplest_pub_sub, reliable_pub_sub, ROS interop) and Python test suite.
• .github/workflows: CI scripts for building C++ and Python packages and running tests.
Key Architectural Insights from README
• C++ and Python layers both expose:
• DomainParticipant factory
• Publisher<T> API
• Subscriber<T> API
• Built on top of eProsima Fast-DDS (linked as external project if not installed).
• Supports ROS2 message types (std_msgs, sensor_msgs) via IDL code generation.
• Python layer uses pip installation, bundles precompiled C++ extension modules.
• Accumulation module combines point‐cloud and localization topics into fused point clouds.
Components to Capture
A. Core C++ Layer
• Namespace provizio::dds
• DomainParticipant
• Publisher<T>
• Subscriber<T>
• qos_defaults, common utilities
• Underlying Fast-DDS (fastrtps, fastcdr)
B. Python Binding Layer
• provizio_dds Python extension (C++ binding via pybind11 or similar)
• Python modules: Publisher, Subscriber, QoS wrappers
• accumulation.DDSPointCloudsAccumulator
• utility modules (gps_utils, point_cloud2)
C. Build & Packaging
• CMake build orchestrator
• ExternalProject_Add for Fast-DDS if absent
• setup.py for Python packaging, pip install
D. External Dependencies
• eProsima Fast-DDS (network middleware)
• ROS2 message IDLs (std_msgs, sensor_msgs via provizio_dds_idls)
• libssl, C++14, Python3
E. User Applications & Tests
• C++ example executables (simplest_publisher, subscriber, reliable_pub_sub, ros_interop)
• Python scripts/tests (python_publisher, python_subscriber, accumulation_test)
Relationships & Data Flows
• User App → provizio_dds API (C++ or Python) → DomainParticipant → DDS Network
• Publisher API → serializes typed messages → Fast-DDS → wire
• Subscriber API ← deserializes messages from Fast-DDS → invokes user callback
• accumulation.DDSPointCloudsAccumulator: subscribes to multiple topics (point cloud, odometry) and produces fused data to client code
• Build Tools → drive compilation, code-generation, packaging
Architectural Patterns & Principles
• Layered abstraction: high-level provizio_dds API sits on top of Fast-DDS
• Adapter/Facade: uniform Publisher/Subscriber interface hiding DDS complexities
• Language bindings: single core C++ implementation with multi-language frontends (C++ API + Python wrappers)
• Automated build & CI pipelines ensure consistency across C++ and Python deliverables
Essential Elements
• Clear component names and interfaces
• Test clients as examples of usage