agenda_telecommands_defs.h File Reference

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

Include dependency graph for agenda_telecommands_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_agenda_delete_all (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Delete all agendas.
uint8_t	TCMDEXEC_agenda_delete_by_tssent (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Delete agenda entry by tssent timestamp.
uint8_t	TCMDEXEC_agenda_fetch_jsonl (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Fetch all pending agenda items, and log them each as JSONL.
uint8_t	TCMDEXEC_agenda_delete_by_name (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Delete all agenda entries with a telecommand name.

Function Documentation

TCMDEXEC_agenda_delete_all()

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

Telecommand: Delete all agendas.

Parameters

args_str	No arguments needed
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 on success

Here is the call graph for this function:

TCMDEXEC_agenda_delete_by_name()

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

Telecommand: Delete all agenda entries with a telecommand name.

Parameters

args_str	Arg 0: telecommand name (string) - The name of the telecommand function in the agenda to delete. (e.g, hello_world)
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 on success, > 0 on error

Here is the call graph for this function:

TCMDEXEC_agenda_delete_by_tssent()

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

Telecommand: Delete agenda entry by tssent timestamp.

Parameters

args_str	Arg 0: Timestamp sent (uint64_t) - The tssent timestamp of the agenda entry to delete.
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 on success, >0 on error

Here is the call graph for this function:

TCMDEXEC_agenda_fetch_jsonl()

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

Telecommand: Fetch all pending agenda items, and log them each as JSONL.

Parameters

args_str	No arguments needed
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 on success, 1 if there are no active agendas.

Here is the call graph for this function: