Restructuring and comments

stm-firmware/include/reflow-controller/temp-profile/temp-profile-executer.h

@@ -0,0 +1,94 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @addtogroup temp-profile
+ * @{
+ */
+
+#ifndef __TEMP_PROFILE_EXECUTER_H__
+#define __TEMP_PROFILE_EXECUTER_H__
+
+#include <stdint.h>
+#include <reflow-controller/temp-profile/temp-profile-parser.h>
+
+/**
+ * @brief Maximum command count of a temperature profile the parser will handle
+ */
+#define MAX_PROFILE_LENGTH 64
+
+/**
+ * @brief Status of the temperature profile execution
+ */
+enum tpe_status {
+	TPE_OFF, /**< @brief No profile execution */
+	TPE_RUNNING, /**< @brief Profile currently running */
+	TPE_ABORT, /**< @brief Profile execution aborted due to event / error */
+};
+
+/**
+ * @brief The current execution state of the temperature profile
+ */
+struct tpe_current_state {
+	enum tpe_status status; /**< @brief Execution status */
+	float setpoint; /**< @brief Temperature setpoint in degrees Celsius */
+	uint64_t start_timestamp; /**< @brief The millisicend tick timestamp, the profile execution was started */
+	uint32_t step; /**< @brief Current execution step. Starts at 0 */
+	uint32_t profile_steps; /**< @brief Number of steps (commands) in profile */
+	enum pl_command_type current_command; /**< @brief The currently executed command */
+};
+
+/**
+ * @brief Start a temperature profile execution from a file on SD card.
+ * @param filename Filename of the temperature profile
+ * @return Status. PL_RET_SUCCESS id profile was parsed and started successfully
+ */
+enum pl_ret_val temp_profile_executer_start(const char *filename);
+
+/**
+ * @brief Handle the profile execution
+ *
+ * The function checks if since the last time it ran, 100 ms have passed. If yes,
+ * it proceeds with the command execution.
+ *
+ * @note This must be periodically called.
+ * @return  0 if successul, negative if profile not running or aborted or temperature set and PID not configured.
+ */
+int temp_profile_executer_handle(void);
+
+/**
+ * @brief Get the curretn execution state of the temperature profile executer
+ * @warning The returned state structure is static and used internally. You must not modify it.
+ * @return Execution state
+ */
+const struct tpe_current_state *temp_profile_executer_status(void);
+
+/**
+ * @brief Stop the temperature profile execution.
+ *
+ * The profile execution is stopped and the beeper is deactivated.
+ *
+ * @return always 0. This function cannot fail.
+ */
+int temp_profile_executer_stop(void);
+
+#endif /* __TEMP_PROFILE_EXECUTER_H__ */
+
+/** @} */

stm-firmware/include/reflow-controller/temp-profile/temp-profile-parser.h

@@ -0,0 +1,83 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__
+#define __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__
+
+#include <stdint.h>
+#include <linklist-lib/singly-linked-list.h>
+
+enum pl_command_type {
+	PL_PID_CONF = 0,
+	PL_SET_TEMP,
+	PL_SET_RAMP,
+	PL_WAIT_FOR_TEMP,
+	PL_WAIT_FOR_TIME,
+	PL_LOUDSPEAKER_SET,
+	PL_OFF,
+	PL_CLEAR_FLAGS,
+	_PL_NUM_CMDS,
+};
+
+enum pl_ret_val {
+	PL_RET_SUCCESS = 0,
+	PL_RET_DISK_ERR,
+	PL_RET_PARAM_ERR,
+	PL_RET_LIST_FULL,
+	PL_RET_SCRIPT_ERR,
+};
+
+#define PROFILE_LANG_MAX_NUM_ARGS (8)
+
+struct pl_command {
+	enum pl_command_type cmd;
+	float params[PROFILE_LANG_MAX_NUM_ARGS];
+};
+
+/**
+ * @brief Parse a temperature profile from file and generate the command list
+ *
+ * Commands are parsed into the list given by \p command_list. If \p max_len is reached,
+ * the function returns with @ref PL_RET_LIST_FULL
+ *
+ * In any case, the command list not cleared afterwards. The user has to clear the command list manually
+ * using @ref temp_profile_free_command_list.
+ *
+ * @param filename File to parse
+ * @param[in, out] command_list Command list to output @ref pl_command elements in.
+ * @param max_len maximum number of commands.
+ * @param cmds_parsed Number of parsed commands
+ * @return
+ */
+enum pl_ret_val temp_profile_parse_from_file(const char *filename,
+					     SlList **command_list,
+					     uint32_t max_len,
+					     uint32_t *cmds_parsed);
+
+/**
+ * @brief Fully free a comamnd list including hte sotred command structures.
+ *
+ * \p list's destination is set to NULL to indicate the empty list.
+ *
+ * @param[in, out] list Pointer to list.
+ */
+void temp_profile_free_command_list(SlList **list);
+
+#endif /* __CONFIG_PARSER_TEMP_PROFILE_PARSER_H__ */