generated: '2026-08-04'
method: derived
source: pypi:moku 4.3.0.1 (first-party Python client) cross-checked against https://apis.liquidinstruments.com/api/reference/
note: 'Liquid Instruments publishes no OpenAPI. This entity/operation graph was derived by statically
  parsing the official Python client library (PyPI moku 4.3.0.1, MIT), which is a one-to-one wrapper over
  the device REST API: each class carries an OPERATION_GROUP constant that becomes the /api/<group>/ path
  segment, and each public method name becomes the <action> segment. Nothing here is invented; every operation
  name below appears verbatim in the published client. This is an inventory of the surface, NOT an OpenAPI
  — no request or response schemas are asserted, because the provider does not publish them.'
model:
  style: action-oriented RPC grouped by instrument, not a resource/ERD data model
  root: a single Moku device (one owner at a time, addressed by IP)
  composition: A device runs one instrument at a time, or up to 4 (Moku:Pro / Moku:Lab 3-slot) or 5 (Moku:Delta)
    instruments simultaneously in Multi-instrument Mode, where each instrument occupies a numbered slot
    and is addressed at /api/slot<N>/<group>/<action>.
  relationships:
  - from: Moku
    to: MultiInstrument
    type: has_one
    via: set_instrument / get_instruments
  - from: MultiInstrument
    to: Instrument
    type: has_many
    via: slot number (1..5)
  - from: Moku
    to: Instrument
    type: has_one
    via: deployed instrument bitstream (single-instrument mode)
  - from: Instrument
    to: Frontend
    type: has_many
    via: set_frontend / get_frontend (per analog input channel)
  - from: Instrument
    to: Output
    type: has_many
    via: set_output / get_output (per analog output channel)
  - from: Moku
    to: PowerSupply
    type: has_many
    via: get_power_supplies / set_power_supply
  - from: Moku
    to: Clock
    type: has_one
    via: set_external_clock / set_blended_clock
summary:
  entities: 22
  instruments: 20
  total_operations: 522
entities:
- name: Moku
  kind: core
  operation_group: moku
  path: /api/moku/<action>
  operation_count: 30
  operations:
  - calibration_date
  - claim_ownership
  - delete
  - describe
  - download
  - firmware_version
  - get_blended_clock
  - get_configuration
  - get_external_clock
  - get_power_supplies
  - get_power_supply
  - list
  - modify_calibration
  - modify_hardware
  - mokuos_version
  - name
  - platform
  - reboot
  - relinquish_ownership
  - serial_number
  - set_blended_clock
  - set_configuration
  - set_connect_timeout
  - set_external_clock
  - set_power_supply
  - set_read_timeout
  - shutdown
  - summary
  - upload
  - upload_bitstream
  reference: https://apis.liquidinstruments.com/api/reference/
- name: MultiInstrument
  kind: mode
  operation_group: mim
  path: /api/mim/<action>
  operation_count: 13
  operations:
  - get_connections
  - get_dio
  - get_frontend
  - get_instruments
  - get_output
  - load_configuration
  - save_configuration
  - set_connections
  - set_dio
  - set_frontend
  - set_instrument
  - set_output
  - sync
  reference: https://apis.liquidinstruments.com/api/reference/mim
- name: ArbitraryWaveformGenerator
  kind: instrument
  operation_group: awg
  instrument_id: 15
  path: /api/awg/<action>
  slotted_path: /api/slot<N>/awg/<action>
  operation_count: 18
  operations:
  - burst_modulate
  - disable_modulation
  - enable_output
  - for_slot
  - generate_waveform
  - get_frontend
  - get_output_load
  - get_output_termination
  - load_settings
  - manual_trigger
  - pulse_modulate
  - save_settings
  - set_defaults
  - set_frontend
  - set_output_load
  - set_output_termination
  - summary
  - sync_phase
  client_source: moku/instruments/_awg.py
  reference: https://apis.liquidinstruments.com/api/reference/awg
  summary: ArbitraryWaveformGenerator instrument object.
- name: CustomInstrument
  kind: instrument
  operation_group: custominstrument
  instrument_id: 255
  path: /api/custominstrument/<action>
  slotted_path: /api/slot<N>/custominstrument/<action>
  operation_count: 12
  operations:
  - for_slot
  - get_control
  - get_controls
  - get_interpolation
  - get_status
  - load_settings
  - save_settings
  - set_control
  - set_controls
  - set_interpolation
  - summary
  - sync
  client_source: moku/instruments/_custominstrument.py
  reference: https://apis.liquidinstruments.com/api/reference/custominstrument
  summary: CustomInstrument instrument object.
- name: CustomInstrumentPlus
  kind: instrument
  operation_group: custominstrumentplus
  instrument_id: 254
  path: /api/custominstrumentplus/<action>
  slotted_path: /api/slot<N>/custominstrumentplus/<action>
  operation_count: 0
  operations: []
  client_source: moku/instruments/_custominstrument.py
  summary: CustomInstrumentPlus
- name: Datalogger
  kind: instrument
  operation_group: datalogger
  instrument_id: 7
  path: /api/datalogger/<action>
  slotted_path: /api/slot<N>/datalogger/<action>
  operation_count: 24
  operations:
  - disable_channel
  - enable_input
  - for_slot
  - generate_waveform
  - get_acquisition_mode
  - get_chunk
  - get_frontend
  - get_output_load
  - get_output_termination
  - get_samplerate
  - get_stream_status
  - load_settings
  - logging_progress
  - save_settings
  - set_acquisition_mode
  - set_frontend
  - set_output_load
  - set_output_termination
  - set_samplerate
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  - sync_output_phase
  client_source: moku/instruments/_datalogger.py
  reference: https://apis.liquidinstruments.com/api/reference/datalogger
  summary: Datalogger instrument object.
- name: DigitalFilterBox
  kind: instrument
  operation_group: digitalfilterbox
  instrument_id: 6
  path: /api/digitalfilterbox/<action>
  slotted_path: /api/slot<N>/digitalfilterbox/<action>
  operation_count: 39
  operations:
  - enable_output
  - enable_rollmode
  - for_slot
  - get_acquisition_mode
  - get_chunk
  - get_control_matrix
  - get_data
  - get_frontend
  - get_input_gain
  - get_input_offset
  - get_interpolation
  - get_output_gain
  - get_output_offset
  - get_samplerate
  - get_stream_status
  - get_timebase
  - load_settings
  - logging_progress
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_control_matrix
  - set_custom_filter
  - set_defaults
  - set_filter
  - set_frontend
  - set_hysteresis
  - set_input_gain
  - set_input_offset
  - set_interpolation
  - set_monitor
  - set_output_gain
  - set_output_offset
  - set_timebase
  - set_trigger
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  client_source: moku/instruments/_digitalfilterbox.py
  reference: https://apis.liquidinstruments.com/api/reference/dfb
  summary: DigitalFilterBox instrument object.
- name: FIRFilterBox
  kind: instrument
  operation_group: firfilter
  instrument_id: 10
  path: /api/firfilter/<action>
  slotted_path: /api/slot<N>/firfilter/<action>
  operation_count: 40
  operations:
  - enable_output
  - enable_rollmode
  - for_slot
  - get_acquisition_mode
  - get_chunk
  - get_control_matrix
  - get_data
  - get_frontend
  - get_input_gain
  - get_input_offset
  - get_interpolation
  - get_output_gain
  - get_output_offset
  - get_samplerate
  - get_stream_status
  - get_timebase
  - load_settings
  - logging_progress
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_by_frequency
  - set_by_time
  - set_control_matrix
  - set_custom_kernel_coefficients
  - set_defaults
  - set_frontend
  - set_hysteresis
  - set_input_gain
  - set_input_offset
  - set_interpolation
  - set_monitor
  - set_output_gain
  - set_output_offset
  - set_timebase
  - set_trigger
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  client_source: moku/instruments/_firfilter.py
  reference: https://apis.liquidinstruments.com/api/reference/fir
  summary: FIRFilterBox instrument object.
- name: FrequencyResponseAnalyzer
  kind: instrument
  operation_group: fra
  instrument_id: 9
  path: /api/fra/<action>
  slotted_path: /api/slot<N>/fra/<action>
  operation_count: 24
  operations:
  - disable_output
  - for_slot
  - fra_measurement
  - get_data
  - get_frontend
  - get_harmonic_multiplier
  - get_output
  - get_output_load
  - get_output_termination
  - get_sweep
  - load_settings
  - measurement_mode
  - save_settings
  - set_defaults
  - set_frontend
  - set_harmonic_multiplier
  - set_output
  - set_output_load
  - set_output_phase
  - set_output_termination
  - set_sweep
  - start_sweep
  - stop_sweep
  - summary
  client_source: moku/instruments/_fra.py
  reference: https://apis.liquidinstruments.com/api/reference/fra
  summary: FrequencyResponseAnalyzer instrument object.
- name: GenInst
  kind: instrument
  operation_group: geninst
  instrument_id: 253
  path: /api/geninst/<action>
  slotted_path: /api/slot<N>/geninst/<action>
  operation_count: 0
  operations: []
  client_source: moku/instruments/_custominstrument.py
  summary: GenInst
- name: GigabitStreamer
  kind: instrument
  operation_group: gs
  instrument_id: 12
  path: /api/gs/<action>
  slotted_path: /api/slot<N>/gs/<action>
  operation_count: 19
  operations:
  - enable_input
  - for_slot
  - get_frontend
  - get_receive_status
  - get_send_status
  - load_settings
  - reset_receive_status
  - save_settings
  - set_acquisition
  - set_defaults
  - set_frontend
  - set_interpolation
  - set_local_network
  - set_outgoing_packets
  - set_output
  - set_remote_network
  - start_sending
  - stop_sending
  - summary
  client_source: moku/instruments/_gs.py
  reference: https://apis.liquidinstruments.com/api/reference/gs
  summary: GigabitStreamer instrument object.
- name: GigabitStreamerPlus
  kind: instrument
  operation_group: gsp
  instrument_id: 13
  path: /api/gsp/<action>
  slotted_path: /api/slot<N>/gsp/<action>
  operation_count: 0
  operations: []
  client_source: moku/instruments/_gs.py
  summary: GigabitStreamerPlus instrument object.
- name: LaserLockBox
  kind: instrument
  operation_group: laserlockbox
  instrument_id: 16
  path: /api/laserlockbox/<action>
  slotted_path: /api/slot<N>/laserlockbox/<action>
  operation_count: 47
  operations:
  - enable_conditional_trigger
  - enable_rollmode
  - for_slot
  - get_acquisition_mode
  - get_aux_oscillator
  - get_chunk
  - get_data
  - get_demodulation
  - get_frontend
  - get_interpolation
  - get_output_limit
  - get_output_offset
  - get_pll
  - get_samplerate
  - get_scan_oscillator
  - get_setpoint
  - get_stream_status
  - get_timebase
  - load_settings
  - logging_progress
  - pll_reacquire
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_aux_oscillator
  - set_custom_filter
  - set_defaults
  - set_demodulation
  - set_digital_input_gain
  - set_filter
  - set_frontend
  - set_hysteresis
  - set_interpolation
  - set_monitor
  - set_output
  - set_output_limit
  - set_output_offset
  - set_pid_by_frequency
  - set_pll
  - set_scan_oscillator
  - set_setpoint
  - set_timebase
  - set_trigger
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  client_source: moku/instruments/_laserlockbox.py
  reference: https://apis.liquidinstruments.com/api/reference/llb
  summary: LaserLockBox instrument object.
- name: LockInAmp
  kind: instrument
  operation_group: lockinamp
  instrument_id: 8
  path: /api/lockinamp/<action>
  slotted_path: /api/slot<N>/lockinamp/<action>
  operation_count: 43
  operations:
  - enable_rollmode
  - for_slot
  - get_acquisition_mode
  - get_aux_output
  - get_chunk
  - get_data
  - get_demodulation
  - get_filter
  - get_frontend
  - get_gain
  - get_interpolation
  - get_outputs
  - get_pll
  - get_polar_theta_range
  - get_samplerate
  - get_stream_status
  - get_timebase
  - load_settings
  - logging_progress
  - pll_reacquire
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_aux_output
  - set_by_frequency
  - set_defaults
  - set_demodulation
  - set_filter
  - set_frontend
  - set_gain
  - set_hysteresis
  - set_interpolation
  - set_monitor
  - set_outputs
  - set_pll
  - set_polar_mode
  - set_timebase
  - set_trigger
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  - use_pid
  client_source: moku/instruments/_lockinamp.py
  reference: https://apis.liquidinstruments.com/api/reference/lia
  summary: LockInAmp instrument object.
- name: LogicAnalyzer
  kind: instrument
  operation_group: logicanalyzer
  instrument_id: 17
  path: /api/logicanalyzer/<action>
  slotted_path: /api/slot<N>/logicanalyzer/<action>
  operation_count: 35
  operations:
  - disable_pattern_generator
  - enable_rollmode
  - for_slot
  - get_analog_mode
  - get_data
  - get_decoder
  - get_pattern_generator
  - get_pin
  - get_pin_mode
  - get_pins
  - get_source
  - get_timebase
  - get_trigger
  - load_settings
  - restart_pattern
  - save_high_res_buffer
  - save_settings
  - set_analog_mode
  - set_can_decoder
  - set_decoder
  - set_defaults
  - set_i2c_decoder
  - set_i2s_decoder
  - set_parallel_bus_decoder
  - set_pattern_generator
  - set_pin
  - set_pin_mode
  - set_pins
  - set_source
  - set_spi_decoder
  - set_timebase
  - set_trigger
  - set_uart_decoder
  - set_usb_decoder
  - summary
  client_source: moku/instruments/_logicanalyzer.py
  reference: https://apis.liquidinstruments.com/api/reference/logicanalyzer
  summary: LogicAnalyzer instrument object.
- name: NeuralNetwork
  kind: instrument
  operation_group: neuralnetwork
  instrument_id: 128
  path: /api/neuralnetwork/<action>
  slotted_path: /api/slot<N>/neuralnetwork/<action>
  operation_count: 10
  operations:
  - describe_network
  - for_slot
  - load_settings
  - save_settings
  - set_defaults
  - set_input
  - set_input_sample_rate
  - set_output
  - summary
  - upload_network
  client_source: moku/instruments/_nn.py
  reference: https://apis.liquidinstruments.com/api/reference/nn
  summary: NeuralNetwork instrument object.
- name: Oscilloscope
  kind: instrument
  operation_group: oscilloscope
  instrument_id: 1
  path: /api/oscilloscope/<action>
  slotted_path: /api/slot<N>/oscilloscope/<action>
  operation_count: 31
  operations:
  - disable_input
  - enable_rollmode
  - for_slot
  - generate_waveform
  - get_acquisition_mode
  - get_data
  - get_frontend
  - get_interpolation
  - get_output_load
  - get_output_termination
  - get_samplerate
  - get_sources
  - get_timebase
  - load_settings
  - osc_measurement
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_defaults
  - set_frontend
  - set_hysteresis
  - set_input_attenuation
  - set_interpolation
  - set_output_load
  - set_output_termination
  - set_source
  - set_sources
  - set_timebase
  - set_trigger
  - summary
  - sync_output_phase
  client_source: moku/instruments/_oscilloscope.py
  reference: https://apis.liquidinstruments.com/api/reference/oscilloscope
  summary: Oscilloscope instrument object.
- name: PIDController
  kind: instrument
  operation_group: pidcontroller
  instrument_id: 5
  path: /api/pidcontroller/<action>
  slotted_path: /api/slot<N>/pidcontroller/<action>
  operation_count: 41
  operations:
  - enable_input
  - enable_output
  - enable_rollmode
  - for_slot
  - get_acquisition_mode
  - get_chunk
  - get_control_matrix
  - get_data
  - get_frontend
  - get_input_offset
  - get_interpolation
  - get_output_gain
  - get_output_limit
  - get_output_offset
  - get_samplerate
  - get_stream_status
  - get_timebase
  - load_settings
  - logging_progress
  - save_high_res_buffer
  - save_settings
  - set_acquisition_mode
  - set_by_frequency
  - set_by_gain
  - set_by_gain_and_section
  - set_control_matrix
  - set_defaults
  - set_frontend
  - set_hysteresis
  - set_input_offset
  - set_interpolation
  - set_monitor
  - set_output_gain
  - set_output_limit
  - set_output_offset
  - set_timebase
  - set_trigger
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  client_source: moku/instruments/_pidcontroller.py
  reference: https://apis.liquidinstruments.com/api/reference/pid
  summary: PIDController instrument object.
- name: Phasemeter
  kind: instrument
  operation_group: phasemeter
  instrument_id: 3
  path: /api/phasemeter/<action>
  slotted_path: /api/slot<N>/phasemeter/<action>
  operation_count: 30
  operations:
  - disable_input
  - disable_output
  - enable_freewheeling
  - enable_input
  - enable_single_input
  - for_slot
  - generate_output
  - get_acquisition_speed
  - get_auto_acquired_frequency
  - get_chunk
  - get_data
  - get_frontend
  - get_pm_loop
  - get_stream_status
  - load_settings
  - logging_progress
  - reacquire
  - save_settings
  - set_acquisition_speed
  - set_auto_reset
  - set_defaults
  - set_frontend
  - set_phase_wrap
  - set_pm_loop
  - start_logging
  - start_streaming
  - stop_logging
  - summary
  - sync_output_phase
  - zero_phase
  client_source: moku/instruments/_phasemeter.py
  reference: https://apis.liquidinstruments.com/api/reference/phasemeter
  summary: Phasemeter instrument object.
- name: SpectrumAnalyzer
  kind: instrument
  operation_group: spectrumanalyzer
  instrument_id: 2
  path: /api/spectrumanalyzer/<action>
  slotted_path: /api/slot<N>/spectrumanalyzer/<action>
  operation_count: 22
  operations:
  - disable_output
  - disable_xcorr
  - enable_xcorr
  - for_slot
  - get_data
  - get_frontend
  - get_output_termination
  - get_rbw
  - get_span
  - get_window
  - load_settings
  - sa_measurement
  - sa_output
  - save_settings
  - set_averaging
  - set_defaults
  - set_frontend
  - set_output_termination
  - set_rbw
  - set_span
  - set_window
  - summary
  client_source: moku/instruments/_spectrumanalyzer.py
  reference: https://apis.liquidinstruments.com/api/reference/specan
  summary: SpectrumAnalyzer instrument object.
- name: TimeFrequencyAnalyzer
  kind: instrument
  operation_group: tfa
  instrument_id: 11
  path: /api/tfa/<action>
  slotted_path: /api/slot<N>/tfa/<action>
  operation_count: 26
  operations:
  - clear_data
  - disable_output
  - for_slot
  - generate_output
  - get_acquisition_mode
  - get_data
  - get_event_detector
  - get_frontend
  - get_interpolation
  - get_interval_analyzer
  - get_interval_policy
  - load_settings
  - logging_progress
  - save_settings
  - set_acquisition_mode
  - set_defaults
  - set_event_detector
  - set_frontend
  - set_histogram
  - set_interpolation
  - set_interval_analyzer
  - set_interval_policy
  - set_smoothing_filter
  - start_logging
  - stop_logging
  - summary
  client_source: moku/instruments/_tfa.py
  reference: https://apis.liquidinstruments.com/api/reference/tfa
  summary: TimeFrequencyAnalyzer instrument object.
- name: WaveformGenerator
  kind: instrument
  operation_group: waveformgenerator
  instrument_id: 4
  path: /api/waveformgenerator/<action>
  slotted_path: /api/slot<N>/waveformgenerator/<action>
  operation_count: 18
  operations:
  - disable_modulation
  - for_slot
  - generate_waveform
  - get_frontend
  - get_output_load
  - get_output_termination
  - load_settings
  - manual_trigger
  - save_settings
  - set_burst_mode
  - set_defaults
  - set_frontend
  - set_modulation
  - set_output_load
  - set_output_termination
  - set_sweep_mode
  - summary
  - sync_phase
  client_source: moku/instruments/_waveformgenerator.py
  reference: https://apis.liquidinstruments.com/api/reference/waveformgenerator
  summary: WaveformGenerator instrument object.
gaps:
- No OpenAPI, so no request/response schemas, no parameter types, and no examples are machine-readable.
- Operation names are only discoverable from the client library source or the HTML reference pages.