mirror of
https://github.com/espressif/esp-idf.git
synced 2026-02-01 01:06:17 +00:00
126 lines
3.9 KiB
C
126 lines
3.9 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Unlicense OR CC0-1.0
|
|
*/
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
#include <fcntl.h>
|
|
#include "esp_system.h"
|
|
#include "esp_log.h"
|
|
#include "esp_console.h"
|
|
#include "esp_vfs_dev.h"
|
|
#include "driver/uart.h"
|
|
#include "driver/uart_vfs.h"
|
|
#include "linenoise/linenoise.h"
|
|
#include "argtable3/argtable3.h"
|
|
#include "console_settings.h"
|
|
|
|
#define CONSOLE_MAX_CMDLINE_ARGS 8
|
|
#define CONSOLE_MAX_CMDLINE_LENGTH 256
|
|
#define CONSOLE_PROMPT_MAX_LEN (32)
|
|
|
|
static const char *TAG = "console_settings";
|
|
static char prompt[CONSOLE_PROMPT_MAX_LEN];
|
|
|
|
void initialize_console_peripheral(void)
|
|
{
|
|
/* Drain stdout before reconfiguring it */
|
|
fflush(stdout);
|
|
fsync(fileno(stdout));
|
|
|
|
/* Disable buffering on stdin */
|
|
setvbuf(stdin, NULL, _IONBF, 0);
|
|
|
|
/* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
|
|
uart_vfs_dev_port_set_rx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CR);
|
|
/* Move the caret to the beginning of the next line on '\n' */
|
|
uart_vfs_dev_port_set_tx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CRLF);
|
|
|
|
/* Configure UART */
|
|
const uart_config_t uart_config = {
|
|
.baud_rate = CONFIG_ESP_CONSOLE_UART_BAUDRATE,
|
|
.data_bits = UART_DATA_8_BITS,
|
|
.parity = UART_PARITY_DISABLE,
|
|
.stop_bits = UART_STOP_BITS_1,
|
|
#if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32S2
|
|
.source_clk = UART_SCLK_REF_TICK,
|
|
#else
|
|
.source_clk = UART_SCLK_XTAL,
|
|
#endif
|
|
};
|
|
|
|
/* Install UART driver for interrupt-driven reads and writes */
|
|
ESP_ERROR_CHECK(uart_driver_install(CONFIG_ESP_CONSOLE_UART_NUM,
|
|
256, 0, 0, NULL, 0));
|
|
ESP_ERROR_CHECK(uart_param_config(CONFIG_ESP_CONSOLE_UART_NUM, &uart_config));
|
|
|
|
/* Tell VFS to use UART driver */
|
|
uart_vfs_dev_use_driver(CONFIG_ESP_CONSOLE_UART_NUM);
|
|
}
|
|
|
|
void initialize_console_library(const char *history_path)
|
|
{
|
|
/* Initialize the console */
|
|
esp_console_config_t console_config = {
|
|
.max_cmdline_args = CONSOLE_MAX_CMDLINE_ARGS,
|
|
.max_cmdline_length = CONSOLE_MAX_CMDLINE_LENGTH,
|
|
#if CONFIG_LOG_COLORS
|
|
.hint_color = atoi(LOG_COLOR_CYAN)
|
|
#endif
|
|
};
|
|
ESP_ERROR_CHECK(esp_console_init(&console_config));
|
|
|
|
/* Configure linenoise line completion library */
|
|
linenoiseSetMultiLine(1);
|
|
|
|
/* Tell linenoise where to get command completions and hints */
|
|
linenoiseSetCompletionCallback(&esp_console_get_completion);
|
|
linenoiseSetHintsCallback((linenoiseHintsCallback*) &esp_console_get_hint);
|
|
|
|
/* Set command history size */
|
|
linenoiseHistorySetMaxLen(100);
|
|
|
|
/* Set command maximum length */
|
|
linenoiseSetMaxLineLen(console_config.max_cmdline_length);
|
|
|
|
/* Don't return empty lines */
|
|
linenoiseAllowEmpty(false);
|
|
|
|
#if CONFIG_CONSOLE_STORE_HISTORY
|
|
/* Load command history from filesystem */
|
|
if (history_path) {
|
|
linenoiseHistoryLoad(history_path);
|
|
}
|
|
#endif
|
|
|
|
/* Figure out if the terminal supports escape sequences */
|
|
int probe_status = linenoiseProbe();
|
|
if (probe_status) { /* zero indicates success */
|
|
ESP_LOGW(TAG, "Your terminal application does not support escape sequences.\n"
|
|
"Line editing and history features are disabled.\n"
|
|
"On Windows, try using Windows Terminal or Putty instead.");
|
|
linenoiseSetDumbMode(1);
|
|
}
|
|
}
|
|
|
|
char *setup_prompt(const char *prompt_str)
|
|
{
|
|
const char *prompt_temp = "esp>";
|
|
if (prompt_str) {
|
|
prompt_temp = prompt_str;
|
|
}
|
|
|
|
/* Set command line prompt */
|
|
if (linenoiseIsDumbMode()) {
|
|
/* Since the terminal doesn't support escape sequences,
|
|
* don't use color codes in the prompt */
|
|
snprintf(prompt, CONSOLE_PROMPT_MAX_LEN - 1, "%s ", prompt_temp);
|
|
} else {
|
|
snprintf(prompt, CONSOLE_PROMPT_MAX_LEN - 1, LOG_COLOR_I "%s " LOG_RESET_COLOR, prompt_temp);
|
|
}
|
|
|
|
return prompt;
|
|
}
|