Built-in Devices

PyRogue includes reusable Device subclasses for common control, monitoring, and data-path tasks. These classes reduce boilerplate by packaging widely used patterns into configurable components that attach directly in your tree.

This section is intentionally limited to classes exposed in the top-level pyrogue namespace.

How These Fit In A Design

Built-in Devices are ordinary Device subclasses, so they participate in the same tree lifecycle and transaction flow as custom devices:

• Add them under a parent Device or directly under Root

• Bind memory/stream interfaces as needed

• Operate them through the same Variable and Command APIs as any other node

Use cases commonly include:

• Run control sequencing and rate management

• Stream capture and receive control surfaces

• Process supervision and script orchestration

Reading Path

The built-in devices fall into a few natural groups:

• Start with RunControl Device Class and Process Device Class if you are organizing software actions, acquisition loops, or operator-visible procedures.

• Use DataWriter Device Class and DataReceiver Device Class for tree-facing stream write and receive patterns.

• Use Built-in Modules for lower-level utilities and wrappers such as file I/O and PRBS modules that live outside the top-level pyrogue namespace.

Relationship To Core And Interfaces

For underlying behavior, see:

• Device

• Variable

• Client Interfaces

Related Topics

• Run control orchestration: RunControl Device Class

• Data capture/write path: DataWriter Device Class

• Data receive/read path: DataReceiver Device Class

• Lower-level modules and wrappers: Built-in Modules

• External process integration: Process Device Class

Built-in Devices:

• RunControl Device Class
• DataWriter Device Class
• DataReceiver Device Class
• Process Device Class