Skip to content

Commit d08e779

Browse files
update vs and vscode docs
1 parent 80d8cd3 commit d08e779

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

‎docs/embedded/serial-monitor.md‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,30 @@ The Serial Monitor allows users to configure, monitor, and communicate with seri
1616

1717
![Serial Monitor in VS](media/serial-monitor.png)
1818

19+
## Capabilities
20+
21+
- **Monitor a serial port**: Choose the **Start Monitoring** or **Stop Monitoring** button to control whether to monitor data coming from the port.
22+
- **Send data to a serial port**: Enter text into the text field at the bottom of the view. Use the **Enter** key or choose the **Send Message** button to send the data.
23+
- **Clear the Serial Monitor output**: Choose the **Clear Output** button to clear the incoming data text field.
24+
- **Send preset control signals**: Use the split-button next to the input field to send preset control signals (Ctrl+C, Ctrl+D, Ctrl+X, and Ctrl+Z).
25+
- **Configure Serial Monitor and port connection settings**: See the following table to learn about the settings that the Serial Monitor provides.
26+
27+
## Configurable settings
28+
29+
| Settings | Description | Usage | Available options |
30+
|--|--|--|--|
31+
| **Port** | Ports that are actively connected to a device | Use the **Port** dropdown | Serial port compatible devices connected to the machine |
32+
| **Baud Rate** | Frequency at which the monitor attempts to communicate with the connected device | Use the **Baud Rate** dropdown | 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230000, 250000 |
33+
| **Line Ending** | The line ending to use in messages sent to the connected device | Use the **Line Ending** dropdown | None, LF, CR, CRLF |
34+
| **Timestamp** | Adds timestamps to the output of data received from the connected port | Use the **timestamp** toggle button | On/Off |
35+
| **Autoscroll** | Whether to auto-scroll new content that comes from the connected port | Use the **autoscroll** toggle button | On/Off |
36+
| **Automatic Reconnection** | Allows for automatic reconnection and monitoring of disconnected selected ports | Use the **automatic reconnection** toggle button | On/Off|
37+
| **Message Encoding** | Can select type of encoding for messages sent to serial port | Use the **message encoding** dropdown | Text (utf8), Hex, Binary |
38+
1939
# [Visual Studio Code](#tab/visual-studio-code)
2040

2141
![Serial Monitor in VSCode](media/serial-monitor-vscode.png)
2242

23-
---
24-
2543
## Capabilities
2644

2745
- **Monitor a serial port**: Choose the **Start Monitoring** or **Stop Monitoring** button to control whether to monitor data coming from the port.
@@ -41,3 +59,5 @@ The Serial Monitor allows users to configure, monitor, and communicate with seri
4159
| **Autoscroll** | Whether to auto-scroll new content that comes from the connected port | Use the **autoscroll** toggle button | On/Off |
4260
| **Automatic Reconnection** | Allows for automatic reconnection and monitoring of disconnected selected ports | Use the **automatic reconnection** toggle button | On/Off|
4361
| **Message Encoding** | Can select type of encoding for messages sent to serial port | Use the **message encoding** dropdown | Text (utf8), Hex, Binary |
62+
63+
---

0 commit comments

Comments
 (0)