caiyu/LibreVNA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Jan Käberich 2023-07-30 13:08:06 +02:00
parent 853cf310c9
commit 6901278185
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/DeveloperInfo/Device_protocol_v13.pdf
View File

Binary file not shown.

4
Documentation/DeveloperInfo/Device_protocol_v13.tex
View File

@ -174,7 +174,7 @@ This document describes the device protocol of the LibreVNA. This is the protoco
Depending on the LibreVNA, different hardware interfaces may be used for the implementation of this protocol. Depending on the LibreVNA, different hardware interfaces may be used for the implementation of this protocol.
\subsection{USB device} \subsection{USB device}
The LibreVNA implements a ``custom class'' USB device. It uses a VID of 0x0483 and a PID of 0x4121. The custom class contains a single interface with three bulk endpoints: The LibreVNA implements a ``custom class'' USB device. It uses a VID of 0x1209 and a PID of 0x4121. The custom class contains a single interface with three bulk endpoints:
\begin{itemize} \begin{itemize}
\item \textbf{Endpoint 0x01:} Communication data from the USB host to the LibreVNA \item \textbf{Endpoint 0x01:} Communication data from the USB host to the LibreVNA
\item \textbf{Endpoint 0x81:} Communication data from the LibreVNA to the USB host \item \textbf{Endpoint 0x81:} Communication data from the LibreVNA to the USB host
@ -766,7 +766,7 @@ The packet contains the following fields:
%\insertTableNotes % tell LaTeX where to insert the table-related notes %\insertTableNotes % tell LaTeX where to insert the table-related notes
\endlastfoot \endlastfoot
0 & 2 & UINT16 & ProtocolVersion & Set to 12. If another value is reported, refer to the corresponding protocol description.\\ 0 & 2 & UINT16 & ProtocolVersion & Set to 13. If another value is reported, refer to the corresponding protocol description.\\
2 & 1 & UINT8 & FW\_major & Major firmware version \\ 2 & 1 & UINT8 & FW\_major & Major firmware version \\
3 & 1 & UINT8 & FW\_minor & Minor firmware version \\ 3 & 1 & UINT8 & FW\_minor & Minor firmware version \\
4 & 1 & UINT8 & FW\_patch & Patch of the firmware version \\ 4 & 1 & UINT8 & FW\_patch & Patch of the firmware version \\

2
README.md
View File

@ -17,7 +17,7 @@ This is the improved version of my [first attempt](https://www.github.com/jankae
* Download the latest [Release](https://github.com/jankae/LibreVNA/releases) and unpack the zip file * Download the latest [Release](https://github.com/jankae/LibreVNA/releases) and unpack the zip file
* Install the required libraries: * Install the required libraries:
```console ```console
sudo apt install libqt6widgets6 sudo apt install libqt6widgets6 libqt6svg6
``` ```
* Install the udev rule (otherwise you don't have the permissions to access the USB device): * Install the udev rule (otherwise you don't have the permissions to access the USB device):
```console ```console