meshx_shell.h File Reference

Platform-agnostic shell interface for MeshX. More...

#include "meshx_err.h"

Go to the source code of this file.

Data Structures
struct	meshx_shell_cmd_t
	Shell command structure. More...

Macros
#define	MESHX_SHELL_MAX_COMMANDS   32

Typedefs
typedef int(*	meshx_shell_func_t) (int argc, char **argv)
	Shell command function pointer type.

Functions
meshx_err_t	meshx_shell_init (void)
	Initializes the MeshX shell core and the underlying platform console.
meshx_err_t	meshx_shell_register_command (const meshx_shell_cmd_t *cmd)
	Registers a command with the MeshX shell.
meshx_err_t	meshx_shell_start (void)
	Starts the MeshX shell task.
void	meshx_shell_printf (const char *fmt,...)
	Prints a message to the shell console.

Detailed Description

Platform-agnostic shell interface for MeshX.

Copyright © 2024 - 2025 MeshX

Macro Definition Documentation

MESHX_SHELL_MAX_COMMANDS

#define MESHX_SHELL_MAX_COMMANDS   32

Typedef Documentation

meshx_shell_func_t

typedef int(* meshx_shell_func_t) (int argc, char **argv)

Shell command function pointer type.

Function Documentation

meshx_shell_init()

meshx_err_t meshx_shell_init

(

void

)

Initializes the MeshX shell core and the underlying platform console.

Returns

meshx_err_t MESHX_SUCCESS on success, error code otherwise.

                                   {
    if (shell_ctx.initialized) return MESHX_SUCCESS;
 
    memset(&shell_ctx, 0, sizeof(shell_ctx));
    MESHX_LOGD(MODULE_ID_COMMON, "Initializing MeshX Shell...");
 
    meshx_err_t err = meshx_platform_console_init();
    if (err != MESHX_SUCCESS) {
        MESHX_LOGE(MODULE_ID_COMMON, "Platform console init failed: %d", err);
        return err;
    }
 
    shell_ctx.initialized = true;
    MESHX_LOGD(MODULE_ID_COMMON, "MeshX Shell Initialized");
    return MESHX_SUCCESS;
}

meshx_shell_printf()

void meshx_shell_printf	(	const char *	fmt,
			... )

Prints a message to the shell console.

Parameters

[in]	fmt	Format string.
[in]	...	Arguments.

                                              {
    va_list args;
    va_start(args, fmt);
    meshx_tiny_vprintf(fmt, args);
    va_end(args);
}

meshx_shell_register_command()

meshx_err_t meshx_shell_register_command

(

const meshx_shell_cmd_t *

cmd

)

Registers a command with the MeshX shell.

Parameters

[in]

cmd

Pointer to the command structure.

Returns

meshx_err_t MESHX_SUCCESS on success, error code otherwise.

                                                                       {
    if (!shell_ctx.initialized) {
        MESHX_LOGE(MODULE_ID_COMMON, "Shell not initialized, cannot register command '%s'", cmd->command);
        return MESHX_ERR_NOT_INIT;
    }
    if (shell_ctx.cmd_count >= MESHX_SHELL_MAX_COMMANDS) return MESHX_FAIL;
 
    shell_ctx.commands[shell_ctx.cmd_count++] = *cmd;
    return MESHX_SUCCESS;
}

meshx_shell_start()

meshx_err_t meshx_shell_start

(

void

)

Starts the MeshX shell task.

Returns

meshx_err_t MESHX_SUCCESS on success, error code otherwise.

                                    {
    meshx_task_t task_cfg = {
        .task_cb = shell_task,
        .task_name = "meshx_shell",
        .stack_size = 4096,
        .priority = 4,
        .arg = NULL
    };
 
    return meshx_task_create(&task_cfg);
}