shell_dummy.h File Reference

Dummy shell backend for testing. More...

#include <zephyr/shell/shell.h>

Go to the source code of this file.

Data Structures
struct	shell_dummy

Macros
#define	SHELL_DUMMY_DEFINE(_name)

Functions
const struct shell *	shell_backend_dummy_get_ptr (void)
	This function shall not be used directly.
const char *	shell_backend_dummy_get_output (const struct shell *sh, size_t *sizep)
	Returns the buffered output in the shell and resets the pointer.
void	shell_backend_dummy_clear_output (const struct shell *sh)
	Clears the output buffer in the shell backend.
int	shell_backend_dummy_push_input (const struct shell *sh, const char *data, size_t len)
	Push input data to the dummy shell backend.
void	shell_backend_dummy_clear_input (const struct shell *sh)
	Clear the input buffer in the shell backend.

Variables
const struct shell_transport_api	shell_dummy_transport_api

Detailed Description

Dummy shell backend for testing.

Macro Definition Documentation

SHELL_DUMMY_DEFINE

#define SHELL_DUMMY_DEFINE

(

_name

)

Value:

static struct shell_dummy _name##_shell_dummy;                  \
struct shell_transport _name = {                                \
        .api = &shell_dummy_transport_api,                      \
        .ctx = (struct shell_dummy *)&_name##_shell_dummy       \
}

Function Documentation

shell_backend_dummy_clear_input()

void shell_backend_dummy_clear_input

(

const struct shell *

sh

)

Clear the input buffer in the shell backend.

Parameters

sh	Shell pointer

shell_backend_dummy_clear_output()

void shell_backend_dummy_clear_output

(

const struct shell *

sh

)

Clears the output buffer in the shell backend.

Parameters

sh	Shell pointer

shell_backend_dummy_get_output()

const char * shell_backend_dummy_get_output	(	const struct shell *	sh,
		size_t *	sizep )

Returns the buffered output in the shell and resets the pointer.

The returned data is always followed by a nul character at position *sizep

Parameters

sh	Shell pointer
sizep	Returns size of data in shell buffer

Returns

pointer to buffer containing shell output

shell_backend_dummy_get_ptr()

const struct shell * shell_backend_dummy_get_ptr

(

void

)

This function shall not be used directly.

It provides pointer to shell dummy backend instance.

Function returns pointer to the shell dummy 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_backend_dummy_push_input()

int shell_backend_dummy_push_input	(	const struct shell *	sh,
		const char *	data,
		size_t	len )

Push input data to the dummy shell backend.

This function queues input data that will be returned by subsequent read operations. Useful for testing shell input handling.

Parameters

sh	Shell pointer
data	Input data to push
len	Length of input data

Returns

0 on success, -ENOMEM if buffer is full

Variable Documentation

shell_dummy_transport_api

const struct shell_transport_api shell_dummy_transport_api

extern