FreeRTOS_CLIGetOutputBuffer()

FreeRTOS_CLI.h

char *FreeRTOS_CLIGetOutputBuffer( void );
		

FreeRTOS-Plus-CLI 是一个可扩展的框架， 应用程序编写者可以通过该框架定义并注册自己的命令行输入命令。 此框架提供了单独的 文档页面，描述了 如何编写实现行为的函数 （该行为为用户定义命令行为）， 如何 使用 FreeRTOS-Plus-CLI 注册用户定义命令。 以及如何将 FreeRTOS-Plus-CLI 集成到 FreeRTOS 任务中。

此页面介绍了可选的 FreeRTOS_CLIGetOutputBuffer() 函数。

命令解释器实现需要输出缓冲区， 用于保存运行命令生成的任何输出。

如果 FreeRTOS-Plus-CLI 用于实现单个命令解释器接口， 则可以在本地为执行 FreeRTOS_CLIProcessCommand() 的任务或文件。 API 函数的任务或文件定义输出缓冲区。

如果 FreeRTOS-Plus-CLI 用于在多个接口 （如 UART 和 TCP/IP 套接字）实现命令解释器，那么这两个接口 可以以相同的方式提供自己的输出缓冲区。 但是，如果一次只使用一个接口， 那么 RAM 可以通过 让两个接口共享一个输出缓冲区来节省。 提供了 FreeRTOS_CLIGetOutputBuffer() 来简化此过程。

参数：

无。

返回：

FreeRTOS_CLIGetOutputBuffer () 仅返回 在 FreeRTOS-Plus-CLI 代码中声明的输出缓冲区地址 - 移除了命令接口实现来声明自己的输出缓冲区地址的需求。

缓冲区的大小由 configCOMMAND_INT_MAX_OUTPUT_SIZE 常量定义，每当使用 FreeRTOS-Plus-CLI 时，都应在 FreeRTOSConfig.h 中定义该常量 。

configCOMMAND_INT_MAX_OUTPUT_SIZE 应设置为 1 以最小化 RAM 的使用， 如果所有命令解释器接口都使用自己的本地定义的缓冲区， 并且不使用 FreeRTOS_CLIGetOutputBuffer () API 函数。