Skip to content

index.rst

Latest commit

 

History

History
63 lines (47 loc) · 1.69 KB

index.rst

File metadata and controls

63 lines (47 loc) · 1.69 KB
Raw

RTI UMAA Python SDK

Version 0.1.0

Service template framework for building UMAA-compliant unmanned maritime systems on RTI Connext DDS.

rtiumaapy provides reusable service template classes for the Unmanned Maritime Autonomy Architecture (UMAA).

Instead of hand-wiring DDS readers, writers, and state machines for every UMAA service, developers subclass pre-built templates, override async hooks, and let the SDK handle QoS, lifecycle, and protocol compliance.

Key facts:

  • 350 pre-wired services across 7 UMAA domains — ready to subclass
  • Code-free QoS — profiles loaded from XML and assigned automatically via topic_filter rules
  • Event-driven — all services use rti.asyncio with take_async()
  • Test isolation via dynamic partitions — each DDSContext assigns a unique GUID partition at runtime so parallel tests never cross-talk
  • Integration-level end-to-end DDS tests — full publish/subscribe round-trips with real DomainParticipant instances
.. toctree::
   :maxdepth: 2
   :caption: User Guide

   getting-started
   building-a-component
   qos-configuration
   vendor-interoperability
   ustm-testing
   troubleshooting


.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/dds-context
   api/base-service
   api/base-component
   api/command-provider
   api/command-consumer
   api/command-session
   api/report-provider
   api/report-consumer
   api/errors
   api/utilities
   api/services-library


.. toctree::
   :maxdepth: 1
   :caption: Project

   changelog
   exception-cleanup-findings-2026-05-18

Indices