Monitor options¶

monitor_port¶

Type: String | Multiple: No

Port, a number or a device name, or valid URL Handlers.

To print all available serial ports please use pio device list command.

Please note that you can use patterns for serial ports:

Example:

[env:custom_monitor_port]
...
; Unix
monitor_port = /dev/ttyUSB1

; Windows, COM1 or COM3
monitor_port = COM[13]

; Socket
monitor_port = socket://localhost:4444

monitor_speed¶

Type: Number | Multiple: No | Default: 9600

A monitor speed (baud rate). See pio device monitor --baud.

Example:

[env:custom_monitor_speedrate]
...
monitor_speed = 115200

monitor_parity¶

Type: String | Multiple: No | Default: N

Enable parity checking. See pio device monitor --parity for the available values.

monitor_filters¶

Type: String | Multiple: Yes

Apply filters and text transformation for device output. See available filters at Filters.

Example:

[env:log_output_to_file_with_timestamp]
...
platform = ...
monitor_filters =
  default   ; Remove typical terminal control codes from input
  time      ; Add timestamp with milliseconds for each new line
  log2file  ; Log data to a file “platformio-device-monitor-*.log” located in the current working directory

monitor_rts¶

Type: Number (0 or 1) | Multiple: No

A monitor initial RTS line state. See pio device monitor --rts.

monitor_dtr¶

Type: Number (0 or 1) | Multiple: No

A monitor initial DTR line state. See pio device monitor --dtr.

monitor_eol¶

Type: String | Multiple: No | Default: CRLF

A monitor end of line mode. See pio device monitor --eol.

monitor_raw¶

Type: Bool (yes or no) | Multiple: No | Default: no

Disable encodings/transformations of device output. See pio device monitor --raw.

monitor_echo¶

Type: Bool (yes or no) | Multiple: No | Default: no

Enable a monitor local echo. See pio device monitor --echo.