Welcome to Rogue’s documentation!

Rogue is a SLAC Python Based Hardware Abstraction and Data Acquisition System. Look at our Introduction page for information about Rogue.

This is currently a work in progress and updated from the doc_updates branch of Rogue. New documentation is being added incrementally over time.

Find other helpful links(slack channel, Jira, etc) on confluence.

Contents:

• Introduction
  • Goals of Rogue
  • Structure of Rogue
• Tutorials
  • Starting Tutorials
    • Creating a Custom Pyrogue Device
    • Basic Pyrogue Tree Tutorial
    • Python OsMemMaster Class Documentation
    • Full Example Root Code
  • Complex Tutorials
• 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
    • 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
    • Install XMING
    • Install Ubuntu On Windows
  • Setting Up Rogue In Yocto
• PyRogue Tree
  • Node
    • Node Class Description
  • Root
    • Key Attributes
    • Key Methods
    • Yaml File Configuration
    • Included Command Objects
    • Included Variable Objects
  • Device
    • Device Definition
    • Special Device Subclasses
    • Custom Device Classes
    • Device Class Documentation
    • Python Device Example
    • C++ Device Example
  • Command
    • BaseCommand
    • Python Command Example
    • C++ Command Example
  • Variable
    • LinkVariable
    • LocalVariable
    • RemoteVariable
    • BaseVariable Class Documentation
    • Python Variable Example
    • C++ Variable Example
• 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
    • Stream Interface Class Descriptions
  • Memory Interface
    • Connecting Memory Elements
    • Memory Master Example
    • Memory Slave Example
    • Memory Hub Example
    • Using The TCP Bridge
    • Blocks & Models
    • Advanced Usage Of Blocks
    • Memory Interface Class Descriptions
  • Simulation Interfaces
    • Memory Space Emulation
    • PGP2B Simulation
    • Sideband Simulation
  • Python Interfaces
    • Python Stream Variable
    • OsCommandMemorySlave
    • Python ZMQServer
  • SQL Logging Interface
  • Wrapping Rogue In C++
• Utilities
  • File I/O Utilities
    • Writing Frames To A File
    • Reading Frames From A File
    • Custom Writers
    • Python File Reader
    • File Operation Classes
  • PRBS Utilities
    • Generating PRBS Frames
    • Receiving PRBS Frames
    • PRBS Utilities
  • Compression Utilities
    • Compressing Frames
    • Decompressing Frames
    • Compression Classes
• Hardware
  • Generic AXI Hardware Interface
    • Using The AxiStreamDma Class
    • Using The AxiMemMap Class
    • Additional AxiStreamDma Features
    • AXI Hardware Interface Class Descriptions
  • PGP Card Hardware Interface
    • PGP Hardware Interface Class Descriptions
  • Raw Hardware Interface
    • Using The MemMap Class
    • Hardware Interface Class Descriptions
• Protocols
  • UDP Protocol
    • UDP Protocol Client
    • UDP Protocol Server
    • UDP Protocol Class Descriptions
  • RSSI Protocol
    • RSSI Protocol Client
    • RSSI Protocol Server
    • RSSI Protocol Class Descriptions
  • Packetizer Protocol
    • Packetizer Protocol Core
    • Packetizer Protocol CoreV2
    • Packetizer Protocol Class Descriptions
  • Network Wrapper
  • Batcher Protocol
    • Batcher Protocol InverterV1
    • Batcher Protocol SplitterV1
    • Batcher Protocol Class Descriptions
  • EPICSV4 Protocol
  • SRP Protocol
    • SRP Protocol Version 0
    • SRP Protocol Version 3
    • SRP Protocol Command
    • SRP Protocol Class Descriptions
  • 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

Please email rherbst@slac.stanford.edu if you see any errors or have any questions about anything in the current documentation. We are still adding content and flushing out errors and typos.

Indices and tables

• Index

• Module Index

• Search Page