FIREQ Server API Reference

Welcome to the FIREQ Server API documentation. The server framework is divided into modular components handling system orchestration, network communications, experiment execution, and hardware nodes.

---

API Modules

• Runtime Management & Entry Point
• Server Core Entry Point
  • FIREQServer
• Experiment Execution Engine
  • SweepExperiment
• Network & Protocol Layer
  • FIREQNetworkPacket
  • NetworkDMAPayload
  • FIREQ_SERVER.network.protocol.get_command
  • FIREQ_SERVER.network.protocol.get_sweep_variables
  • ReceiveWorker
  • SendWorker
• System & Hardware Nodes
  • FIREQSystemNode
  • AcquisitionNode
  • SignalGeneratorNode
  • TriggerGeneratorNode
  • SwitchNode
  • DMANode
  • FIFONode
• Server Utilities & Exceptions
  • MemoryBoundedQueue
  • FIREQ_SERVER.utils.exceptions.FireqHardwareError
  • FIREQ_SERVER.utils.exceptions.DriverError
  • FIREQ_SERVER.utils.exceptions.TimingError
  • FIREQ_SERVER.utils.exceptions.ConfigurationError
  • FIREQ_SERVER.utils.exceptions.FrequencyError
  • FIREQ_SERVER.utils.exceptions.EnvelopeUploadError
  • FIREQ_SERVER.utils.exceptions.WaveCompilationError
  • FIREQ_SERVER.utils.exceptions.DMAError
  • FIREQ_SERVER.utils.exceptions.DMATimeoutError
  • FIREQ_SERVER.utils.exceptions.RecoverableDMAError
  • FIREQ_SERVER.utils.exceptions.HardwareResourceError
  • FIREQ_SERVER.utils.exceptions.HardwareStateError
  • FIREQ_SERVER.utils.exceptions.ClientDisconnectedError
  • FIREQ_SERVER.utils.exceptions.IncompleteTransferError
  • FIREQ_SERVER.utils.exceptions.InvalidPayloadError