Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Shell access over a SEGGER RTT channel. More...

Files

file  shell_rtt.h
 Header file for the RTT shell backend.

Macros

#define SHELL_RTT_DEFINE(_name)
 Define an RTT shell transport instance.

Functions

const struct shellshell_backend_rtt_get_ptr (void)
 Function provides pointer to shell rtt backend instance.

Detailed Description

Shell access over a SEGGER RTT channel.

Macro Definition Documentation

◆ SHELL_RTT_DEFINE

#define SHELL_RTT_DEFINE ( _name)

#include <zephyr/shell/shell_rtt.h>

Value:
static struct shell_rtt _name##_shell_rtt; \
struct shell_transport _name = { \
.api = &shell_rtt_transport_api, \
.ctx = (struct shell_rtt *)&_name##_shell_rtt \
}
Shell transport instance.
Definition shell.h:948

Define an RTT shell transport instance.

Parameters
_nameName of the transport instance.

Function Documentation

◆ shell_backend_rtt_get_ptr()

const struct shell * shell_backend_rtt_get_ptr ( void )

#include <zephyr/shell/shell_rtt.h>

Function provides pointer to shell rtt backend instance.

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

Returns
Pointer to the shell instance.