CycloneDDS Python

Cyclone DDS Python is a modern and easy to use binding for Cyclone DDS. It provides access to almost all features available in the CycloneDDS C API while abstracting all of C’s quirks and hassles.

Features

• Modern Python API for python 3.7+ (python 3.11 support experimental while it is in alpha)

• Object oriented design, taking care of any C memory management under the hood

• (Eventually) fully type-hinted and documented API that your IDE will love

Getting started

Getting your hands dirty for the first time? Here are some points to get started for any skill level.

• First steps: first_steps_with_python | Introduction | Your first Python DDS application

• Usage:

  1. IDL datatypes in Python

  2. Publishing and subscribing

  3. Working with Qos

  4. Conditions and Waitsets

  5. Listeners

  6. Using built-in topics

• Examples: are available in the repository.

Getting help

Having trouble with something? These resources might provide some answers.

• Go to the Frequently Asked Questions.

• Look through the index or run a search.

• Report bugs on GitHub via the issue tracker.

• Ask your question on the GitHub discussions page.

API documentation

In-depth information on all parts of the API.

• Usage
  • Participant
• API
  • builtin
  • core
  • domain
  • dynamic
  • idl
    • idl.types
    • idl.annotations
  • internal
  • pub
  • core
  • sub
  • topic
  • util

Tools

Want to have some tools to help you use the CycloneDDS better? The tools we provided might help.

• Tools
  • Command line tool: ddsls
  • Command line tool: pubsub

Other

• Our GitHub repository

• Entry on Pypi for cyclonedds

• Changelog

• Learn more about DDS