Starting a new session.
SerialMonitor.EXE /new port_name <data_viewer_to_open[:data_redirection_options]>
/new - the command to start a new session.
port_name - the name of the COM port to monitor, for example, COM1.
data_viewer_to_open - selected data viewing modes.
You can select one or several data visualizers to be used during your monitoring session:
T|L|R|D|M - Table | Line | TeRminal | Dump | Modbus
Table view displays the table of the recorded IRPs.
Line view displays detailed information about requests, passed through a particular serial line.
Dump view displays sent and received data passed through a serial line.
Terminal view is a text console that shows all the received data as ASCII characters.
Modbus view displays received and sent Modbus data (RTU or ASCII).
Modbus modes: M:M=R (Modbus RTU),
M:M=A (Modbus ASCII)
[1..6] - select which events to monitor (optional). By default, the monitoring of all events is enabled.
1 - Open/Close on, Read/Write off, Device Control off
2 - Open/Close off, Read/Write on, Device Control off
3 - Open/Close on, Read/Write on, Device Control off
4 - Open/Close off, Read/Write off, Device Control on
5 - Open/Close on, Read/Write off, Device Control on
6 - Open/Close off, Read/Write on, Device Control on
[A-] - not to start a monitoring session automatically (optional).
Examples:
SerialMonitor.EXE /new com1 T
Starting a new monitoring session. “com1” is a serial port to monitor. Table View (T) is selected for displaying captured data.
SerialMonitor.EXE /new com1 TLA-
Starting a new monitoring session. “com1” is a serial port to monitor. Table (T) and Line (L) Views are selected for displaying captured data. The option to start the monitoring automatically is disabled (A-).
SerialMonitor.EXE /new com1 T2
Starting a new monitoring session. “com1” is a serial port to monitor. Table View (T) is selected for displaying captured data. Read/Write events are selected to be captured (2).
SerialMonitor.EXE /new com1 M:M=A
Starting a new monitoring session. “com1” is a serial port to monitor. Modbus View (M) is selected for displaying captured data. (M=A) - Modbus ASCII mode is enabled.
SerialMonitor.EXE /new com1 TMA-:M=R
Starting a new monitoring session. “com1” is a serial port to monitor. Table (T) and Modbus (M) Views are selected for displaying captured data. The option to start the monitoring automatically is disabled (A-). (M=R) - Modbus RTU mode is enabled.
4. Redirecting captured data to a file.
SerialMonitor.EXE /new <port_name> <data_viewer_to_open>[:data_redirection_options]
Data redirection options: Specify the file format and whether to split data being redirected.
[Split_or_limit:]<file_type>=<file_name>[:A]
Split or limit (optional) - Specify whether the data should be split or data redirection should be limited.
Block format:
T|S|L|i
(T) - split file by time every [time]. The current time will be added to a file name as YY-MM-DD hh-mm-ss.
(S) - split the output into a bunch of files not bigger than the specified size. Note: The actual file size can be bigger if data is coming too fast.
(L) - limit the file size to the specific value [size]. When the current file size gets bigger than the specified size, the file will be renamed to -old.
(i) - split file by idle time every [time]. The current time will be added to a file name as YY-MM-DD hh-mm-ss.
Examples:
T=2H, T=90M, T=120S - split file every 2 hours; 90 minutes; 120 seconds.
S=5M, S=100K - split file into the files of 10 MB, 100 KB.
L=10M, L=350K - the file cannot be bigger than 10 MB, 350 KB.
i=15s, i=5M, i=1H - split file if idle for 15 seconds; 1 hour.
File type: type of the file to export data to:
A|U|H|C
A - ANSI
U - Unicode
H - HTML
C - CSV
[:A] - Append data to a file instead of overwriting it. (Disabled by default.)
Examples:
SerialMonitor.EXE /new com1 T:C=table.csv R
Starting a new session and opening the Table View (T). Saving captured data to a CSV file (:C). Additionally, opening the Terminal View (R).
SerialMonitor.EXE /new com1 T:C=table.csv:A D:S=5M:A=data.txt
Starting a new session and opening the Table View (T). Saving captured data to a CSV file (:C). Enabling the option to automatically add data to the end of the file (:A). Additionally, opening the Dump View (D) and saving captured data to an ANSI file (:A). Enabling the option to split data into chunks of 5Mb (:S).
Opening a saved session:
SerialMonitor.EXE /open <file_name> [data_viewer_to_open][:data_redirection_options]
/open - command to open a saved session.
<file_name> - path to an .spm file with the session you would like to open.
[data_viewer_to_open] - selected visualizers to view captured data. (See the command-line syntax.)
[:redirection_options] - setting up data redirection to a file. (See the command-line syntax.)
Examples:
SerialMonitor.EXE /open session1.spm
Opening a session file “session1.spm” with the pre-saved session settings.
SerialMonitor.EXE /open session1.spm TR
Opening a session file “session1.spm” with the Table (T) and Terminal (R) Views.
SerialMonitor.EXE /open session1.spm T:C=table.csv L
Opening a session file “session1.spm” with the Table (T) and Line Views (L). Redirecting data from the Table View to a CSV file (:C).
Note:
The Serial Port Monitor command line is not case-sensitive.
The executable file for 32-bit Windows systems can be found at:
C:\Program Files\Electronic Team\Serial Port Monitor\SerialMonitor.exe
The executable file for 64-bit Windows systems can be found at:
C:\Program Files\Electronic Team\Serial Port Monitor\SerialMonitorx64.exe