UART shell backend

Shell access over a UART serial connection. More...

Files
file	shell_uart.h
	Header file for the UART shell backend.

Macros
#define	SHELL_UART_DEFINE(_name, ...)
	Macro for creating shell UART transport instance named _name.

Functions
const struct shell *	shell_backend_uart_get_ptr (void)
	This function provides pointer to the shell UART backend instance.
struct smp_shell_data *	shell_uart_smp_shell_data_get_ptr (void)
	This function provides pointer to the smp shell data of the UART shell transport.

Detailed Description

Shell access over a UART serial connection.

Macro Definition Documentation

SHELL_UART_DEFINE

#define SHELL_UART_DEFINE	(		_name,
			... )

#include <zephyr/shell/shell_uart.h>

Value:

static SHELL_UART_STRUCT _name##_shell_uart;                                               \
struct shell_transport _name = {                                                           \
        .api = &shell_uart_transport_api,                                                  \
        .ctx = (struct shell_telnet *)&_name##_shell_uart,                                 \
}

Macro for creating shell UART transport instance named _name.

Note

Additional arguments are accepted (but ignored) for compatibility with previous Zephyr version, it will be removed in future release.

Function Documentation

shell_backend_uart_get_ptr()

const struct shell * shell_backend_uart_get_ptr

(

void

)

#include <zephyr/shell/shell_uart.h>

This function provides pointer to the shell UART backend instance.

Function returns pointer to the shell UART instance. This instance can be next used with shell_execute_cmd function in order to test commands behavior.

Returns

Pointer to the shell instance.

shell_uart_smp_shell_data_get_ptr()

struct smp_shell_data * shell_uart_smp_shell_data_get_ptr

(

void

)

#include <zephyr/shell/shell_uart.h>

This function provides pointer to the smp shell data of the UART shell transport.

Returns

Pointer to the smp shell data.