Welcome to UMAAPy’s documentation!

The UMAAPy SDK provides a comprehensive software framework for autonomous maritime operations, leveraging DDS middleware for robust, scalable, and real-time data communication. UMAAPy aims to facilitate the rapid development and deployment of maritime autonomy systems by abstracting core UMAA components and integrating them seamlessly through event-driven mechanisms.

Features

1. ReportProvider: DDS writer abstraction to publish UMAA reports to the DDS bus.

2. ReportConsumer: DDS reader abstraction to consume incoming UMAA reports.

3. CommandProvider: DDS reader and writer remote procedure call like abstraction for defining business logic for incoming commands.

4. CommandConsumer: DDS reader and writer abstraction for commanding remote UMAA services.

5. LargeSet: DDS reader and writer abstraction for the UMAA large set data structure topics.

6. LargeList: DDS reader and writer abstraction for the UMAA large list data structure topics.

7. Specializations: DDS reader and writer abstraction for UMAA generalization/specialization topic relationships.

UMAAPy Documentation

• Installation
• Getting Started
  • Minimal Reader/Writer
  • Minimal Report Provider/Consumer
  • Minimal Command Provider/Consumer
• Developing UMAAPy
  • Contributor Environment
  • Type Generation
  • Testing Workflow
• Multi-Topic UMAA
  • Overview
  • Quick Start (Readers)
  • Quick Start (Writers)
  • Integration Test Use Cases
  • API Reference Highlights

API Documentation

• API Documentation
  • core
  • util

Architecture Decisions

• Architecture Decision Records
  • Conventions