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_fetch_json_grouped (const char *args_str, char *response_output_buf, uint16_t response_output_buf_size)
	Fetches the active agendas and writes a minified JSON dict-of-lists to the response buffer.
uint8_t	TCMDEXEC_agenda_fetch_logged_jsonl (const char *args_str, char *response_output_buf, uint16_t response_output_buf_size)
	Telecommand: Fetch all pending agenda items, and log them each as JSONL.
uint8_t	TCMDEXEC_agenda_delete_all (const char *args_str, char *response_output_buf, uint16_t response_output_buf_size)
	Telecommand: Delete all agenda entries.
uint8_t	TCMDEXEC_agenda_delete_by_tssent (const char *args_str, char *response_output_buf, uint16_t response_output_buf_size)
	Telecommand: Delete agenda entry by tssent timestamp.
uint8_t	TCMDEXEC_agenda_delete_by_name (const char *args_str, char *response_output_buf, uint16_t response_output_buf_size)
	Telecommand: Delete all agenda entries with a given telecommand name.
uint8_t	TCMDEXEC_agenda_enqueue_from_file (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Enqueue telecommands from a file.

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 agenda entries.

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

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 given 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_enqueue_from_file()

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

Telecommand: Enqueue telecommands from a file.

Parameters

args_str

Arg 0: File name (string) - The name of the file to enqueue telecommands from. Arg 1: min_tsexec_inclusive (u64) - Filter to @tsexec >= value (nominal: 0) Arg 2: max_tsexec_exclusive (u64) - Filter to @tsexec < value (set to 0 for no filter)

Returns

0 on success, > 0 on error

Here is the call graph for this function:

TCMDEXEC_agenda_fetch_json_grouped()

uint8_t TCMDEXEC_agenda_fetch_json_grouped	(	const char *	args_str,
		char *	response_output_buf,
		uint16_t	response_output_buf_size )

Fetches the active agendas and writes a minified JSON dict-of-lists to the response buffer.

Parameters

args_str	No arguments.
response_output_buf	Buffer to write the JSON output to.
response_output_buf_size	Size of the response buffer.

Returns

0 on success, 1 if there are no pending entries, 2 if the buffer was too small (agenda too long).

Here is the call graph for this function:

TCMDEXEC_agenda_fetch_logged_jsonl()

uint8_t TCMDEXEC_agenda_fetch_logged_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.

Returns

0 on success, 1 if there are no active pending agenda items.

Here is the call graph for this function: