system_telecommand_defs.h File Reference

#include <stdint.h>
#include "telecommand_exec/telecommand_types.h"

Include dependency graph for system_telecommand_defs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
uint8_t	TCMDEXEC_hello_world (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	A simple telecommand that responds with "Hello, world!" (log message and TCMD response)
uint8_t	TCMDEXEC_core_system_stats (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
uint8_t	TCMDEXEC_available_telecommands (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
uint8_t	TCMDEXEC_reboot (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
uint8_t	TCMDEXEC_system_self_check_failures_as_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	System self-check of all peripherals and systems.
uint8_t	TCMDEXEC_system_self_check_as_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	System self-check of all peripherals and systems.
uint8_t	TCMDEXEC_obc_get_rbf_state (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)

Function Documentation

TCMDEXEC_available_telecommands()

uint8_t TCMDEXEC_available_telecommands	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

TCMDEXEC_core_system_stats()

uint8_t TCMDEXEC_core_system_stats	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

Here is the call graph for this function:

TCMDEXEC_hello_world()

uint8_t TCMDEXEC_hello_world	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

A simple telecommand that responds with "Hello, world!" (log message and TCMD response)

Parameters

args_str	No arguments expected
response_output_buf	The buffer to write the response to
response_output_buf_len	The maximum length of the response_output_buf (its size)

Returns

0 if successful, >0 if an error occurred (but hello_world can't return an error)

Here is the call graph for this function:

TCMDEXEC_obc_get_rbf_state()

uint8_t TCMDEXEC_obc_get_rbf_state	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

Here is the call graph for this function:

TCMDEXEC_reboot()

uint8_t TCMDEXEC_reboot	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

Here is the call graph for this function:

TCMDEXEC_system_self_check_as_json()

uint8_t TCMDEXEC_system_self_check_as_json	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

System self-check of all peripherals and systems.

Parameters

args_str	No arguments expected
response_output_buf	Buffer is filled with a JSON list of strings of the FAILING checks

Returns

0 regardless; see the response_output_buf for the results of the self-check.

Note

Output is a JSON list of the failing checks (as strings). Returns 0 regardless.

Here is the call graph for this function:

TCMDEXEC_system_self_check_failures_as_json()

uint8_t TCMDEXEC_system_self_check_failures_as_json	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_len )

System self-check of all peripherals and systems.

Parameters

args_str	No arguments expected
response_output_buf	Buffer is filled with a JSON list of strings of the FAILING checks

Returns

0 regardless; see the response_output_buf for the results of the self-check.

Note

Output is a JSON list of the failing checks (as strings). Returns 0 regardless.

Here is the call graph for this function: