Moku API

# Gigabit Streamer (Gigabit Streamer+)

The Gigabit Streamer instrument streams data by transmitting and/or receiving UDP packets through the SFP and QSFP ports at gigabit speeds. There are two versions of Moku Gigabit Streamer:

  • Gigabit Streamer streams through up to two 10 Gbit/s SFP ports
  • Gigabit Streamer+ streams through the QSFP port at higher gigabit speeds (subject to export control)

If you are using the Moku Gigabit Streamer instrument directly through the REST API, the instrument name as used in the URL is gs(and gsp for the Gigabit Streamer + variant).

Gigabit Streamer Plus

If you are using the Moku Gigabit Streamer+ instrument, all commands are the same as for the Gigabit Streamer Instrument. Call your Gigabit Streamer+ instrument with the following object names:

  • Python: GigabitStreamerPlus
  • Matlab: MokuGigabitStreamerPlus
  • cURL: gsp

# Note on enabling outputs

The output switch shown in the Moku App is enabled by default when set_output() is called. To effectively gate all outputs off or on, manually disable or enable each output in sequence.

Functions

Core

  • Multi-Instrument: Gigabit Streamer in multi-instrument context
  • enable_input: Enable or disable an input channel
  • getters: Gigabit Streamer - getter functions
  • load_settings: Load a previously saved `.mokuconf` settings file into the instrument
  • reset_receive_status: Reset the receive status, overflow and underflow counters.
  • save_settings: Save instrument settings to a file
  • set_acquisition: Configure acquisition mode and sample rate
  • set_defaults: Reset the instrument to its default configuration
  • set_frontend: Configures the input impedance, coupling, gain, and bandwidth for each channel.
  • set_interpolation: Configure interpolation mode for outgoing waveform data
  • set_local_network: Configure the local IP address, port and optional multicast address for receiving/transmitting.
  • set_outgoing_packets: Configure outgoing packet maximum transmission unit (MTU)
  • set_output: Enable and configure an output channel
  • set_remote_network: Configure the remote destination IP, port and MAC address for outgoing packets
  • start_sending: Start transmitting packets for a duration, optionally with a trigger, delay or on a gated signal
  • stop_sending: Stop any ongoing packet transmission
  • summary: Returns a short summary of current instrument state

Multi-instrument Context →