Websocket shell backend

Shell access over a WebSocket connection. More...

Files
file	shell_websocket.h
	Header file for the WebSocket shell backend.

Macros
#define	WEBSOCKET_CONSOLE_DEFINE(_service, _sec_tag_list, _sec_tag_list_size)
	Define a websocket shell service.
#define	WEBSOCKET_CONSOLE_ENABLE(_service)
	Enable a websocket shell service defined with WEBSOCKET_CONSOLE_DEFINE.

Detailed Description

Shell access over a WebSocket connection.

Macro Definition Documentation

WEBSOCKET_CONSOLE_DEFINE

#define WEBSOCKET_CONSOLE_DEFINE	(		_service,
			_sec_tag_list,
			_sec_tag_list_size )

#include <zephyr/shell/shell_websocket.h>

Value:

static uint16_t SHELL_WS_PORT_NAME(_service) =                  \
        CONFIG_SHELL_WEBSOCKET_PORT;                            \
HTTP_SERVICE_DEFINE(_service,                                   \
                    CONFIG_SHELL_WEBSOCKET_IP_ADDR,             \
                    &SHELL_WS_PORT_NAME(_service),              \
                    SHELL_WEBSOCKET_SERVICE_COUNT,              \
                    SHELL_WEBSOCKET_SERVICE_COUNT,              \
                    NULL, NULL, NULL);                          \
DEFINE_WEBSOCKET_SERVICE(_service)

Define a websocket shell service.

Defines the websocket shell transport, its shell instance, and the HTTP(S) service that exposes it at CONFIG_SHELL_WEBSOCKET_ENDPOINT_URL.

Parameters

_service	Name of the websocket service instance.
_sec_tag_list	TLS security tag list for the secure (HTTPS) connection. Ignored when TLS is not enabled.
_sec_tag_list_size	Number of entries in _sec_tag_list.

WEBSOCKET_CONSOLE_ENABLE

#define WEBSOCKET_CONSOLE_ENABLE

(

_service

)

#include <zephyr/shell/shell_websocket.h>

Value:

(void)shell_websocket_enable(&GET_WS_SHELL_NAME(_service))

Enable a websocket shell service defined with WEBSOCKET_CONSOLE_DEFINE.

Parameters

_service

Name of the websocket service instance.