Creating Custom Modules

Rogue can be extended with custom C++ modules when the built-in stream, protocol, or hardware helpers are not enough for an application. The usual workflow is:

• Implement the C++ class that provides the needed Rogue interface behavior.

• Build it as a Python-loadable shared library against an existing Rogue installation.

• Wrap the exported class in a PyRogue Device so it fits naturally into a larger tree.

• Test the module first in a minimal local setup, then in a larger control application.

The example in this section follows that path for a custom stream transmitter and receiver. It is still part of the broader Stream Interface story, but the same pattern also applies to other custom Rogue extensions.

Recommended Reading Order

1. Start with Custom Module Source to see the underlying C++ classes.

2. Continue with Building The Custom Module to build the shared library.

3. Then read Wrapping Custom Module With PyRogue Device to expose the module through PyRogue Device wrappers.

4. Finish with Testing The Custom Module to validate the module in a small working setup.

Example:

• Custom Module Source
• Building The Custom Module
• Wrapping Custom Module With PyRogue Device
• Testing The Custom Module

Related Topics

• Stream interface patterns and connection semantics: Stream Interface

• PyRogue tree integration and Device structure: PyRogue Tree

• Built-in module survey and extension context: Built-in Modules