obc: add framework for modes of operation

apps/obc/src/common.c

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2025 The FINCH CubeSat Project Flight Software Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file common.c
+ * @brief Source for Definitions Common Across Modules 
+ */
+
+#include "common.h"
+#include <stdbool.h>
+#include <zephyr/logging/log.h>
+
+LOG_MODULE_REGISTER(finch_common);
+
+/**
+ * @brief Enter specified ADCS control mode
+ */
+void cmd_adcs_mode(mode_adcs mode, uint8_t* orbit_info, float current_time, uint8_t* tle)
+{
+	switch (mode) {
+		case MODE_ADCS_SAFE:
+			LOG_INF("Setting ADCS to Safe mode");
+			// Setting ADCS to Safe mode
+			break;
+
+		case MODE_ADCS_DETUMBLING:
+			LOG_INF("Setting ADCS to Detumbling mode");
+			// Set ADCS to Detumbling mode
+			break;
+
+		case MODE_ADCS_SUN_POINTING:
+			LOG_INF("Setting ADCS to Sun Pointing mode");
+			// Set ADCS to Sun Pointing mode
+			break;
+
+		case MODE_ADCS_FINE_POINTING:
+			LOG_INF("Setting ADCS to Fine Pointing mode");
+			// Set ADCS to Fine Pointing mode
+			break;
+
+		case MODE_ADCS_LVLH:
+			LOG_INF("Setting ADCS to LVLH mode");
+			// Set ADCS to LVLH mode
+			break;
+
+		case MODE_ADCS_TRACKING:
+			LOG_INF("Setting ADCS to Tracking mode");
+			// Set ADCS to Tracking mode
+			break;
+
+		case MODE_ADCS_OFF:
+			LOG_INF("Setting ADCS to Off mode");
+			// Set ADCS to Off mode
+			break;
+
+		default:
+			LOG_WRN("Unknown ADCS control mode");
+			break;
+	}
+}
+
+/**
+ * @brief Enter specified PAY control mode
+ */
+void cmd_pay_mode(mode_pay mode)
+{
+	switch (mode) {
+		case MODE_PAY_OFF:
+			LOG_INF("Setting PAY to Off mode");
+			// Set PAY to Off mode
+			break;
+
+		case MODE_PAY_ON:
+			LOG_INF("Setting PAY to On mode");
+			// Set PAY to On mode
+			break;
+
+		default:
+			LOG_WRN("Unknown PAY control mode");
+			break;
+	}
+}

apps/obc/src/common.h

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2025 The FINCH CubeSat Project Flight Software Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file common.h
+ * @brief Header for Definitions Common Across Modules 
+ */
+
+#ifndef FINCH_COMMON_H
+#define FINCH_COMMON_H
+
+/**
+ * @brief System modules
+ */
+typedef enum system_module {
+	MODULE_OPERATOR,
+	MODULE_MCC_GS,
+	MODULE_RF,
+	MODULE_OBC,
+	MODULE_ADCS,
+	MODULE_PAY
+} system_module;
+
+/**
+ * @brief Modes of operation
+ */
+typedef enum mode_op {
+	MODE_OP_IDLE,
+	MODE_OP_IMAGING,
+	MODE_OP_DOWNLINKING,
+	MODE_OP_SAFETY,
+	MODE_OP_FIRMWARE_UPDATE
+} mode_op;
+
+/**
+ * @brief ADCS control modes
+ */
+typedef enum mode_adcs {
+	MODE_ADCS_SAFE,
+	MODE_ADCS_DETUMBLING,
+	MODE_ADCS_SUN_POINTING,
+	MODE_ADCS_FINE_POINTING,
+	MODE_ADCS_LVLH,
+	MODE_ADCS_TRACKING,
+	MODE_ADCS_OFF
+} mode_adcs;
+
+/**
+ * @brief PAY control mode
+ */
+typedef enum mode_pay {
+	MODE_PAY_OFF,
+	MODE_PAY_ON
+} mode_pay;
+
+/**
+ * @brief Enter specified mode of operation
+ */
+// void enter_mode_op(mode_op mode);
+
+/**
+ * @brief Enter specified ADCS control mode
+ */
+void cmd_adcs_mode(mode_adcs mode, uint8_t* orbit_info, float current_time, uint8_t* tle);
+
+/**
+ * @brief Enter specified PAY control mode
+ */
+void cmd_pay_mode(mode_pay mode);
+
+#endif

apps/obc/src/downlinking.c

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2025 The FINCH CubeSat Project Flight Software Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file downlinking.c
+ * @brief Downlinking Command Sequence Implementation
+ */
+
+#include "common.h"
+#include "downlinking.h"
+#include <stdbool.h>
+#include <zephyr/logging/log.h>
+
+LOG_MODULE_REGISTER(downlinking);
+
+/**
+ * @brief Main loop for Downlinking command sequence
+ */
+mode_op downlinking_command_sequence(void)
+{
+	cmd_adcs_mode(MODE_ADCS_FINE_POINTING, 0, 0.0, 0); // Placeholder values for orbit_info, current_time and tle
+
+	downlink_type dl_type = downlinking_prepare_rf();
+	uint8_t* downlink_data;
+
+	if (dl_type == DOWNLINK_TELEMETRY)
+	{
+		downlink_data = downlinking_get_telemetry_data();
+	}
+
+	else if (dl_type == DOWNLINK_IMAGE)
+	{
+		downlink_data = downlinking_get_image_data();
+	}
+
+	int ret = downlinking_downlink_rf(downlink_data);
+
+	// Error handling - to be implemented
+	if (ret < 0)
+	{
+		return ret;
+	}
+
+	return MODE_OP_IDLE;
+}
+
+/**
+ * @brief Prepare RF for downlinking
+ */
+downlink_type downlinking_prepare_rf(void)
+{
+	// Implement RF downlink preparation
+	// Return type of downlinking
+	return NULL;
+}
+
+/**
+ * @brief Get telemetry data for downlinking
+ */
+uint8_t* downlinking_get_telemetry_data(void)
+{
+	// Get telemetry data
+	return NULL;
+}
+
+/**
+ * @brief Get image data for downlinking
+ */
+uint8_t* downlinking_get_image_data(void)
+{
+	// Get image data
+	return NULL;
+}
+
+/**
+ * @brief Downlink data to RF
+ */
+int downlinking_downlink_rf(const uint8_t* downlink_data)
+{
+	// Implement downlinking data to RF
+	return 0;
+}

apps/obc/src/downlinking.h

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2025 The FINCH CubeSat Project Flight Software Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file downlinking.h
+ * @brief Header for Downlinking Command Sequence Implementation
+ */
+
+#ifndef DOWNLINKING_H
+#define DOWNLINKING_H
+
+#include "common.h"
+
+/**
+ * @brief Downlink types
+ */
+typedef enum downlink_type {
+  DOWNLINK_TELEMETRY,
+	DOWNLINK_IMAGE
+} downlink_type;
+
+/**
+ * @brief Main loop for Downlinking command sequence
+ */
+mode_op downlinking_command_sequence(void);
+
+/**
+ * @brief Prepare RF for downlinking
+ */
+downlink_type downlinking_prepare_rf(void);
+
+/**
+ * @brief Get telemetry data for downlinking
+ */
+uint8_t* downlinking_get_telemetry_data(void);
+
+/**
+ * @brief Get image data for downlinking
+ */
+uint8_t* downlinking_get_image_data(void);
+
+/**
+ * @brief Downlink data to RF
+ */
+int downlinking_downlink_rf(const uint8_t* downlink_data);
+
+#endif

apps/obc/src/firmware-update.c

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2025 The FINCH CubeSat Project Flight Software Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file firmware-update.c
+ * @brief Firmware Update Command Sequence Implementation
+ */
+
+#include "common.h"
+#include "firmware-update.h"
+#include <stdbool.h>
+#include <zephyr/logging/log.h>
+
+LOG_MODULE_REGISTER(firmware_update);
+
+/**
+ * @brief Main loop for Firmware Update command sequence
+ */
+mode_op firmware_update_command_sequence(void)
+{
+	// RUN BELOW IN PARALLEL
+
+	// Parallel block 1
+	cmd_adcs_mode(MODE_ADCS_FINE_POINTING, 0, 0.0, 0); // Placeholder values for orbit_info, current_time and tle
+
+	// Parallel block 2
+	if (cmd_obc_available_update())
+	{
+		cmd_obc_update();
+		// Transmit update feedback to RF
+	}
+
+	if (cmd_pay_available_update())
+	{
+		cmd_pay_update();
+		// Transmit update feedback to RF
+	}
+
+	// END PARALLEL
+
+	return MODE_OP_IDLE;
+}
+
+/**
+ * @brief Polls for available OBC firmware upate
+ */
+int cmd_obc_available_update(void)
+{
+	// Implement check for OBC firmware update
+	return 0;
+}
+
+/**
+ * @brief Polls for available PAY firmware upate
+ */
+int cmd_pay_available_update(void)
+{
+	// Implement check for PAY firmware update
+	return 0;
+}
+
+/**
+ * @brief Executes OBC firmware update
+ */
+int cmd_obc_update(void)
+{
+	// Implement OBC firmware update
+	return 0;
+}
+
+/**
+ * @brief Executes PAY firmware update
+ */
+int cmd_pay_update(void)
+{
+	// Implement PAY firmware update
+	return 0;
+}