Welcome to Rogue’s documentation!

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

Contents:

• Interfaces
  • 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
    • Memory Interface Class Descriptions
  • Client Interfaces
    • Using The Command Line Interface
    • Simple Client Interface
    • Virtual Client Interface
  • Simulation Interfaces
    • Memory Space Emulation
    • PGP2B Simulation
    • Sideband Simulation
  • SQL Logging Interface
• 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
• Utilities
  • File I/O Utilities
    • Writing Frames To A File
    • Reading Frames From A File
    • Custom Writers
    • Python File Reader
    • File Operation Utilities
  • PRBS Utilities
    • Generating PRBS Frames
    • Receiving PRBS Frames
    • PRBS Utilities
  • Compression Utilities
    • Compressing Frames
    • Decompressing Frames
    • Compression Classes
• Protocols
  • Batcher Protocol
  • EPICSV3 Protocol
  • EPICSV4 Protocol
  • Network Protocols
  • Packetizer Protocol
  • RSSI Protocol
  • SRP Protocol
  • UART 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
• Installing & Compiling Rogue
  • Installing Rogue With Anaconda
    • Getting Anaconda
    • Creating A Rogue Environment
    • Using Rogue In Anaconda
    • Installing Rogue In Existing Environment
    • Updating Rogue In Anaconda
    • Deleting Anaconda Environment
  • Building Rogue Inside Anaconda
    • Getting Anaconda
    • Downloading Rogue & Creating Anaconda Environment
    • Building Rogue In Anaconda
    • Using Rogue In Anaconda
    • Updating Rogue In Anaconda
    • Deleting Anaconda Environment
    • Special Steps For MacOS
  • Installing Rogue Docker
    • How To Get The Container
    • How To Run The Container
    • GUI On A Linux OS
    • GUI On A MAX 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 Anaconda behind a firewall
  • Setting Up Ubuntu On Windows
    • Install XMING
    • Install Ubuntu On Windows
  • Setting Up Rogue In Petalinux

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