comms_telecommand_defs.h File Reference

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

Include dependency graph for comms_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_comms_set_rf_switch_control_mode (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Sets the state of the dipole switch on the OBC to either Antenna 1 or Antenna 2.
uint8_t	TCMDEXEC_comms_get_rf_switch_info (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Gets the current RF switch control mode and the current antenna state.
uint8_t	TCMDEXEC_comms_bulk_file_downlink_start (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Initiate a bulk file downlink over the UHF radio.
uint8_t	TCMDEXEC_comms_bulk_file_downlink_pause (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Pause bulk file downlink.
uint8_t	TCMDEXEC_comms_bulk_file_downlink_resume (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
uint8_t	TCMDEXEC_comms_bulk_uplink_open_file (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Open a file for bulk uplink.
uint8_t	TCMDEXEC_comms_bulk_uplink_seek (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Seek to a new position in the currently open bulk uplink file.
uint8_t	TCMDEXEC_comms_bulk_uplink_write_bytes_hex (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Write hex bytes to the currently open bulk uplink file.
uint8_t	TCMDEXEC_bulkup16 (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Write hex bytes to the currently open bulk uplink file.
uint8_t	TCMDEXEC_comms_bulk_uplink_write_bytes_base64 (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Write Base64 bytes to the currently open bulk uplink file.
uint8_t	TCMDEXEC_bulkup64 (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Write Base64 bytes to the currently open bulk uplink file.
uint8_t	TCMDEXEC_comms_bulk_uplink_close_file (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Telecommand: Close the currently open bulk uplink file.

Function Documentation

TCMDEXEC_bulkup16()

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

Telecommand: Write hex bytes to the currently open bulk uplink file.

Parameters

args_str

Arg 0: Hex string (e.g. "DEADBEEF" or "DE AD BE EF")

Note

This is an alias for the comms_bulk_uplink_write_bytes_hex telecommand. This is one of very few telecommands with short aliases, as it allows more data per command.

Here is the call graph for this function:

TCMDEXEC_bulkup64()

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

Telecommand: Write Base64 bytes to the currently open bulk uplink file.

Parameters

args_str

Arg 0: Base64 string (e.g. "SGVsbG8=" converts to ASCII "Hello")

Note

This is an alias for the comms_bulk_uplink_write_bytes_base64 telecommand. This is one of very few telecommands with short aliases, as it allows more data per command.

Here is the call graph for this function:

TCMDEXEC_comms_bulk_file_downlink_pause()

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

Telecommand: Pause bulk file downlink.

Parameters

args_str

(unused)

Here is the call graph for this function:

TCMDEXEC_comms_bulk_file_downlink_resume()

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

Here is the call graph for this function:

TCMDEXEC_comms_bulk_file_downlink_start()

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

Initiate a bulk file downlink over the UHF radio.

Parameters

args_str

Arg 0: File path to downlink as string Arg 1: Start offset in file (uint32) Arg 2: The maximum number of bytes to downlink. Maximum value is 1000000 (1 MB, COMMS_bulk_file_downlink_total_bytes), for safety (to avoid a very very long-running downlink chain). Values >1 MB will be limited to 1 MB, and value 0 will be set to 1 MB.

Returns

0 on success. Non-zero on failure. -2 = File does not exist.

Note

1 MB takes about 15 minutes to downlink at 9600 baud.

This function is safe to call at any point (including mid-downlink, or mid-pause). It will close the previous file and start a new downlink.

Here is the call graph for this function:

TCMDEXEC_comms_bulk_uplink_close_file()

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

Telecommand: Close the currently open bulk uplink file.

Parameters

args_str

No arguments

Here is the call graph for this function:

TCMDEXEC_comms_bulk_uplink_open_file()

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

Telecommand: Open a file for bulk uplink.

Parameters

args_str

Arg 0: File path as string Arg 1: Mode enum as string: "truncate" or "append" (case-insensitive)

Here is the call graph for this function:

TCMDEXEC_comms_bulk_uplink_seek()

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

Telecommand: Seek to a new position in the currently open bulk uplink file.

Parameters

args_str

Arg 0: New byte offset from start of file (uint64, must fit uint32)

Here is the call graph for this function:

TCMDEXEC_comms_bulk_uplink_write_bytes_base64()

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

Telecommand: Write Base64 bytes to the currently open bulk uplink file.

Parameters

args_str

Arg 0: Base64 string (e.g. "SGVsbG8=" converts to ASCII "Hello")

Note

This telecommand has a short-form alias "bulkup64".

Here is the call graph for this function:

Here is the caller graph for this function:

TCMDEXEC_comms_bulk_uplink_write_bytes_hex()

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

Telecommand: Write hex bytes to the currently open bulk uplink file.

Parameters

args_str

Arg 0: Hex string (e.g. "DEADBEEF" or "DE AD BE EF")

Note

This telecommand has a short-form alias "bulkup16".

Here is the call graph for this function:

Here is the caller graph for this function:

TCMDEXEC_comms_get_rf_switch_info()

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

Gets the current RF switch control mode and the current antenna state.

Parameters

args_str

No args.

Returns

Here is the call graph for this function:

TCMDEXEC_comms_set_rf_switch_control_mode()

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

Sets the state of the dipole switch on the OBC to either Antenna 1 or Antenna 2.

Parameters

args_str

Arg 0: Enum: "toggle_before_beacon" (default), "ant1", "ant2", "adcs", "adcs_flipped". Case-insensitive.

Returns

0 on success, 1 on error.

Here is the call graph for this function: