log_telecommand_defs.c File Reference

#include <stdio.h>
#include <string.h>
#include <stdint.h>
#include "log/log.h"
#include "log/log_sinks.h"
#include "telecommands/log_telecommand_defs.h"
#include "telecommand_exec/telecommand_args_helpers.h"
#include "telecommand_exec/telecommand_types.h"

Include dependency graph for log_telecommand_defs.c:

Functions
uint8_t	TCMDEXEC_log_set_sink_enabled_state (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Set a LOG sink's enabled state.
uint8_t	TCMDEXEC_log_set_system_file_logging_enabled_state (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Set a LOG subsystem's file logging enabled state.
uint8_t	TCMDEXEC_log_report_all_sink_enabled_states (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Report all LOG sink enable states.
uint8_t	TCMDEXEC_log_report_all_system_file_logging_states (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Report all LOG subsystem file logging states.
uint8_t	TCMDEXEC_log_set_sink_debugging_messages_state (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Enable or disable debugging messages for LOG sink.
uint8_t	TCMDEXEC_log_set_system_debugging_messages_state (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Enable or disable debugging messages for LOG subsystem.
uint8_t	TCMDEXEC_log_set_system_severity_mask (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: set the severity levels that a system will log.
uint8_t	TCMDEXEC_log_report_n_latest_messages_from_memory (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Report the N latest log messages into response_output_buf.
uint8_t	TCMDEXEC_log_report_messages_from_memory (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Report log messages from memory into response_output_buf (offset + count style).

Function Documentation

TCMDEXEC_log_report_all_sink_enabled_states()

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

Telecommand: Report all LOG sink enable states.

Here is the call graph for this function:

TCMDEXEC_log_report_all_system_file_logging_states()

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

Telecommand: Report all LOG subsystem file logging states.

Here is the call graph for this function:

TCMDEXEC_log_report_messages_from_memory()

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

Telecommand: Report log messages from memory into response_output_buf (offset + count style).

Parameters

args_str

Arg 0: Offset of first log message to report (0 = most recent) Arg 1: Number of log messages to report (or 0 for all messages)

Note

If offset is >= memory table size, offset is set to 0. If count is > memory table size, count is set to memory table size.

Here is the call graph for this function:

TCMDEXEC_log_report_n_latest_messages_from_memory()

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

Telecommand: Report the N latest log messages into response_output_buf.

Parameters

args_str

Arg 0: Number of latest log messages to report

Note

Recommended to use log_report_messages_from_memory instead.

Here is the call graph for this function:

TCMDEXEC_log_set_sink_debugging_messages_state()

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

Telecommand: Enable or disable debugging messages for LOG sink.

Parameters

args_str

Arg 0: Sink enum Arg 1: State 0: disable debug messages, 1: enable debug messages

FrontierSat LOG sinks LOG_SINK_UHF_RADIO = 1 LOG_SINK_FILE = 2 LOG_SINK_UMBILICAL_UART = 4

Here is the call graph for this function:

TCMDEXEC_log_set_sink_enabled_state()

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

Telecommand: Set a LOG sink's enabled state.

Parameters

args_str

Arg 0: Sink enum value Arg 1: Enabled? 0: disable sink, 1: enable sink

FrontierSat LOG sinks LOG_SINK_UHF_RADIO = 1 LOG_SINK_FILE = 2 LOG_SINK_UMBILICAL_UART = 4

Here is the call graph for this function:

TCMDEXEC_log_set_system_debugging_messages_state()

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

Telecommand: Enable or disable debugging messages for LOG subsystem.

Parameters

args_str

Arg 0: Subsystem enum Arg 1: State 0: disable debug messages, 1: enable debug messages

FrontierSat LOG subsystems LOG_SYSTEM_OBC = 1 LOG_SYSTEM_UHF_RADIO = 2 LOG_SYSTEM_UMBILICAL_UART = 4 LOG_SYSTEM_GNSS = 8 LOG_SYSTEM_MPI = 16 LOG_SYSTEM_EPS = 32 LOG_SYSTEM_BOOM = 64 LOG_SYSTEM_ADCS = 128 LOG_SYSTEM_LFS = 256 LOG_SYSTEM_FLASH = 512 LOG_SYSTEM_ANTENNA_DEPLOY = 1024 LOG_SYSTEM_LOG = 2048 LOG_SYSTEM_TELECOMMAND = 4096 LOG_SYSTEM_UNIT_TEST = 8192

Here is the call graph for this function:

TCMDEXEC_log_set_system_file_logging_enabled_state()

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

Telecommand: Set a LOG subsystem's file logging enabled state.

Parameters

args_str

Arg 0: Subsystem enum value Arg 1: Enabled? 0: disable file logging, 1: enable file logging

FrontierSat LOG subsystems LOG_SYSTEM_OBC = 1 LOG_SYSTEM_UHF_RADIO = 2 LOG_SYSTEM_UMBILICAL_UART = 4 LOG_SYSTEM_GNSS = 8 LOG_SYSTEM_MPI = 16 LOG_SYSTEM_EPS = 32 LOG_SYSTEM_BOOM = 64 LOG_SYSTEM_ADCS = 128 LOG_SYSTEM_LFS = 256 LOG_SYSTEM_FLASH = 512 LOG_SYSTEM_ANTENNA_DEPLOY = 1024 LOG_SYSTEM_LOG = 2048 LOG_SYSTEM_TELECOMMAND = 4096 LOG_SYSTEM_UNIT_TEST = 8192

Here is the call graph for this function:

TCMDEXEC_log_set_system_severity_mask()

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

Telecommand: set the severity levels that a system will log.

Parameters

args_str

Arg 0: Subsystem enum Arg 1: severity mask

Allows fine-grained control over what severities a subsystem will log FrontierSat subsystems LOG_SYSTEM_OBC = 1 LOG_SYSTEM_UHF_RADIO = 2 LOG_SYSTEM_UMBILICAL_UART = 4 LOG_SYSTEM_GNSS = 8 LOG_SYSTEM_MPI = 16 LOG_SYSTEM_EPS = 32 LOG_SYSTEM_BOOM = 64 LOG_SYSTEM_ADCS = 128 LOG_SYSTEM_LFS = 256 LOG_SYSTEM_FLASH = 512 LOG_SYSTEM_ANTENNA_DEPLOY = 1024 LOG_SYSTEM_LOG = 2048 LOG_SYSTEM_TELECOMMAND = 4096 LOG_SYSTEM_UNIT_TEST = 8192

LOG severity LOG_SEVERITY_DEBUG = 1 LOG_SEVERITY_NORMAL = 2 LOG_SEVERITY_WARNING = 4 LOG_SEVERITY_ERROR = 8 LOG_SEVERITY_CRITICAL = 16

Here is the call graph for this function: