Wire the board
- Connect the board’s USB serial interface, or a UART adapter your operating system supports. Install the adapter’s driver if its port doesn’t appear.
- For a separate adapter, connect target TX to adapter RX and connect ground. Connect adapter TX to target RX only when you need to send input.
- Match the adapter’s signal voltage to the board.
For a remote bridge, the port, driver, and device permissions belong to the hardware host. Bridge ports start with
bridge: and the bridge name.
Connect in the Monitor
- Open a Serial Monitor tab. See Open a Serial Monitor tab.
- Select the Port. Each entry shows the port and the device name.
- Leave Mode set to UART.
- Set Baud to the firmware’s rate, or select Detect baud. The list runs from 300 to 921600 and includes 74880 for ESP bootloader output.
- Set NL to the line ending your firmware expects for commands: LF (\n), CR (\r), CRLF (\r\n), or None.
- Select Connect.
Port COM3 is already open at 115200 baud, cannot change to 9600 baud. To change the rate, disconnect, set Baud, and connect again.
When another program opens the port, such as a flasher or a separate terminal, the tab shows Paused and sending is blocked. The tab reconnects when the port is free. Select Paused to disconnect instead.
Read firmware output
Replace the example port with your board’s port:--- agent monitor capture started --- and --- agent monitor capture ended (N bytes) --- lines. If you don’t give a baud rate, Embedder detects it.
A successful connection doesn’t show that the firmware is running correctly. Check that the expected message appeared. Output sent before any connection was open is lost. Reset the board deliberately, or wait for the next run.
To inspect output that’s already captured, without opening another connection:
Send a command
Type a command your firmware supports in the Type command… box and pressEnter, or select Send. The Monitor adds the NL line ending. Press the up and down arrow keys to recall earlier commands. Check the response before you send another command.
For example, if the firmware implements a status command terminated by LF, select LF (\n) under NL, send status, and confirm the expected response. Your firmware defines the command and its response.
When you ask Embedder to send a command, it asks for approval and sends the command through the Serial Monitor tab connected to that port, so the tab’s NL setting applies. A new tab uses LF (\n). Embedder reports about one second of response, up to 50 lines. For a longer response, ask Embedder to read the history afterward.
Reset to capture boot output
Ask for a reset only when it matches the board’s wiring and the test you intend to run. Name the reset method when you ask Embedder to capture boot output:Troubleshoot
- Port missing: check the USB cable, power, driver, and which machine the device is attached to.
- Access denied or port busy: close other serial programs and check the host’s serial-device permissions.
Permission deniedon Linux: add your user to thedialoutgroup withsudo usermod -a -G dialout $USER, then log out and back in.- Garbled output: confirm the firmware’s baud rate, or select Detect baud. Check the board and adapter voltage levels.
- Connected but silent: check TX/RX wiring, firmware logging, and whether the output happened before you connected.
- Command has no response: check the command, the target RX connection, and the NL setting.
- Tab shows Paused: another program has the port open. Close it, or wait for the flash to finish.