WIP: Rigol oscilloscope refactor #1017

diggit · 2025-11-15T12:05:33Z

This is a Rigol Oscilloscope driver refactor.
Related issues #943

I need testers for most scope families (see below).

Refactor

each family has it's own identifier and can be easily handled individually
use STL containers instead of plain C arrays
use RAII for safe(r) resource management

Supported devices and new features

DS1000: Broken ❎
- times out on some commands and FW crashes, needs more investigation
MSO/DS1000Z: tested ✔️ (DS1054Z with all options, MSO1104Z with all options)
- LA: ✔️ (MSO1000Z only)
- implemented memory/samplerate configuration: ✔️
- improved download speed: ✔️
- improved trigger poll performance/robustness: ✔️
MSO5000: fixed trigger polling, added LA support
- analog, samplerate control, triggering, polling, data acq.: ✔️
- LA: ✔️
DHO800:
- analog, samplerate control, triggering, polling, data acq.: ✔️
- switched download to single block, doubled the download speed
DHO900: no intended changes, but untested (I can borrow one to validate my changes) 🙏
- should be the same as DHO800
- LA: untested
DHO1000: no intended changes, but untested 🙏
DHO4000: no intended changes, but untested 🙏

Known issues (TBD):

Memory depth does not update (in ngscopesclient) when channels are added to the capture. Timebase info may become outdated scopehal-apps#920
MSO5000 trigger detection is unreliable (on 8 gs/s we may completely miss the non "STOP" state)
Driver uses it's own sample conversion function, instead of one from core

non device specific

Some trigger offset fixes (keep in place and in valid range on samplerate/memory depthy changes)

Triggers

Pulse width: WIP (Improve driver specific trigger options handling #1019)

Not yet supported devices

MSO/DS2000: not supported yet
MSO/DS4000: not supported yet (I have access to this device and can work on the support)
MHO900/MHO098: not supported yet, device available via network (Rigol MHO900/MHO98 support #1022)

Differentiate between scope families and then group their common behavior in switch statements. This is more flexible approach and allow more fine tuned, per family behavior than immediately grouping them by protocol. - use smart pointers where it makes sense - use vector/array rather than C arrays DS1000Z - implemented memory/samplerate configuration - improved download speed - improved trigger poll performance/robustness Other families should have same handling as before.

to make sure all scope families are handled everywhere

When trigger offset was beyond memory range, at least DS1000Z never received trigger.

This is necessary, because samplerate changes timebase. While TB changes, Rigol oscilloscopes keep the trigger position constant relative to the capture mid point. Because scopehal reference point is at start, the trigger has to be updated to keep it constant from scopehal's POV.

As interleaving done automatically by scope is not considered to be an interleaving feature, see ngscopeclient#1014

preamp-org · 2025-11-15T12:46:46Z

Known issues (TBD):

Memory depth does not update (in ngscopesclient) when channels are added to the capture.

This is happening with the pico-bridge, too, so probably a bug of ngscopeclient itself and not specific to any make or model of 'scopes.

Initial tests with 1 channel and 1 MB chunks worked fine. Later tests with 2 channels failed, but 500 kB chunk size worked fine, but failed for 3 or 4 channels. It looks like the chunk size (maxpoints), also depends on the amount of enabled channels. There may be still some margin, but it's not worth chaseing it.

Proper resource locking was missing at multiple places. It may not be 100% complete yet.

- change verbose logs to trace - add more trace logs - print detected options - remove purely development logs

There are DHO4000 series scopes, which support 250 MHZ BW limit.

- all the series/model -> limiters logic is now in `GetChannelBandwidthLimiters` - `SetChannelBandwidthLimit` uses values from `GetChannelBandwidthLimiters` and uses nearest higher limit

it is more complicated than expected, no obvious rules

…channels

- deduce whole trigger state from data preamble rather than status - resilient against fast triggers skipping transitions - properly handles busy(wait)/armed(run) states

…ies::MSODS1000Z as there are also MSO scopes

MSODS1000Z was the only exception and it works there.

- recognize MSO1000Z as MSODS1000Z (tested) - recognize DHO800/DHO900/DHO1000/DHO4000 (untested)

only `double` for now, but templating allows easy addition of more

…cleanups easier

…nnel configuration - it may touch channels and it caused bugs when adding LA support

most of necessary includes are already included indirectly

- developed with MSO1000Z series - MSO5000/DHO900 implemented, but not tested

…o `std::optional`

…nown

…series because at least `ngscopeclient` starts the download when the scope enters triggered state, but the data are not ready yet. So we interpret `TD` as `TRIGGER_MODE_RUN` and flip to triggered/stop later

…mble` just in case so we don't read some garbage

diggit · 2025-12-17T21:50:47Z

DHO800 was mostly working. Some quirks were added.
DS1000E support is broken. Initial handshake fails as the cope does not respond to :CHAN<N>:DISP? commands (it should).

Wiljan1 · 2025-12-23T08:06:15Z

MSO5072 with upgrade for 4 channels and 200MHz here.
Only CH1+2 does show up in ngscopeclient-windows-x64-v0.1.msi on win10
Also get an error message when I hover over the output of ch2

Look like other see same behavior https://www.eevblog.com/forum/testgear/ngscopeclient-ultimate-acquisition-software-protocol-decoder-debug-tool/50/

diggit · 2025-12-23T23:03:27Z

hi @Wiljan1, yeah according to the web, MSO5072 has only 2 analog channels, so the behavior is as expected. I am surprised the model number did not change with mentioned upgrade (upgrading DS1054Z to 100 MHz BW changes the model numbert to DS1104Z).

I am not aware of any way how to inject some per instance overrides, so I will look into some alternative way, how to detect available channels.

Thanks for the feedback! Though this driver changed a lot since 0.1, this logic did not.

Wiljan1 · 2025-12-24T09:07:24Z

Hi @diggit ,

I am not aware of any way how to inject some per instance overrides, so I will look into some alternative way, how to detect available channels.

I think the :SYSTem:OPTion:STATus? can be used to check number of Analog channels, BW :

:SYSTem:OPTion:STATus? Syntax :SYSTem:OPTion:STATus? <type> Description Queries the status of the options of the oscilloscope. Parameter Name Type Range Default <type> Discrete {BW071|BW072|BW073|BW12|BW13|BW 23|RL2|4CH|BND|COMP|EMBD|AUTO|FLE X|AUDIO|AERO|AWG|PWR} —— 说明 ➢ BW071: bandwidth upgrade option. The bandwidth upgrades from 70 MHz to 100 MHz. ➢ BW072: bandwidth upgrade option. The bandwidth upgrades from 70 MHz to 200 MHz. ➢ BW073: bandwidth upgrade option. The bandwidth upgrades from 70 MHz to 350 MHz. ➢ BW12: bandwidth upgrade option. The bandwidth upgrades from 100 MHz to 200 MHz. ➢ BW13: bandwidth upgrade option. The bandwidth upgrades from 100 MHz to 350 MHz. ➢ BW23: bandwidth upgrade option. The bandwidth upgrades from 200 MHz to 350 MHz. ➢ RL2: memory depth option. Maximum memory depth up to 200 Mpts. ➢ 4CH: channel number upgrade option. Upgrade the number of analog channels to 4 Chapter 2 Command System RIGOL MSO5000 Programming Guide 2-169 (only available for the MSO5XX2 model). ➢ BND: function and application bundle option, MSO5000-COMP, MSO5000-EMBD, MSO5000-AUTO, MSO58000-FLEX, MSO5000-AUDIO, MSO5000-AERO, MSO5000-AWG, and MSO5000-PWR. ➢ COMP: PC serial bus trigger and analysis option (RS232/UART). ➢ EMBD: embedded serial bus trigger and analysis option (I2C and SPI). ➢ AUTO: auto serial bus trigger and analysis option (CAN and LIN). ➢ FLEX: FlexRay serial bus trigger and analysis option (FlexRay). ➢ AUDIO: audio serial bus trigger and analysis (I2S, only available for the MSO5XX4 model or the model installed with the MSO5000-4CH option). ➢ AERO: MIL-STD-1553 serial bus trigger and analysis option (MIL-STD-1553). ➢ AWG: dual-channel 25 MHz Arbitrary Waveform Generator. ➢ PWR: built-in power analysis option. Return Format The query returns 0 or 1. 0: indicates that the option is not installed. 1: indicates that the official option has been installed.

Let me know if you want me to test something?

Thank you
Wiljan1

diggit · 2025-12-26T10:54:45Z

@x44203 mentioned, that :SYSTem:OPTion:STATus? does not work properly on some scopes. x44203, can you elaborate on that? What did you observe?

diggit · 2025-12-26T12:36:47Z

~~@Wiljan1 I've tried :SYSTem:OPTion:STATus?/:SYST:OPT:STAT? on my MSO5074 and it times out without response.~~

I have to read more carefully next time. :SYSTem:OPTion:STATus? requires one argument with option name, but it still returns 0 for every option even though the scope has them all installed.

EDIT: Ok, :SYSTem:OPTion:STATus? may not work reliably on scopes modified in a certain way.

Alternative approach could be to request :CHAN3:DISP 1 and then check for an error. Tried that with CHAN5 on mentioned (4ch) scope and it looks feasible, but feedback from someone with MSO5072 without the 4 CH option installed, would be appreciated.

x44203 · 2025-12-26T14:45:09Z

@diggit It seems to return 1 for some options, but they do not reflect the full capabilities of the scope (mine definitely has 4 channels)

:SYS:OPT:STAT? BW071
:SYSTem:OPTion:STATus? BW071 
0
:SYSTem:OPTion:STATus? 4CH
0
:SYSTem:OPTion:STATus? AWG
1
:SYSTem:OPTion:STATus? RL2
0
:SYSTem:OPTion:STATus? BND
1
:SYST:OPT:STAT? BND
1

Edit:

Alternative approach could be to request :CHAN3:DISP 1 and then check for an error.

Agreed, when I wrote that code I must have assumed that MSO5072 shows up as MSO5074. Maybe a check similar to the code for memory depth checking would be better.

Wiljan1 · 2025-12-26T16:34:38Z

@diggit @x44203 could be that an original 4ch scope does not accept the cmd.
In the user manual it says for the options:

Channel Number Upgrade Option
Upgrade the Number of Analog Channels to 4 (only available for the
MSO5XX2 model)
MSO5000-4CH

I'm not next to the scope until Tuesday, then I can try the :SYSTem:OPTion:STATus? 4CH on the MSO5072

…option detection MSO5xx2 scopes are scopes with only 2 channels and other 2 channels are SW option. Usually `:SYST:OPT:STAT? 4CH` query should be enough, but there are modifier FWs which report `0` (not present), but the option is active. This is and attempt to detect it using `:CHAN3:VERN ON`, which is expected to trigger error if option is missing. We intentionally do not use any CHAN3 query, as those time out.

diggit · 2025-12-26T23:56:54Z

@Wiljan1 new commit 20864ba should address 4CH option detection. Please give it a shot on some MSO5xx2 device (preferably with and without this option).
This check is only done for MSO5xx2 scopes. We assume 4 channels on MSO5xx4 models.

Wiljan1 · 2025-12-27T21:55:13Z

@diggit thx I need to know how add the commit to the build on windows in the MSYS2 so I can test it, right now I can compile the main git source.

diggit · 2025-12-27T23:16:21Z

@Wiljan1 if you have the environment to build scopehal-apps, you are 99% done.
Assuming you are in directory of the scopehal-apps

cd lib
git fetch origin pull/1017/head:rigol_oscilloscope_refactor
git switch rigol_oscilloscope_refactor
cd ..
build in the same way you did previously

Wiljan1 · 2025-12-28T10:23:17Z

@diggit when I add your instructions above and do a build it unfortunate fails:

`[201/542] Building CXX object lib/scopehal/CMakeFiles/scopehal.dir/RigolOscilloscope.cpp.obj
FAILED: [code=1] lib/scopehal/CMakeFiles/scopehal.dir/RigolOscilloscope.cpp.obj

In file included from C:/msys64/home/Jan Jakobsen/scopehal-apps/lib/scopehal/RigolOscilloscope.cpp:31:
C:/msys64/home/Jan Jakobsen/scopehal-apps/lib/scopehal/RigolOscilloscope.h:128:17: warning: declaration of 'BYTE' shadows a global declaration [-Wshadow]
128 | BYTE = 0, // a waveform point occupies one byte (namely 8 bits).
| ^~~~
In file included from C:/msys64/ucrt64/include/windef.h:9,
from C:/msys64/ucrt64/include/windows.h:69,
from C:/msys64/ucrt64/include/winsock2.h:23,
from C:/msys64/ucrt64/include/ws2tcpip.h:17,
from C:/msys64/home/Jan Jakobsen/scopehal-apps/lib/scopehal/scopehal.h:42,
from C:/msys64/home/Jan Jakobsen/scopehal-apps/lib/scopehal/RigolOscilloscope.cpp:30:
C:/msys64/ucrt64/include/minwindef.h:139:25: note: shadowed declaration is here
139 | typedef unsigned char BYTE;
| ^~~~

and a lot more warnings and finally

cc1plus.exe: all warnings being treated as errors
[204/542] Building CXX object lib/scopehal/CM...es/scopehal.dir/TektronixOscilloscope.cpp.ob
ninja: build stopped: subcommand failed.`

diggit · 2025-12-28T14:24:16Z

Eh, Windows environment never disappoints. Please pull changes and retry. cd lib; git pull

Wiljan1 · 2025-12-30T11:59:22Z

Still having trouble with the git pull / compile, now I'm next to my scope and did connect by a terminal program

*IDN?
RIGOL TECHNOLOGIES,MSO5072,MS5A241xxxxxxx,00.01.03.02.02

:SYSTem:RAMount?
4

Syntax :SYSTem:RAMount?
Description Queries the number of analog channels of the current instrument.
Return
Format
The query returns the number of analog channels of the current instrument in integer.

The :SYSTem:OPTion:STATus? did noit respond for the 4CH

diggit · 2025-12-30T12:32:45Z

Ok, this looks straightforward. I will implement channel detestion this way.
Please share the failing build output. We want working builds for Windows too.

Wiljan1 · 2025-12-30T12:47:00Z

It's the same error when build since the cmd you suggestgit pulldoes not work correctly

$ git pull
There is no tracking information for the current branch.
Please specify which branch you want to merge with.
See git-pull(1) for details.

    git pull <remote> <branch>

If you wish to set tracking information for this branch you can do so with:

    git branch --set-upstream-to=origin/<branch> rigol_oscilloscope_refactor

I'm new to use git so have to learn :-)

diggit · 2025-12-30T19:41:03Z

My bad, pull request are not branches, so local branch can't track it. instead of pulling changes (git pull), use git fetch origin pull/1017/head in lib. That will fetch all latest changes into current local branch.

I've also simplified analog channel detection to use :SYST:RAM?

Wiljan1 · 2025-12-31T00:24:48Z

@diggit
I used

Jan Jakobsen@LAPTOP-JJ UCRT64 ~/scopehal-apps/lib
$ git fetch origin pull/1017/head
From https://github.com/ngscopeclient/scopehal
 * branch              refs/pull/1017/head -> FETCH_HEAD

Jan Jakobsen@LAPTOP-JJ UCRT64 ~/scopehal-apps/lib
$ cd ..

Jan Jakobsen@LAPTOP-JJ UCRT64 ~/scopehal-apps
$ cd build

Jan Jakobsen@LAPTOP-JJ UCRT64 ~/scopehal-apps/build
$ ninja -j4
[11/11] Copying icons...

when running the ./ngscopeclient.exe and adding the scope I only see 2 channels and 1 is disabled
when using wireshark and sniffing I do not see the :SYST:RAM? send over network so I doubt the patch are actually done

diggit added 6 commits November 15, 2025 12:37

RigolOscilloscope: enforce all case handling in switch statements

99e8333

to make sure all scope families are handled everywhere

RigolOscilloscope: clamp trigger offset into valid range

c88ba99

When trigger offset was beyond memory range, at least DS1000Z never received trigger.

RigolOscilloscope: mark trigger offset as invalid when new values is set

94d4deb

RigolOscilloscope: mark interleaving as not supported

7b647c2

As interleaving done automatically by scope is not considered to be an interleaving feature, see ngscopeclient#1014

diggit mentioned this pull request Nov 15, 2025

Device driver thread safety requirements/assumptions #1018

Closed

diggit added 4 commits November 15, 2025 22:07

RigolOscilloscope: refactor resource locking

8c9f46e

Proper resource locking was missing at multiple places. It may not be 100% complete yet.

RigolOscilloscope: clean-up and extend logging

d513007

- change verbose logs to trace - add more trace logs - print detected options - remove purely development logs

RigolOscilloscope: fix GetChannelBandwidthLimiters for DHO series

4462d80

There are DHO4000 series scopes, which support 250 MHZ BW limit.

RigolOscilloscope: simplify channel bw limit handling

6859667

- all the series/model -> limiters logic is now in `GetChannelBandwidthLimiters` - `SetChannelBandwidthLimit` uses values from `GetChannelBandwidthLimiters` and uses nearest higher limit

diggit mentioned this pull request Nov 17, 2025

Improve driver specific trigger options handling #1019

Open

diggit added 5 commits November 17, 2025 22:29

RigolOscilloscope: fix DS1000Z samplerate/timebase conversion rules

8847991

it is more complicated than expected, no obvious rules

RigolOscilloscope: DS1000Z: allow 24M point memory also for multiple …

693f80b

…channels

RigolOscilloscope: deduplicate pre/post start code

7b317b8

RigolOscilloscope: DS1000Z: improve trigger handling

37251c1

- deduce whole trigger state from data preamble rather than status - resilient against fast triggers skipping transitions - properly handles busy(wait)/armed(run) states

RigolOscilloscope: minor cleanups

ddfe89e

diggit mentioned this pull request Nov 25, 2025

USB TMC truncates long replies (Rigol DS1104Z) #1021

Open

diggit added 6 commits November 27, 2025 20:14

RigolOscilloscope: change Series::DS1000Z enumeration to change Ser…

96a6f88

…ies::MSODS1000Z as there are also MSO scopes

RigolOscilloscope: enable channel VERNier for all series

f6e55b2

MSODS1000Z was the only exception and it works there.

RigolOscilloscope: fix serires detection

ebd3d31

- recognize MSO1000Z as MSODS1000Z (tested) - recognize DHO800/DHO900/DHO1000/DHO4000 (untested)

RigolOscilloscope: add response parsing hekpers

cff07fb

only `double` for now, but templating allows easy addition of more

RigolOscilloscope: add RAII "End Of Context" helper to make resource …

5341b56

…cleanups easier

RigolOscilloscope: move initial UpdateDynamicCapabilities after cha…

920714a

…nnel configuration - it may touch channels and it caused bugs when adding LA support

diggit mentioned this pull request Nov 30, 2025

Rigol MHO900/MHO98 support #1022

Open

diggit added 3 commits November 30, 2025 11:56

RigolOscilloscope: reduce includes

ece27e0

most of necessary includes are already included indirectly

RigolOscilloscope: add support for LA

311aa77

- developed with MSO1000Z series - MSO5000/DHO900 implemented, but not tested

RigolOscilloscope: change all cached bools (value + ValueValid) t…

6079e58

…o `std::optional`

diggit added 5 commits December 16, 2025 17:53

RigolOscilloscope: GetSampleDepth do not crash when mdepths are unk…

e560919

…nown

RigolOscilloscope: fix: always parse sample memory depth as double

716cdf0

RigolOscilloscope: disable ato roll mode for DHOs

f621cd7

RigolOscilloscope: PollTrigger() enable TD state masking for all …

fcbaf19

…series because at least `ngscopeclient` starts the download when the scope enters triggered state, but the data are not ready yet. So we interpret `TD` as `TRIGGER_MODE_RUN` and flip to triggered/stop later

RigolOscilloscope: default initialize all member data of `CapturePrea…

40a14db

…mble` just in case so we don't read some garbage

RigolOscilloscope: fix BYTE enumeration collision with msys64 typedef

1c91443

RigolOscilloscope: resolve variable name shadow warning

72f3b4e

This was referenced Dec 28, 2025

Request: Add GH Action to build the library (with manual trigger from PR) #1034

Closed

Rigolredo basic functionality for MSO2000A #967

Open

RigolOscilloscope: simplify MSO5xx2 4CH detection using :SYST:RAM?

bb36776

diggit mentioned this pull request Dec 30, 2025

Segfault in Rigol driver (MSO5074) with invalid reported memory depth #1029

Open

WIP: Rigol oscilloscope refactor #1017

Are you sure you want to change the base?

WIP: Rigol oscilloscope refactor #1017

Uh oh!

Conversation

diggit commented Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactor

Supported devices and new features

Known issues (TBD):

non device specific

Triggers

Not yet supported devices

Uh oh!

preamp-org commented Nov 15, 2025

Uh oh!

diggit commented Dec 17, 2025

Uh oh!

Wiljan1 commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

diggit commented Dec 23, 2025

Uh oh!

Wiljan1 commented Dec 24, 2025

Uh oh!

diggit commented Dec 26, 2025

Uh oh!

diggit commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

x44203 commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wiljan1 commented Dec 26, 2025

Uh oh!

diggit commented Dec 26, 2025

Uh oh!

Wiljan1 commented Dec 27, 2025

Uh oh!

diggit commented Dec 27, 2025

Uh oh!

Wiljan1 commented Dec 28, 2025

Uh oh!

diggit commented Dec 28, 2025

Uh oh!

Wiljan1 commented Dec 30, 2025

Uh oh!

diggit commented Dec 30, 2025

Uh oh!

Wiljan1 commented Dec 30, 2025

Uh oh!

diggit commented Dec 30, 2025

Uh oh!

Wiljan1 commented Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

diggit commented Nov 15, 2025 •

edited

Loading

Wiljan1 commented Dec 23, 2025 •

edited

Loading

diggit commented Dec 26, 2025 •

edited

Loading

x44203 commented Dec 26, 2025 •

edited

Loading