1 Introduction
1.1 Introduction
1.2 Documentation Conventions
1.3 Key Concepts
1.3.1 User Interface
1.3.2 Design Philosophy
1.3.3 Terminology
1.4 Stability Notes
1.5 Revision History
2 Legal Notices
2.1 Introduction
2.2 License Agreement
2.3 Trademarks
2.4 Third Party Licenses
2.4.1 Optional, only used if scopehal-plugins-gpl plugin is installed
2.4.2 Only in unit tests
3 Getting Started
3.1 Host System Requirements
3.1.1 Operating Systems
3.1.2 Processors
3.1.3 Mouse
3.1.4 GPU
3.1.5 RAM
3.2 Instrument Support
3.3 Installation
3.3.1 Official Releases
3.3.2 Development Builds
3.4 Compilation
3.4.1 Linux
3.4.2 macOS
3.4.3 Windows
3.5 Running ngscopeclient
3.5.1 General arguments
3.5.2 Console verbosity arguments
4 Tutorials
4.1 The Basics
4.1.1 Connecting to an Oscilloscope
4.1.2 Acquiring Waveforms
4.1.3 Navigating the Y Axis
4.1.4 Navigating the X Axis
5 Main Window
5.1 Menu
5.1.1 File
5.1.2 View
5.1.3 Add
5.1.4 Setup
5.1.5 Window
5.1.6 Debug
5.1.7 Help
5.2 Toolbar
5.2.1 Capture buttons
5.2.2 History
5.2.3 Refresh Settings
5.2.4 Clear Sweeps
5.2.5 Fullscreen
5.2.6 Intensity slider
5.2.7 Persistence slider
6 Dialogs
6.1 Lab Notes
6.2 Log Viewer
6.3 Measurements
6.4 Performance Metrics
6.4.1 Rendering
6.4.2 Filter graph
6.4.3 Acquisition
6.4.4 Memory
6.5 Preferences
6.5.1 Appearance
6.5.2 Drivers
6.5.3 Files
6.5.4 Miscellaneous
6.5.5 Power
6.6 Speed Bump
7 Workspaces and Window Management
7.1 Window Management and Docking
7.2 Workspaces
8 Waveform Groups
8.1 Managing Groups
9 Waveform Views
9.1 Navigation
9.2 Plot Area
9.3 Y Axis Scale
9.4 Channel Label
9.5 Cursors and Markers
9.5.1 Horizontal Cursors
9.5.2 Vertical Cursors
9.5.3 Markers
10 History
10.1 Pinning
10.2 Labeling
11 Stream Browser
11.1 Introduction
11.2 Filters
11.3 Instruments
11.4 Adding streams
12 Filter Graph Editor
12.1 Introduction
12.2 Interaction
12.3 Grouping
13 Transports
13.1 gpib
13.2 lan
13.3 lxi
13.4 null
13.5 socketcan
13.6 twinlan
13.7 uart
13.8 usbtmc
13.9 vicp
13.10 hid
14 BERT Drivers
14.1 Antikernel Labs
14.1.1 akl.crossbar
14.2 MultiLANE
14.2.1 mlbert
15 Function Generator Drivers
15.1 Owon
15.1.1 owon_xdg
15.2 Rigol
15.2.1 rigol_awg
15.3 Siglent
15.3.1 siglent_sdg
16 Electronic Load Drivers
16.1 Siglent
16.1.1 siglent_load
17 Multimeter Drivers
17.1 Owon
17.1.1 owon_xdm
17.2 Rohde & Schwarz
17.2.1 rs_hmc8012
18 Miscellaneous Drivers
18.1 Antikernel Labs
18.1.1 akl.gpio
18.1.2 akl.vio
18.2 Generic
18.2.1 csvstream
19 Oscilloscope Drivers
19.1 Agilent
19.1.1 agilent
19.2 Antikernel Labs
19.2.1 akl.ila
19.3 Demo
19.4 Batronix
19.5 Digilent
19.5.1 digilent
19.6 DrAndyHaas
19.6.1 haasoscope pro
19.7 DreamSource Lab
19.7.1 dslabs
19.8 EEVengers
19.8.1 thunderscope
19.9 Enjoy Digital
19.10 Generic
19.10.1 socketcan
19.11 Hantek
19.12 Keysight
19.12.1 agilent
19.12.2 keysightdca
19.13 Pico Technology
19.13.1 pico
19.14 Rigol
19.14.1 rigol
19.15 Rohde & Schwarz
19.15.1 rs
19.15.2 rs_rto6
19.15.3 rs_rtb2k
19.16 Saleae
19.17 Siglent
19.18 Teledyne LeCroy / LeCroy
19.18.1 lecroy
19.18.2 lecroy_fwp
19.19 Tektronix
19.19.1 Note regarding “lan" transport on MSO5/6
19.20 tinySA
19.21 Xilinx
20 SDR Drivers
20.1 Ettus Research
20.1.1 uhd
20.2 Microphase
21 Spectrometer Drivers
21.1 ASEQ Instruments
21.1.1 aseq
22 Power Supply Drivers
22.1 Alientek
22.1.1 alientek_dp
22.2 GW Instek
22.2.1 gwinstek_gpdx303s
22.3 Kuaiqu
22.3.1 kuaiqu_psu
22.4 Riden
22.4.1 kuaiqu_psu
22.5 Rigol
22.5.1 rigol_dp8xx
22.6 Rohde & Schwarz
22.6.1 rs_hmc804x
22.7 Siglent
22.7.1 siglent_spd
22.8 Sinilink
22.8.1 siniLink
23 RF Generator Drivers
23.1 Siglent
23.1.1 siglent_ssg
24 VNA Drivers
24.1 Copper Mountain
24.1.1 coppermt
24.2 NanoVNA
24.2.1 nanovna
24.3 Pico Technology
24.3.1 picovna
25 Triggers
25.1 Trigger Properties
25.2 Serial Pattern Triggers
25.3 Dropout
25.3.1 Inputs
25.3.2 Parameters
25.4 Edge
25.4.1 Inputs
25.4.2 Parameters
25.5 Glitch
25.6 Pulse Width
25.6.1 Parameters
25.7 Runt
25.7.1 Parameters
25.8 Slew Rate
25.8.1 Parameters
25.9 UART
25.9.1 Inputs
25.9.2 Parameters
25.10 Window
25.10.1 Parameters
26 Filters
26.1 Introduction
26.1.1 Key Concepts
26.1.2 Conventions
26.2 1-Wire
26.2.1 Inputs
26.2.2 Parameters
26.2.3 Output Signal
26.3 128b/130b
26.3.1 Inputs
26.3.2 Parameters
26.3.3 Output Signal
26.3.4 Breaking Changes
26.4 2-Port Shunt Through
26.5 64b/66b
26.5.1 Inputs
26.5.2 Parameters
26.5.3 Output Signal
26.5.4 Breaking Changes
26.6 8B/10B (IBM)
26.6.1 Inputs
26.6.2 Parameters
26.6.3 Output Signal
26.6.4 Breaking Changes
26.7 8B/10B (TMDS)
26.7.1 Inputs
26.7.2 Parameters
26.7.3 Output Signal
26.7.4 Breaking Changes
26.8 AC Couple
26.8.1 Inputs
26.8.2 Parameters
26.8.3 Output Signal
26.9 AC RMS
26.9.1 Inputs
26.9.2 Parameters
26.9.3 Output Signal
26.10 Add
26.10.1 Inputs
26.10.2 Parameters
26.10.3 Output Signal
26.11 ADL5205
26.11.1 Inputs
26.11.2 Parameters
26.11.3 Output Signal
26.12 APB
26.12.1 Inputs
26.12.2 Parameters
26.12.3 Output Signal
26.13 Area Under Curve
26.13.1 Inputs
26.13.2 Parameters
26.13.3 Output Signal
26.14 Autocorrelation
26.14.1 Inputs
26.14.2 Parameters
26.14.3 Output Signal
26.15 Average
26.15.1 Inputs
26.15.2 Parameters
26.15.3 Output Signal
26.16 Bandwidth
26.16.1 Inputs
26.16.2 Parameters
26.16.3 Output Signal
26.17 Base
26.17.1 Inputs
26.17.2 Parameters
26.17.3 Output Signal
26.18 BIN Import
26.18.1 Inputs
26.18.2 Parameters
26.18.3 Output Signal
26.19 Burst Width
26.19.1 Inputs
26.19.2 Parameters
26.19.3 Output Signal
26.20 Bus Heatmap
26.20.1 Parameters
26.20.2 Output Signal
26.21 CAN
26.21.1 Inputs
26.21.2 Parameters
26.21.3 Output Signal
26.21.4 Protocol Analyzer
26.22 CAN Analyzer
26.23 CAN Bitmask
26.23.1 Inputs
26.23.2 Parameters
26.23.3 Output Signal
26.24 Can-Utils Import
26.25 Channel Emulation
26.25.1 Inputs
26.25.2 Parameters
26.25.3 Output Signal
26.26 Clip
26.26.1 Inputs
26.26.2 Parameters
26.26.3 Output Signal
26.27 Clock Jitter (TIE)
26.27.1 Inputs
26.27.2 Parameters
26.27.3 Output Signal
26.28 Clock Recovery (D-PHY HS Mode)
26.29 Clock Recovery (PLL)
26.29.1 Inputs
26.29.2 Parameters
26.29.3 Output Signal
26.30 Clock Recovery (UART)
26.30.1 Inputs
26.30.2 Parameters
26.30.3 Output Signal
26.31 Complex Import
26.31.1 Inputs
26.31.2 Parameters
26.31.3 Output Signal
26.32 Complex Spectrogram
26.32.1 Inputs
26.32.2 Parameters
26.32.3 Output Signal
26.33 Constant
26.33.1 Inputs
26.33.2 Parameters
26.33.3 Output Signal
26.34 Constellation
26.34.1 Inputs
26.34.2 Parameters
26.34.3 Output Signal
26.34.4 Breaking Changes
26.35 Coupler De-Embed
26.35.1 Inputs
26.35.2 Output Signal
26.36 CSV Export
26.36.1 Inputs
26.36.2 Parameters
26.36.3 Output Signal
26.37 CSV Import
26.37.1 Inputs
26.37.2 Parameters
26.37.3 Output Signal
26.38 CTLE
26.38.1 Inputs
26.38.2 Parameters
26.38.3 Output Signal
26.38.4 Breaking Changes
26.39 Current Shunt
26.40 DCD
26.40.1 Inputs
26.40.2 Parameters
26.40.3 Output Signal
26.41 DDJ
26.41.1 Inputs
26.41.2 Parameters
26.41.3 Output Signal
26.41.4 Breaking Changes
26.42 DDR1 Command Bus
26.42.1 Inputs
26.42.2 Parameters
26.42.3 Output Signal
26.43 DDR3 Command Bus
26.44 De-Embed
26.44.1 Inputs
26.44.2 Parameters
26.44.3 Output Signal
26.45 Deskew
26.45.1 Inputs
26.45.2 Parameters
26.45.3 Output Signal
26.46 Digital Constant
26.46.1 Inputs
26.46.2 Parameters
26.46.3 Output Signal
26.47 Digital to Analog
26.47.1 Inputs
26.47.2 Parameters
26.47.3 Output Signal
26.48 Digital to NRZ
26.48.1 Inputs
26.48.2 Parameters
26.48.3 Output Signal
26.49 Digital to PAM4
26.49.1 Inputs
26.49.2 Parameters
26.49.3 Output Signal
26.50 DisplayPort - Aux Channel
26.50.1 Inputs
26.50.2 Parameters
26.50.3 Output Signal
26.51 DisplayPort - Main Link
26.51.1 Inputs
26.51.2 Parameters
26.51.3 Output Signal
26.52 Divide
26.52.1 Inputs
26.52.2 Parameters
26.52.3 Output Signal
26.53 Downconvert
26.53.1 Inputs
26.53.2 Parameters
26.53.3 Output Signal
26.54 Downsample
26.54.1 Inputs
26.54.2 Parameters
26.54.3 Output Signal
26.55 DRAM Clocks
26.56 DRAM Trcd
26.57 DRAM Trfc
26.58 Duty Cycle
26.58.1 Inputs
26.58.2 Parameters
26.58.3 Output Signal
26.59 DVI
26.59.1 Inputs
26.59.2 Parameters
26.59.3 Output Signal
26.60 Emphasis
26.60.1 Inputs
26.60.2 Parameters
26.60.3 Output Signal
26.61 Emphasis Removal
26.61.1 Inputs
26.61.2 Parameters
26.61.3 Output Signal
26.62 Enhanced Resolution
26.62.1 Inputs
26.62.2 Parameters
26.62.3 Output Signal
26.63 Envelope
26.63.1 Inputs
26.63.2 Parameters
26.63.3 Output Signal
26.64 Ethernet - 10baseT
26.64.1 Inputs
26.64.2 Parameters
26.64.3 Output Signal
26.65 Ethernet - 100baseT1
26.65.1 Inputs
26.65.2 Parameters
26.65.3 Output Signal
26.65.4 Breaking Changes
26.66 Ethernet - 100baseT1 Link Training
26.66.1 Inputs
26.66.2 Parameters
26.66.3 Output Signal
26.66.4 Breaking Changes
26.67 Ethernet - 100baseTX
26.67.1 Inputs
26.67.2 Parameters
26.67.3 Output Signal
26.67.4 Breaking Changes
26.68 Ethernet - 1000baseX
26.68.1 Parameters
26.68.2 Output Signal
26.69 Ethernet - 10Gbase-R
26.69.1 Parameters
26.69.2 Output Signal
26.70 Ethernet - QSGMII
26.70.1 Inputs
26.70.2 Parameters
26.70.3 Output Signal
26.71 Ethernet - RGMII
26.71.1 Inputs
26.71.2 Parameters
26.71.3 Output Signal
26.72 Ethernet - RMII
26.72.1 Inputs
26.72.2 Parameters
26.72.3 Output Signal
26.73 Ethernet - SGMII
26.74 Ethernet Autonegotiation
26.74.1 Inputs
26.74.2 Parameters
26.74.3 Output Signal
26.75 Ethernet Autonegotiation Page
26.75.1 Inputs
26.75.2 Parameters
26.75.3 Output Signal
26.76 Ethernet Base-X Autonegotiation
26.77 Exponential Moving Average
26.77.1 Inputs
26.77.2 Parameters
26.78 Eye Bit Rate
26.79 Eye Height
26.80 Eye P-P Jitter
26.81 Eye Pattern
26.81.1 Inputs
26.81.2 Parameters
26.81.3 Output Signal
26.82 Eye Period
26.83 Eye Width
26.84 Fall
26.85 FFT
26.86 FIR
26.87 Frequency
26.88 Full Width at Half Maximum
26.88.1 Inputs
26.88.2 Parameters
26.88.3 Output Signal
26.89 Gate
26.90 Glitch Removal
26.90.1 Inputs
26.90.2 Parameters
26.90.3 Output Signal
26.91 Group Delay
26.91.1 Inputs
26.91.2 Parameters
26.91.3 Output Signal
26.92 Histogram
26.92.1 Inputs
26.92.2 Parameters
26.92.3 Output Signal
26.93 Horizontal Bathtub
26.94 HDMI
26.95 \(I^2C\)
26.96 \(I^2C\) EEPROM
26.97 \(I^2C\) Register
26.98 IBIS Driver
26.98.1 Inputs
26.98.2 Parameters
26.98.3 Output Signal
26.99 Invert
26.100 Intel eSPI
26.101 IPv4
26.102 IQ Demux
26.103 IQ Squelch
26.104 J1939 Analog
26.105 J1939 Bitmask
26.106 J1939 PDU
26.107 J1939 Source Match
26.108 J1939 Transport
26.109 Jitter
26.109.1 Inputs
26.109.2 Parameters
26.109.3 Output Signal
26.110 Jitter Spectrum
26.111 JTAG
26.112 Magnitude
26.113 Maximum
26.113.1 Inputs
26.113.2 Parameters
26.113.3 Output Signal
26.114 MDIO
26.115 Memory
26.116 MIL-STD-1553
26.117 Minimum
26.117.1 Inputs
26.117.2 Parameters
26.117.3 Output Signal
26.118 MIPI D-Phy Data
26.119 MIPI D-Phy Escape Mode
26.120 MIPI D-Phy Symbol
26.121 MIPI DSI Frame
26.122 MIPI DSI Packet
26.123 Moving Average
26.124 Multiply
26.125 NCO
26.126 Noise
26.127 Overshoot
26.128 PAM4 Demodulator
26.129 PAM Edge Detector
26.130 PcapNG Export
26.131 PcapNG Import
26.132 PCIe Data Link
26.133 PCIe Gen 1/2 Logical
26.134 PCIe Gen 3/4/5 Logical
26.135 PCIe Link Training
26.136 PCIe Transport
26.137 Peak Hold
26.138 Peak-to-Peak
26.139 Peaks
26.140 Period
26.141 Phase
26.142 Phase Nonlinearity
26.142.1 Inputs
26.142.2 Parameters
26.142.3 Output Signal
26.143 Point Sample
26.144 PRBS
26.145 Pulse Width
26.145.1 Inputs
26.145.2 Output Signal
26.146 QSPI
26.147 Quadrature
26.148 Reference Plane Extension
26.149 RGB LED
26.150 RIS
26.151 Rise
26.152 Rj + BUj
26.153 RMS
26.153.1 Inputs
26.153.2 Parameters
26.153.3 Output Signal
26.154 S-Parameter Cascade
26.155 Sawtooth
26.156 S-Parameter De-Embed
26.157 Scalar Pulse Delay
26.158 Scalar Stairstep
26.159 SD Card Command
26.160 Setup / Hold
26.160.1 Inputs
26.160.2 Parameters
26.160.3 Output Signal
26.161 Sine
26.162 SNR
26.162.1 Inputs
26.162.2 Parameters
26.162.3 Output Signal
26.163 Spectrogram
26.164 SPI
26.165 SPI Flash
26.166 Squelch
26.167 Step
26.168 Subtract
26.168.1 Inputs
26.168.2 Parameters
26.168.3 Output Signal
26.169 SWD
26.169.1 Inputs
26.169.2 Parameters
26.169.3 Output Signal
26.170 SWD MEM-AP
26.171 Tachometer
26.172 Tapped Delay Line
26.173 TCP
26.174 TDR
26.175 Time Outside Level
26.175.1 Inputs
26.175.2 Parameters
26.176 Thermal Diode
26.177 Threshold
26.177.1 Inputs
26.177.2 Parameters
26.177.3 Output Signal
26.178 Top
26.178.1 Inputs
26.178.2 Parameters
26.178.3 Output Signal
26.179 Touchstone Export
26.180 Touchstone Import
26.181 Trend
26.182 TRC Import
26.183 UART
26.184 Unwrapped Phase
26.184.1 Inputs
26.184.2 Parameters
26.184.3 Output Signal
26.185 USB 1.0 / 2.x Activity
26.186 USB 1.0 / 2.x Packet
26.187 USB 1.0 / 2.x PCS
26.188 USB 1.0 / 2.x PMA
26.189 Undershoot
26.190 Upsample
26.191 VCD Import
26.192 Vector Frequency
26.193 Vector Phase
26.194 Vertical Bathtub
26.195 VICP
26.196 Waterfall
26.197 WAV Import
26.198 WFM Import
26.199 Windowed Autocorrelation
26.200 Window
26.200.1 Inputs
26.200.2 Parameters
26.200.3 Output Signal
26.201 X-Y Sweep