CTS-SAT-1-OBC-Firmware
Loading...
Searching...
No Matches
eps_telecommands.c File Reference
Include dependency graph for eps_telecommands.c:

Functions

uint8_t TCMDEXEC_eps_watchdog (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Triggers/services the EPS watchdog. No args.
 
uint8_t TCMDEXEC_eps_system_reset (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Resets the EPS system.
 
uint8_t TCMDEXEC_eps_no_operation (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Calls the EPS no-op (no operation) command. Likely not useful.
 
uint8_t TCMDEXEC_eps_cancel_operation (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Calls the EPS cancel operation command. Likely not useful.
 
uint8_t TCMDEXEC_eps_switch_to_mode (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Switches the EPS to "nominal" or "safety" mode.
 
uint8_t TCMDEXEC_eps_set_channel_enabled (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Sets the EPS channel to be enabled (on) or disabled (off).
 
uint8_t TCMDEXEC_eps_get_system_status_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS system status, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pdu_overcurrent_fault_state_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PDU (Power Distribution Unit) overcurrent fault status, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pbu_abf_placed_state_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PBU (Power Battery Unit) ABF placed status, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pdu_housekeeping_data_eng_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PDU (Power Distribution Unit) housekeeping data, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pdu_data_for_channel_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Gets the Voltage, Current, and Power for a single channel on the EPS.
 
uint8_t TCMDEXEC_eps_get_pdu_housekeeping_data_run_avg_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PDU (Power Distribution Unit) housekeeping data (running average), and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pbu_housekeeping_data_eng_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PBU (Power Battery Unit) housekeeping data, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pbu_housekeeping_data_run_avg_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PBU (Power Battery Unit) housekeeping data (running average), and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pcu_housekeeping_data_eng_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PCU (Power Conditioning Unit, solar panel MPPT) housekeeping data, and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_pcu_housekeeping_data_run_avg_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PCU (Power Conditioning Unit, solar panel MPPT) housekeeping data (running average), and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_piu_housekeeping_data_eng_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Gets the EPS PIU (Power Integrated Unit, info about all systems) housekeeping data, and returns it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_piu_housekeeping_data_run_avg_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get the EPS PIU (Power Integrated Unit, info about all systems) housekeeping data (running average), and display it as a JSON string.
 
uint8_t TCMDEXEC_eps_get_current_battery_percent (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Get current battery voltage percent from PBU.
 
uint8_t TCMDEXEC_eps_get_enabled_channels_json (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 
uint8_t TCMDEXEC_eps_power_management_set_current_threshold (const char *args_str, char *response_output_buf, uint16_t response_output_buf_len)
 Sets the EPS power managements max sustained current for the specified channel.
 

Function Documentation

◆ TCMDEXEC_eps_cancel_operation()

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

Calls the EPS cancel operation command. Likely not useful.

Parameters
args_strNo arguments.
Returns
0 on success, 1 on failure.
Note
This command likely isn't useful, as telecommands cannot be trigger simultaneously, and thus another command to the EPS cannot really be cancelled from here.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_current_battery_percent()

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

Get current battery voltage percent from PBU.

Here is the call graph for this function:

◆ TCMDEXEC_eps_get_enabled_channels_json()

uint8_t TCMDEXEC_eps_get_enabled_channels_json ( const char * args_str,
char * response_output_buf,
uint16_t response_output_buf_len )
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pbu_abf_placed_state_json()

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

Get the EPS PBU (Power Battery Unit) ABF placed status, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pbu_housekeeping_data_eng_json()

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

Get the EPS PBU (Power Battery Unit) housekeeping data, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pbu_housekeeping_data_run_avg_json()

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

Get the EPS PBU (Power Battery Unit) housekeeping data (running average), and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pcu_housekeeping_data_eng_json()

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

Get the EPS PCU (Power Conditioning Unit, solar panel MPPT) housekeeping data, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pcu_housekeeping_data_run_avg_json()

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

Get the EPS PCU (Power Conditioning Unit, solar panel MPPT) housekeeping data (running average), and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pdu_data_for_channel_json()

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

Gets the Voltage, Current, and Power for a single channel on the EPS.

Parameters
args_str
  • Arg 0: The channel name or number (case-insensitive string).
Returns
0 on success, >0 on failure.
Note
Channel name argument: A lowercase c-string of the channel name (e.g., "mpi"), or a number representing the channel number (e.g., "1" or "16"). Valid string values: "vbatt_stack", "stack_5v", "stack_3v3", "camera", "uhf_antenna_deploy", "gnss", "mpi_5v", "mpi_12v", "boom".
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pdu_housekeeping_data_eng_json()

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

Get the EPS PDU (Power Distribution Unit) housekeeping data, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pdu_housekeeping_data_run_avg_json()

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

Get the EPS PDU (Power Distribution Unit) housekeeping data (running average), and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_pdu_overcurrent_fault_state_json()

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

Get the EPS PDU (Power Distribution Unit) overcurrent fault status, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_piu_housekeeping_data_eng_json()

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

Gets the EPS PIU (Power Integrated Unit, info about all systems) housekeeping data, and returns it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_piu_housekeeping_data_run_avg_json()

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

Get the EPS PIU (Power Integrated Unit, info about all systems) housekeeping data (running average), and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_get_system_status_json()

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

Get the EPS system status, and display it as a JSON string.

Returns
0 on success, >0 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_no_operation()

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

Calls the EPS no-op (no operation) command. Likely not useful.

Parameters
args_strNo arguments.
Returns
0 on success, 1 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_power_management_set_current_threshold()

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

Sets the EPS power managements max sustained current for the specified channel.

Parameters
args_str
  • Arg 0: The channel name or number (case-insensitive string).
  • Arg 1: Threshold current (in mA) to set.
Returns
0 on success, >0 on failure
Note
Valid string values (Arg 0): "vbatt_stack", "stack_5v", "stack_3v3", "camera", "uhf_antenna_deploy", "gnss", "mpi_5v", "mpi_12v", "boom".
Here is the call graph for this function:

◆ TCMDEXEC_eps_set_channel_enabled()

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

Sets the EPS channel to be enabled (on) or disabled (off).

Parameters
args_str
  • Arg 0: The channel name or number (case-insensitive string).
  • Arg 1: 1 to enable (power on), 0 to disable (power off)
Returns
0 on success, >0 on failure
Note
Channel name argument: A lowercase c-string of the channel name (e.g., "mpi"), or a number representing the channel number (e.g., "1" or "16"). Valid string values: "vbatt_stack", "stack_5v", "stack_3v3", "camera", "uhf_antenna_deploy", "gnss", "mpi_5v", "mpi_12v", "boom".
Here is the call graph for this function:

◆ TCMDEXEC_eps_switch_to_mode()

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

Switches the EPS to "nominal" or "safety" mode.

Parameters
args_str
  • Arg 0: New mode to switch to. Either "nominal" or "safety". Case-insensitive.
Returns
0 on success, 1 on failure.
Note
See EPS Software ICD, Page 12, Section 3 (Functional Description) for state/mode definitions.
Here is the call graph for this function:

◆ TCMDEXEC_eps_system_reset()

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

Resets the EPS system.

Parameters
args_strNo arguments.
Returns
0 on success, 1 on failure.
Here is the call graph for this function:

◆ TCMDEXEC_eps_watchdog()

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

Triggers/services the EPS watchdog. No args.

Parameters
args_strNo arguments.
Returns
0 on success, 1 on failure.
Here is the call graph for this function: