Use the RTD theme for sphinx

.gitmodules

@@ -5,7 +5,4 @@
 	path = c-style-checker
 	url = https://git.shimatta.de/mhu/c-style-checker.git
 	branch = master
-[submodule "reflow-controller-temp-profile-lang"]
+
-	path = reflow-controller-temp-profile-lang
-	url = https://git.shimatta.de/mhu/reflow-controller-temp-profile-lang.git
-	branch = master

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/build/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/source/conf.py

@@ -0,0 +1,53 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Shimatta Reflow Controller'
+copyright = '2020, Mario Hüttel'
+author = 'Mario Hüttel'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+	'sphinx_rtd_theme'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

doc/source/index.rst

@@ -0,0 +1,20 @@
+.. Shimatta Reflow Controller documentation master file, created by
+   sphinx-quickstart on Thu Jul 30 22:56:09 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Shimatta Reflow Controller's documentation!
+======================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

stm-firmware/Makefile

@@ -46,10 +46,11 @@ CFILES += ui/lcd.c ui/menu.c reflow-menu.c
 CFILES += fatfs/diskio.c fatfs/ff.c fatfs/ffsystem.c fatfs/ffunicode.c fatfs/shimatta_sdio_driver/shimatta_sdio.c
 CFILES += pid-controller.c oven-driver.c
 CFILES += settings/settings.c settings/settings-sd-card.c
-CFILES += safety-adc.c
+
+CFILES += safety/safety-adc.c
 
 DEBUG_DEFINES = -DDEBUGBUILD
-RELEASE_DEFINES = 
+RELEASE_DEFINES =
 
 ###################################################################################
 ifeq ($(CROSS_COMPILE),)

stm-firmware/include/reflow-controller/ui/lcd.h

@@ -39,6 +39,8 @@
 #define LCD_SHIMATTA_STRING "\xBC\xCF\xAF\xC0"
 #define LCD_DEGREE_SYMBOL_STRING "\xDF"
 #define LCD_DEGREE_SYMBOL_CHAR '\xDF'
+#define LCD_OHM_SYMBOL_CHAR '\xF4'
+#define LCD_OHM_SYMBOL_STRING "\xF4"
 
 enum lcd_fsm_ret {LCD_FSM_NOP, LCD_FSM_CALL_AGAIN, LCD_FSM_WAIT_CALL};
 

stm-firmware/main.c

@@ -41,7 +41,7 @@
 #include <stm-periph/uart.h>
 #include <reflow-controller/shell-uart-config.h>
 #include <reflow-controller/oven-driver.h>
-#include <reflow-controller/safety-adc.h>
+#include <reflow-controller/safety/safety-adc.h>
 #include <fatfs/ff.h>
 #include <reflow-controller/reflow-menu.h>
 
@@ -74,6 +74,9 @@ static inline void uart_gpio_config(void)
 	SHELL_UART_PORT->MODER |= ALTFUNC(SHELL_UART_RX_PIN) | ALTFUNC(SHELL_UART_TX_PIN);
 	SETAF(SHELL_UART_PORT, SHELL_UART_RX_PIN, SHELL_UART_RX_PIN_ALTFUNC);
 	SETAF(SHELL_UART_PORT, SHELL_UART_TX_PIN, SHELL_UART_TX_PIN_ALTFUNC);
+
+	/* Setup Pullup resistor at UART RX */
+	SHELL_UART_PORT->PUPDR |= PULLUP(SHELL_UART_RX_PIN);
 #endif
 }
 
@@ -256,6 +259,8 @@ int main(void)
 
 		if (menu_wait_request)
 			__WFI();
+		else
+			__NOP();
 
 	}
 

stm-firmware/reflow-menu.c

@@ -24,7 +24,7 @@
 #include <reflow-controller/rotary-encoder.h>
 #include <reflow-controller/systick.h>
 #include <reflow-controller/adc-meas.h>
-#include <reflow-controller/safety-adc.h>
+#include <reflow-controller/safety/safety-adc.h>
 #include <reflow-controller/temp-converter.h>
 #include <helper-macros/helper-macros.h>
 #include <stm-periph/unique-id.h>
@@ -71,7 +71,7 @@ static void reflow_menu_monitor(struct lcd_menu *menu, enum menu_entry_func_entr
 	if (systick_ticks_have_passed(my_timestamp, 250)) {
 		my_timestamp = systick_get_global_tick();
 		adc_pt1000_get_current_resistance(&tmp);
-		snprintf(line, sizeof(line), "Res: %.1f", tmp);
+		snprintf(line, sizeof(line), "Res: %.1f " LCD_OHM_SYMBOL_STRING, tmp);
 		menu->update_display(0, line);
 
 		res = temp_converter_convert_resistance_to_temp(tmp, &tmp);
@@ -206,6 +206,7 @@ static void reflow_menu_root_entry(struct lcd_menu *menu, enum menu_entry_func_e
 	(void)parent;
 	static struct menu_list list;
 	static bool button_valid;
+	static bool menu_changed = true;
 	static const char * const root_entry_names[] = {
 		"About",
 		"Monitoring",
@@ -219,6 +220,7 @@ static void reflow_menu_root_entry(struct lcd_menu *menu, enum menu_entry_func_e
 	int16_t rot_delta;
 
 	if (entry_type != MENU_ENTRY_CONTINUE) {
+		menu_changed = true;
 		menu_display_clear(menu);
 		update_display_buffer(0, "Main Menu");
 		menu_ack_rotary_delta(menu);
@@ -245,12 +247,15 @@ static void reflow_menu_root_entry(struct lcd_menu *menu, enum menu_entry_func_e
 	if (rot_delta >= 4) {
 		menu_list_scroll_down(&list);
 		menu_ack_rotary_delta(menu);
+		menu_changed = true;
 	} else if (rot_delta <= -4) {
 		menu_list_scroll_up(&list);
 		menu_ack_rotary_delta(menu);
+		menu_changed = true;
 	}
 
-	menu_list_display(&list, 1, 3);
+	if (menu_changed)
+		menu_list_display(&list, 1, 3);
 }
 
 int reflow_menu_handle()

stm-firmware/safety/safety-adc.c

@@ -18,7 +18,7 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include <reflow-controller/safety-adc.h>
+#include <reflow-controller/safety/safety-adc.h>
 #include <reflow-controller/periph-config/safety-adc-hwcfg.h>
 #include <helper-macros/helper-macros.h>
 #include <stm-periph/clock-enable-manager.h>

stm-firmware/shell.c

@@ -35,7 +35,7 @@
 #include <fatfs/ff.h>
 #include <reflow-controller/stack-check.h>
 #include <reflow-controller/rotary-encoder.h>
-#include <reflow-controller/safety-adc.h>
+#include <reflow-controller/safety/safety-adc.h>
 
 #ifndef GIT_VER
 #define GIT_VER "VERSION NOT SET"