Contents

Introduction

• Introduction
  • What can PandABlocks do?
  • How is the documentation structured?
    • Using an existing PandABlocks device
    • Generating a new set of Blocks for a PandABlocks device
    • Extending the functionality of a PandABlocks device
    • Working on the core autogeneration framework

Tutorials

• Blinking LEDs Tutorial
  • Opening the GUI
  • Loading the tutorial design
  • How the design works
  • Conclusion
• Position Capture Tutorial
• Position Compare Tutorial
• Snake Scan Tutorial

Reference

• Available Blocks
  • BITS - Soft inputs and constant bits
    • Fields
    • Outputs follow parameters
  • CALC - Position Calc
    • Fields
    • Adding inputs
    • Scaling
  • CLOCKS - Configurable clocks
    • Fields
    • Setting clock period parameters
    • All clocks have the same starting point
  • COUNTER - Up/Down pulse counter
    • Fields
    • Counting pulses
    • Rollover
    • Edge cases
  • DIV - Pulse divider
    • Fields
    • Which output do pulses go to
    • Reset conditions
  • FILTER - Filter
    • Fields
    • Difference
    • Average
  • LUT - 5 Input lookup table
    • Fields
    • Testing Function Output
    • Changing the function in a test
    • Edge triggered inputs
  • PCOMP - Position Compare
    • Fields
    • Position compare is directional
    • Internal statemachine
    • Not generating a pulse more than once
    • Guessing the direction
    • Interrupting a scan
    • Position compare on absolute values
    • Relative position compare
    • Use as a Schmitt trigger
  • PGEN - Position Generator
    • Fields
    • Normal operation
  • POSENC - Quadrature and step/direction encoder
    • Fields
    • Quadrature
    • Step/Direction
  • PULSE - One-shot pulse delay and stretch
    • Fields
    • Zero Delay
    • Zero Width
    • Width and Delay
    • Different Edge Activation
    • Pulse period error
  • QDEC - Quadrature Decoder
    • Fields
    • Counting
    • Resetting
    • Limitations
  • SEQ - Sequencer
    • Fields
    • Sequencer Table Line Composition
    • Generating fixed pulse trains
    • Statemachine
    • External trigger sources
    • Prescaler
    • Interrupting a sequence
    • Table rewriting
  • SRGATE - Set Reset Gate
    • Fields
    • Normal conditions
    • Disabling the block
    • Active edge configure conditions
    • Set-reset conditions
  • INENC - Input encoder
    • Fields
  • LVDSIN - LVDS Input
    • Fields
  • LVDSOUT - LVDS Output
    • Fields
  • OUTENC - Output encoder
    • Fields
  • PCAP - Position Capture
    • Fields
    • Arming
    • Capturing fields
    • Pos bus capture
      • Mode 0 - Value
      • Mode 1 - Difference
      • Mode 2/3 - Sum Lo/Hi
      • Mode 4/5 - Min/Max
    • Number of samples
    • Timestamps
    • Bit bus capture
    • Triggering options
    • Error conditions
  • SYSTEM - System control FPGA
    • Fields
  • TTLIN - TTL Input
    • Fields
  • TTLOUT - TTL Output
    • Fields
• Contributing
  • Running the tests
  • Writing VHDL
  • Writing Python
  • Documentation
  • Release Checklist
• Assembling Blocks into an App
  • App ini file
    • The [.] section
    • [BLOCK] sections
  • App build process
• Writing a Block
  • Modules
  • Block ini
    • The [.] section
    • [FIELD] sections
    • Extra Field Keys
  • Block Simulation
  • Timing ini
    • The [.] section
    • [TEST] sections
  • Target ini
    • The [.] section
    • [BLOCK] sections
  • Writing docs
  • Block VHDL entity
• Autogeneration framework architecture
  • Wrappers
  • Config_d entries
  • Test benches
    • Required signals in the block
    • Read expected.csv
    • Compare output signals
• Change Log
  • Unreleased
• Glossary
  • App
  • Block
  • Field
  • Module
  • PandABox
  • PandABlocks Device
  • Target Platform
  • Zpkg