Changelog, version bump and manual update

Author: jankae

.github/workflows/Build.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - siglent
   pull_request:
     branches:
       - main

CHANGELOG.md

@@ -1,9 +1,12 @@
 # Changelog
 
-## v0.2.4
+## v0.3.0
 
+- add emulation mode for use with Siglent VNAs
 - update to Pico SDK 2.1.1 (improves USB stability)
-- accept \\r\\n and \\n as line endings for SCPI commands
+- fix intermittent deadlock during USB communication
+- fix timing of CS pin to flash chip which can lead to failed writes
+- accept \\r\\n and \\n as line endings for SCPI commands 
 
 ## v0.2.3
 
@@ -17,4 +20,4 @@
 
 ## v0.2.1
 
-First public release
+First public release

Documentation/manual.pdf

@@ -175,8 +175,8 @@ \subsection{Buttons}
 \subsection{LEDs}
 \begin{itemize}
 \item \textbf{Power:} Always on.
-\item \textbf{Ready:} On when the heater has reached the required temperature.
-\item \textbf{Wait:} On while temperature has not yet settled. Do not make calibration measurements while this LED is on.
+\item \textbf{Ready:} On or blinking when the heater has reached the required temperature.
+\item \textbf{Wait:} On or blinking while temperature has not yet settled. Do not make calibration measurements while this LED is on.
 \item \textbf{Port[1-4]:}
 \begin{itemize}
 \item \textbf{While manually changing settings:} The LED corresponding to the currently selected port flashes.
@@ -288,4 +288,19 @@ \subsection{Adding user-defined coefficients}
 If the touchstone file uses any other format, it must either be converted before copying it to \mbox{LIBRECAL\_R}W or the \dev{}-GUI must be used to import the touchstone file and create the coefficient from that.
 
 
+\section{USB modes}
+The \dev{} is primarely used to calibrate the LibreVNA with the functions and protocol described in this document. VNAs from other manufacturers usually have their own proprietary protocol and will not detect the \dev{}. However, for some VNAs and protocols it is possible to reverse engineer their functions and add an emulation mode to the \dev{}. That way, it can be used to automatically calibrate these VNAs as well.
+
+To enable an emulation mode, the calibration coefficients must be stored on the LibreCAL in the reverse engineered format. This can be achieved with the supplied scripts\footnote{\url{https://github.com/jankae/LibreCAL/blob/main/Software/Scripts}}.
+
+When the \dev{} starts and detects this data, it will automatically enter the corresponding emulation mode. This is indicated by a blinking wait or ready LED (which would be constantly on in the default mode). When an emulation mode is active, the \dev{} will not be recognized by the \dev{}-GUI or LibreVNA-GUI anymore. You can press and hold the function button while applying power to force the \dev{} into its default mode.
+
+Currently emulation modes for the following VNAs from other manufacturers are supported:
+\begin{itemize}
+\item Siglent SVA1000X series
+\item Siglent SNA5000A series
+\end{itemize}
+If you have access to electronic calibration modules from unsupported manufacturers and the capability to reverse engineer their protocols please get in touch to extend this list.
+
+
 \end{document}

Documentation/manual.tex

@@ -62,7 +62,7 @@ windows{
 
 REVISION = $$system(git rev-parse HEAD)
 DEFINES += GITHASH=\\"\"$$REVISION\\"\"
-DEFINES += FW_MAJOR=0 FW_MINOR=2 FW_PATCH=4 FW_SUFFIX=""#\\"\"-alpha.2\\"\"
+DEFINES += FW_MAJOR=0 FW_MINOR=3 FW_PATCH=0 FW_SUFFIX=""#\\"\"-alpha.2\\"\"
 
 # Default rules for deployment.
 qnx: target.path = /tmp/$${TARGET}/bin

Software/LibreCAL-GUI/LibreCAL-GUI.pro

@@ -31,8 +31,8 @@ target_include_directories(FreeRTOS PUBLIC
 
 add_definitions(
 -DFW_MAJOR=0
--DFW_MINOR=2
--DFW_PATCH=4
+-DFW_MINOR=3
+-DFW_PATCH=0
 #-DENABLE_UART
 )