Table of Contents

Use the left sidebar to navigate sections and search documentation content.

Contents:

• PyRogue Tree Getting Started Guide
  • Recommended learning path
  • External hardware-oriented walkthrough
• Advanced Tutorials
• PyRogue Tree
  • Node
    • Block
    • Groups
    • Node Class Description
  • Root
    • Key Attributes
    • Key Methods
    • Lifecycle: start(), stop(), and _rootAttached()
    • Temporarily Blocking Polling
    • ZmqServer Interface
    • Yaml File Configuration
    • Included Command Objects
    • Included Variable Objects
    • Root Class Documentation
  • PollQueue
    • What it does
    • Block-Level Scheduling Behavior
    • Control and Lifecycle
    • Usage Examples
    • PollQueue Class Documentation
  • Device
    • Device Definition
    • Special Device Subclasses
    • Device Class Documentation
  • Command
    • Command types
    • Subtypes
    • BaseCommand Class Documentation
  • Variable
    • Variable Types
    • When to use each type
    • Common attributes and behavior
    • Implementation Boundary (Python and C++)
    • BaseVariable Class Documentation
  • Model API
    • Related Documentation
    • Utility Functions
    • Base Model
    • Common Built-in Models
  • Blocks & Models
    • How Variables, Models, and Block Methods Tie Together
    • Custom Models
    • Using Custom Models
    • Pre-Allocating Blocks
  • Advanced Usage Of Blocks
    • Model-Driven Method Dispatch
    • Conversion vs Transaction
    • Packing Rules and Variable Layout
• Interfaces
  • Client Interfaces
    • Using The Command Line Interface
    • Simple Client Interface
    • Virtual Client Interface
  • Stream Interface
    • Connecting Streams
    • Sending Frames
    • Receiving Frames
    • Using The TCP Bridge
    • Using A Fifo
    • Using A Filter
    • Using A Rate Drop Object
    • Debugging Streams
  • Memory Interface
    • Connecting Memory Elements
    • Memory Master Example
    • Memory Slave Example
    • Memory Hub Example
    • Using The TCP Bridge
  • Simulation Interfaces
    • Memory Space Emulation
    • PGP2B Simulation
    • Sideband Simulation
  • Python Interfaces
    • Python Stream Variable
    • OsCommandMemorySlave
    • OsMemMaster Device Example
    • Python ZMQServer
  • SQL Logging Interface
  • Wrapping Rogue In C++
    • Creating a root wrapper
    • Node traversal and variable access
    • Commands
    • Variable listeners (root only)
    • Reference example
  • Rogue Version Helper
    • Notes
    • Python examples
    • C++ examples
• Utilities
  • File I/O Utilities
    • Rogue File Data Format
    • Writing Frames To A File
    • Reading Frames From A File
    • Custom Writers
    • Python File Reader
  • PRBS Utilities
    • Generating PRBS Frames
    • Receiving PRBS Frames
  • HLS Utilities
    • HLS Register Interface Parser
  • Compression Utilities
    • Compressing Frames
    • Decompressing Frames
• Hardware
  • Generic AXI Hardware Interface
    • Using The AxiStreamDma Class
    • Using The AxiMemMap Class
    • Additional AxiStreamDma Features
  • Raw Hardware Interface
    • Using The MemMap Class
• Protocols
  • UDP Protocol
    • UDP Protocol Client
    • UDP Protocol Server
  • RSSI Protocol
    • Protocol documentation
    • How RSSI classes fit together
    • Python usage example
    • See also
  • Packetizer Protocol
    • Packetizer Protocol Core
    • Packetizer Protocol CoreV2
  • Network Wrapper
    • Overview
    • When to use
    • Key constructor arguments
    • Typical Root integration
    • Server mode (less common)
    • Available helper methods/commands
    • See also
  • Batcher Protocol
    • How the classes fit together
    • Usage examples
  • EPICSV4 Protocol
  • SRP Protocol
    • SRP Protocol Version 0
    • SRP Protocol Version 3
    • SRP Protocol Command
  • Xilinx Protocols
    • Typical usage
    • Python example
    • C++ example
    • JtagDriver notes
    • API references
  • UART Protocol
  • Pyrogue Protocols
    • Epics PV Holder Protocol
    • Epics PV Server Protocol
• Logging In Rogue
• Creating Custom Modules
  • Custom Module Source
  • Building The Custom Module
  • Wrapping Custom Module With PyRogue Device
  • Testing The Custom Module
    • Testing With EPICS
    • Testing With A GUI
• Using the PyDM Gui
  • Starting The Rogue PyDM GUI
    • Using The Command Line
    • Using A Python Script
  • Starting The Rogue PyDM Timeplot GUI
    • Using The Command Line
  • Channel URLS
    • URL Suffix
  • Rogue Widgets
• Migration Notes
  • Migrating To Rogue V6
    • ZmqServer
    • SqlLogger
    • Root Configuration Streaming
    • EPICS Version 3 Channel Access Server
    • RawWrite and RawRead
    • Setting pollInterval
    • Previously Deprecated Legacy GUI has Been Removed
• Installing & Compiling Rogue
  • Installing Rogue With Miniforge
    • Getting Miniforge
    • Creating A Rogue Environment
    • Using Rogue In Miniforge
    • Installing Rogue In Existing Environment
    • Updating Rogue In Miniforge
    • Deleting Miniforge Environment
  • Building Rogue Inside Miniforge
    • Prerequisites
    • Getting Miniforge
    • Downloading Rogue & Creating Miniforge Environment
    • Building Rogue In Miniforge
    • Using Rogue In Miniforge
    • Updating Rogue In Miniforge
    • Building and Viewing the Docs
    • Deleting Miniforge Environment
  • Installing Rogue Docker
    • How To Get The Container
    • How To Run The Container
    • GUI On A Linux OS
    • GUI On A MAC OS
    • How To Build A Custom Docker Image With Rogue
  • Building Rogue From Source
    • Installing Packages Required For Rogue
    • Building & Installing Rogue
    • Cross-compiling Rogue
  • Compiling A Rogue Application
  • Rogue and Miniforge behind a firewall
  • Setting Up Ubuntu On Windows
    • WSL2 Graphics Support
    • Install Ubuntu On Windows
  • Setting Up Rogue In Yocto
• API Reference
  • Python API
    • Python API
  • C++ API