Skip to content

Commit 8dcb62e

Browse files
committed
Documentation: Update SDSIO-Server documentation
1 parent 3c7deea commit 8dcb62e

2 files changed

Lines changed: 34 additions & 34 deletions

File tree

documentation/utilities.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ It communicates with the target using these [SDSIO Client interfaces](https://gi
5454
- [socket](https://github.com/ARM-software/SDS-Framework/tree/main/sds/sdsio/client/sdsio_client_socket.c) for TCP/IP communication via IoT Socket using MDK-Middleware, LwIP, or CMSIS-Driver WiFi.
5555
- [usb/bulk](https://github.com/ARM-software/SDS-Framework/tree/main/sds/sdsio/client/sdsio_client_usb_mdk.c) for communication via USB Bulk transfer using MDK-Middleware.
5656

57-
The SDS data stream is recorded to played back from `*.sds` files with the following naming convention:
57+
The SDS data stream is recorded to and played back from `*.sds` files with the following naming convention:
5858

5959
`<name>.<label>[.p].sds` (where `[.p]` is optional and present only for recorded files in playback mode)
6060

@@ -69,53 +69,56 @@ The data content of the `<name>.<label>[.p].sds` is described with metadata file
6969
- Terminate the server with `Ctrl+C` or by pressing `X`.
7070

7171
```txt
72-
usage: sdsio-server.py [-h] [-c sdsio.yml | {socket | serial | usb} [server-opts]] [options]
72+
usage: sdsio-server.py [-h] [-V] [{socket | serial | usb} [if-opts]] [-c sdsio.yml] [general-opts]
7373
7474
SDSIO-Server: record and playback SDS data stream files over USB, socket, or serial interface.
7575
Configure via *.sdsio.yml file or specify the interface parameters directly on the command line.
7676
7777
options:
78-
--help, -h Show this help message and exit
79-
--version, -V Show program's version number and exit
80-
81-
configuration:
82-
--control, -c <*.sdsio.yml> Configure interface, SDS file directories, and playback steps
78+
--help, -h Show this help message
79+
--version, -V Show program's version number
8380
8481
interface (optional, default: usb; overrides interface in *.sdsio.yml):
8582
{socket | serial | usb}
8683
socket Run TCP socket server
8784
serial Run serial server
8885
usb Run USB bulk server
8986
90-
general options:
87+
configuration:
88+
--control, -c <*.sdsio.yml> Configure interface, SDS file directories, and playback steps
89+
90+
general-opts:
9191
--playback, -p Start SDSIO-Server in playback mode (used in CI tests)
9292
--workdir <path> Directory for SDS files (overrides *.sdsio.yml; default: current directory)
9393
--mon-port, -m <port> Monitor control interface port
9494
--log, -l <file> Redirect console output to a log file (for CI use)
9595
--verbose, -v Enable debug messages
96-
--high-priority, -P Increase process priority for USB server (requires elevated privileges)
96+
--high-priority Increase process priority for USB server (requires elevated privileges)
9797
```
9898

9999
**Keyboard input (while running):**
100100

101-
| Key | Action | Key | Action |
102-
|-----|------------------|-----|----------------------|
103-
| R/r | Start recording | P/p | Start playback |
104-
| S/s | Stop | A-H | Set user flags 0-7 |
105-
| X/x | Terminate server | a-h | Clear user flags 0-7 |
101+
| Key | Action
102+
|-----|------------------
103+
| R/r | Start recording
104+
| P/p | Start playback
105+
| S/s | Stop recording/playback
106+
| A-H | Set user flags 0-7
107+
| a-h | Clear user flags 0-7
108+
| X/x | Terminate server
106109

107110
#### Serial Mode
108111

109112
```txt
110-
usage: sdsio-server.py serial -p <Serial Port> [--baudrate <Baudrate>] [--parity <Parity>] [--stopbits <Stop bits>] [--connect-timeout <Timeout>]
113+
usage: sdsio-server.py serial [-h] --port <Serial Port> [--baudrate <Baudrate>] [--parity <Parity>] [--stopbits <Stop bits>] [--connect-timeout <Timeout>] [general-opts]
111114
112115
options:
113116
-h, --help show this help message and exit
114117
115-
serial arguments (required):
116-
-p <Serial Port> Serial port (required)
118+
if-opts (required):
119+
--port <Serial Port> Serial port (required)
117120
118-
serial arguments (optional):
121+
if-opts (optional):
119122
--baudrate <Baudrate> Baudrate (default: 115200)
120123
--parity <Parity> Parity: none, even, odd, mark, space (default: none)
121124
--stopbits <Stop bits> Stop bits: 1, 1.5, 2 (default: 1)
@@ -125,21 +128,21 @@ serial arguments (optional):
125128
**Example:**
126129

127130
```bash
128-
python sdsio-server.py serial -p COM0 --baudrate 115200 --workdir ./work_dir
131+
python sdsio-server.py serial --port COM0 --baudrate 115200 --workdir ./work_dir
129132
```
130133

131134
#### Socket Mode
132135

133136
```txt
134-
usage: sdsio-server.py socket [--ipaddr <IP> | --netif <Interface>] [--port <TCP Port>]
137+
usage: sdsio-server.py socket [-h] [--ipaddr <IP> | --netif <Interface>] [--port <TCP Port>] [general-opts]
135138
136139
options:
137-
-h, --help show this help message and exit
140+
-h, --help show this help message and exit
138141
139-
socket arguments (optional):
140-
--ipaddr <IP> Server IP address (example: 192.168.0.100), cannot be used with 'netif'
141-
--netif <Interface> Network interface (example: eth0), cannot be used with 'ipaddr'
142-
--port <TCP Port> TCP port number (default: 5050)
142+
if-opts (optional):
143+
--ipaddr <IP> Server IP address (example: 192.168.0.100), cannot be used with 'netif'
144+
--netif <Interface> Network interface (example: eth0), cannot be used with 'ipaddr'
145+
--port <TCP Port> TCP port number (default: 5050)
143146
```
144147

145148
!!! Note
@@ -171,10 +174,10 @@ python sdsio-server.py socket --netif eth0 --workdir ./work_dir
171174
#### USB Mode
172175

173176
```txt
174-
usage: sdsio-server.py usb [--high-priority]
177+
usage: sdsio-server.py usb [-h] [general-opts]
175178
176179
options:
177-
-h, --help show this help message and exit
180+
-h, --help show this help message and exit
178181
```
179182

180183
!!! Note
@@ -186,9 +189,7 @@ options:
186189
!!! Note
187190
- On **macOS**, the **libusb** system library is required. If not already installed, you can install it using with [Homebrew](https://brew.sh/):
188191

189-
```bash
190-
>brew install libusb
191-
```
192+
`>brew install libusb`
192193

193194
!!! Note
194195
- On **Linux**, access to USB devices from user space requires a udev rule by default.
@@ -225,7 +226,7 @@ python sdsio-server.py usb --workdir ./data
225226
python sdsio-server.py socket --port 5050
226227

227228
# Serial server
228-
python sdsio-server.py serial -p COM3 --baudrate 115200
229+
python sdsio-server.py serial --port COM3 --baudrate 115200
229230
```
230231

231232
## SDS-View

layer/sdsio/usb/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,14 @@ The following MDK-Middleware USB software components are required:
3030
3131
### USB Vendor ID and Product ID
3232
33-
The default `USBD_Config_0.h` contains placeholder Vendor ID (VID) and Product ID (PID) values that **must** be replaced before deployment:
33+
The default `USBD_Config_0.h` contains placeholder Vendor ID (VID) and Product ID (PID) values:
3434

3535
```c
3636
#define USBD0_DEV_DESC_IDVENDOR 0xC251 // replace with your own VID
3737
#define USBD0_DEV_DESC_IDPRODUCT 0x8007 // replace with your own PID
3838
```
3939

40-
- **VID**: Must be a VID assigned to your organization by [USB-IF](https://www.usb.org/getting-vendor-id). Do not use the Keil VID (`0xC251`) in a product.
41-
- **PID**: Assign a product-specific value within your VID namespace.
40+
The VID=0xC251 (Keil) and PID=0x8007 can be used for internal testing environments with limited access. For deployments with public access, a VID/PID for mass production should be assigned.
4241

4342
## Starting SDSIO Server
4443

0 commit comments

Comments
 (0)