Add support for 4000a and 5000a API

README.md

@@ -1,3 +1,117 @@
 # scopehal-pico-bridge
 
 Socket servers for Pico Technology instruments allowing remote access via libscopehal.
+
+
+## How to use
+
+##### Prerequisites
+* Install the Pico SDK (https://picotech.com/downloads)
+* Compile [scopehal-apps](https://www.ngscopeclient.org/manual/GettingStarted.html)
+* Compile scopehal-pico-bridge (see below for instructions)
+---
+1. Connect your PicoScope to the computer.
+2. Start the scopehal-pico-bridge (ps6000d.exe). It should open a console window and read "Successfully opened instrument", listing some info about the device like model and serial number.
+3. Now start [ngscopeclient](https://github.com/ngscopeclient/scopehal-apps). Select Add / Oscilloscope / Connect... from the top menu. Enter or select the following values:
+   * Nickname: (choose a display name for your scope.)
+   * Driver: **pico**
+   * Transport: **twinlan**
+   * Path: **localhost:5025:5026**
+4. Click Add.
+5. If this is your first time using ngscopeclient, continue reading [the tutorial here](https://www.ngscopeclient.org/manual/Tutorials.html).
+
+
+## Supported models
+
+Currently supported are these four APIs from Pico Technology: **ps3000a, ps4000a, ps5000a, ps6000a**.
+Note that these are all "A APIs" and thus do not support some older and discontinued models.
+As of October 2025, there should be a total of **72** different devices supported. 
+
+| ps3000a | ps4000a | ps5000a | ps6000a |
+| :---- | :---- | :---- | :---- |
+| 3203D | 4444 | 5242A | 6403E |
+| 3203D MSO | **4824** | 5242B | 6404E |
+| 3204A | 4224A | 5242D | 6405E |
+| 3204B | 4424A | 5242D MSO | 6406E |
+| 3204 MSO | 4824A | 5243A | 6424E |
+| 3204D |  | 5243B | 6425E |
+| 3204D MSO |  | 5243D | 6426E |
+| 3205A |  | 5243D MSO | 6428E-D |
+| 3205B |  | 5244A | 6804E |
+| 3205 MSO |  | 5244B | **6824E** |
+| 3205D |  | 5244D |  |
+| 3205D MSO |  | 5244D MSO |  |
+| 3206A |  | 5442A |  |
+| 3206B |  | 5442B |  |
+| 3206 MSO |  | 5442D |  |
+| 3206D |  | 5442D MSO |  |
+| 3206D MSO |  | 5443A |  |
+| 3207A |  | 5443B |  |
+| 3207B |  | 5443D |  |
+| 3403D |  | 5443D MSO |  |
+| 3403D MSO |  | 5444A |  |
+| 3404A |  | 5444B |  |
+| 3404B |  | 5444D |  |
+| 3404D |  | **5444D MSO** |  |
+| 3404D MSO |  |  |  |
+| 3405A |  |  |  |
+| 3405B |  |  |  |
+| 3405D |  |  |  |
+| 3405D MSO |  |  |  |
+| 3406A |  |  |  |
+| 3406B |  |  |  |
+| 3406D |  |  |  |
+| 3406D MSO |  |  |  |
+
+Models shown in bold were used for, and tested during, the development of the pico-bridge.
+
+
+## How to compile
+
+The process to build from source is basically [the same as for ngscopeclient](https://www.ngscopeclient.org/manual/GettingStarted.html), shown here for **Windows**:
+
+1.
+    Download and install MSYS2. You can download it from [msys2.org](https://www.msys2.org/) or [github.com/msys2/msys2-installer/releases](https://github.com/msys2/msys2-installer/releases).
+    The following steps can be done in any MSYS-provided shell (it will start up with a UCRT64 shell after installation).
+2.
+    Install git and the toolchain:
+	```
+    pacman -S git wget mingw-w64-ucrt-x86_64-cmake mingw-w64-ucrt-x86_64-toolchain
+    ```
+3.
+    Install general dependencies:
+    ```
+    pacman -S mingw-w64-ucrt-x86_64-libsigc++ mingw-w64-ucrt-x86_64-yaml-cpp mingw-w64-ucrt-x86_64-glfw mingw-w64-ucrt-x86_64-catch mingw-w64-ucrt-x86_64-hidapi mingw-w64-ucrt-x86_64-libpng
+    ```
+4.
+    Install Vulkan dependencies:
+    ```
+    pacman -S mingw-w64-ucrt-x86_64-vulkan-headers mingw-w64-ucrt-x86_64-vulkan-loader mingw-w64-ucrt-x86_64-shaderc mingw-w64-ucrt-x86_64-glslang mingw-w64-ucrt-x86_64-spirv-tools
+    ```
+5.
+    Install FFTS:
+    ```
+    pacman -S mingw-w64-ucrt-x86_64-ffts
+    ```
+6.
+    Check out the code
+    ```
+    cd ~ 
+    git clone --recursive https://github.com/ngscopeclient/scopehal-pico-bridge
+    ```
+
+    **All following steps are to be done in a UCRT64 shell.**
+
+7.
+    Build manually:
+    ```
+    cd scopehal-pico-bridge
+    mkdir build
+    cd build
+    cmake ..
+    ninja -j4
+    ```
+	If the build fails with a lot of missing files, try adding your MSYS2 bin folder to your $PATH variable, i.e. "C:\msys64\ucrt64\bin" if you installed it to "C:\msys64".
+8.
+    To run scopehal-pico-bridge:
+    The binary can be found in the build directory, such as $HOME\scopehal-pico-bridge\build\src\ps6000d.

src/ps6000d/CMakeLists.txt

@@ -22,10 +22,14 @@ if(WIN32)
 	include_directories(${PICO_SDK_PATH}/inc/)
 elseif(APPLE)
 	include_directories(${PICO_SDK_FRAMEWORK}/Headers/libps3000a)
+	include_directories(${PICO_SDK_FRAMEWORK}/Headers/libps4000a)
+	include_directories(${PICO_SDK_FRAMEWORK}/Headers/libps5000a)
 	include_directories(${PICO_SDK_FRAMEWORK}/Headers/libps6000a)
 else()
 	# Linux specific include paths
 	include_directories(${PICO_SDK_PATH}/include/libps3000a)
+	include_directories(${PICO_SDK_PATH}/include/libps4000a)
+	include_directories(${PICO_SDK_PATH}/include/libps5000a)
 	include_directories(${PICO_SDK_PATH}/include/libps6000a)
 endif()
 
@@ -46,6 +50,8 @@ if(WIN32)
 	log
 	scpi-server-tools
 	${PICO_SDK_PATH}/lib/ps3000a.lib
+	${PICO_SDK_PATH}/lib/ps4000a.lib
+	${PICO_SDK_PATH}/lib/ps5000a.lib
 	${PICO_SDK_PATH}/lib/ps6000a.lib
 	)
 elseif(APPLE)
@@ -54,14 +60,19 @@ elseif(APPLE)
 	log
 	scpi-server-tools
 	${PICO_SDK_FRAMEWORK}/Libraries/libps3000a/libps3000a.dylib
-	${PICO_SDK_FRAMEWORK}/Libraries/libps6000a/libps6000a.dylib)
+	${PICO_SDK_FRAMEWORK}/Libraries/libps3000a/libps4000a.dylib
+	${PICO_SDK_FRAMEWORK}/Libraries/libps5000a/libps5000a.dylib
+	${PICO_SDK_FRAMEWORK}/Libraries/libps6000a/libps6000a.dylib
+	)
 else()
 	# Linux specific linker
 	target_link_libraries(ps6000d
 	xptools
 	log
 	scpi-server-tools
 	${PICO_SDK_PATH}/lib/libps3000a.so
+	${PICO_SDK_PATH}/lib/libps4000a.so
+	${PICO_SDK_PATH}/lib/libps5000a.so
 	${PICO_SDK_PATH}/lib/libps6000a.so
 	)
 endif()