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

Shell access over a TELNET connection. More...

Files

file  shell_telnet.h
 Header file for the Telnet shell backend.

Macros

#define SHELL_TELNET_DEFINE(_name)
 Define a Telnet shell transport instance.

Functions

const struct shellshell_backend_telnet_get_ptr (void)
 This function provides pointer to shell telnet backend instance.

Detailed Description

Shell access over a TELNET connection.

Macro Definition Documentation

◆ SHELL_TELNET_DEFINE

#define SHELL_TELNET_DEFINE ( _name)

#include <zephyr/shell/shell_telnet.h>

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

Define a Telnet shell transport instance.

Parameters
_nameName of the transport instance.

Function Documentation

◆ shell_backend_telnet_get_ptr()

const struct shell * shell_backend_telnet_get_ptr ( void )

#include <zephyr/shell/shell_telnet.h>

This function provides pointer to shell telnet backend instance.

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

Returns
Pointer to the shell instance.