mpi_telecommand_defs.h File Reference

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

Include dependency graph for mpi_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_mpi_send_command_get_response_hex (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Send a configuration command & params (IF ANY) to the MPI encoded in hex.
uint8_t	TCMDEXEC_mpi_demo_tx_to_mpi (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Sends a message over UART to the MPI.
uint8_t	TCMDEXEC_mpi_set_transceiver_mode (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Manually sets the MPI's UART transceiver state.
uint8_t	TCMDEXEC_mpi_enable_active_mode (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Enables systems to start receiving data actively from MPI and storing using LFS.
uint8_t	TCMDEXEC_mpi_disable_active_mode (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
	Sets the state to not send or receive data from MPI.

Function Documentation

TCMDEXEC_mpi_demo_tx_to_mpi()

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

Sends a message over UART to the MPI.

Parameters

args_str	No args.
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: Success, >0: Failure

Here is the call graph for this function:

TCMDEXEC_mpi_disable_active_mode()

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

Sets the state to not send or receive data from MPI.

Parameters

args_str	No args.
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: Success, >0: Failure

Here is the call graph for this function:

TCMDEXEC_mpi_enable_active_mode()

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

Enables systems to start receiving data actively from MPI and storing using LFS.

Parameters

args_str	Arg 0: File name as a string
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: Success, >0: Failure

Here is the call graph for this function:

TCMDEXEC_mpi_send_command_get_response_hex()

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

Send a configuration command & params (IF ANY) to the MPI encoded in hex.

Parameters

args_str	Arg 0: Hex-encoded string representing the configuration command + arguments (IF ANY) to send to the MPI, INCLUDING 'TC' (0x54 0x43)
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: Success, >0 error code

Here is the call graph for this function:

TCMDEXEC_mpi_set_transceiver_mode()

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

Manually sets the MPI's UART transceiver state.

Parameters

args_str	Arg 0: The target mode - "MISO" (from MPI), "MOSI" (to MPI), "DUPLEX", or anything else disables it
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: Success, >0: Failure

Note

Nominally, not required. Useful for manually sending UART messages with uart_send_hex() tcmd.

Here is the call graph for this function: