Mercurial > brewboard / changeset

--- a/main/recipes.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/recipes.c	Sun Oct 21 13:07:50 2018 +0200
@@ -1,6 +1,11 @@
 /**
  * @file recipes.c
- * @brief Recipes management.
+ * @brief Recipes management. If new beerxml recipes are detected in
+ *        the /recipe directory on the SD card they will be imported 
+ *        when you enter the recipes menu. After successfull import the
+ *        xml file extensions will be changed to xok to prevent that
+ *        the recipe is imported again. After the import the recipe
+ *	  editor is shown.
  */
 
 #include "config.h"

--- a/main/recipes.h	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/recipes.h	Sun Oct 21 13:07:50 2018 +0200
@@ -1,6 +1,11 @@
 /**
  * @file recipes.h
- * @brief Recipes management.
+ * @brief Recipes management. If new beerxml recipes are detected in
+ *        the /recipe directory on the SD card they will be imported 
+ *        when you enter the recipes menu. After successfull import the
+ *        xml file extensions will be changed to xok to prevent that
+ *        the recipe is imported again. After the import the recipe
+ *        editor is shown.
  */
 
 #ifndef	_RECIPES_H

--- a/main/task_ds18b20.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_ds18b20.c	Sun Oct 21 13:07:50 2018 +0200
@@ -1,7 +1,9 @@
 /**
  * @file task_ds18b20.c
- * @brief Task that reads the DS18B20 sensors on two one-wire busses.
- *        The task can also be compiled with simulated sensors.
+ * @brief The FreeRTOS task to query the DS18B20 sensors on one or two
+ *        one-wire busses. Each bus must have only one sensor. That way
+ *        we don't need to care about the DS18B20 internal ROM address.
+ *        The task will update the DS18B20_State structure.
  */
 
 

--- a/main/task_sdcard.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_sdcard.c	Sun Oct 21 13:07:50 2018 +0200
@@ -2,11 +2,13 @@
  * @file task_sdcard.c
  * @brief SD/MMC driver. This driver is for a slot for the user on
  *        the front panel. It will detect an inserted card and then
- *        mount it. But, it cannot detect the removal of a card!!
+ *        mount it. It also detects the removal of the card and then
+ *        unmounts it. Be carefull, only do this in the main menu.
  *        Also, brew logging is handled here and finished brewlogs
  *        are copied to the SD card if it is mounted.
  *        Recipes to import must go into the /sdcard/recipe folder
  *        and have extension .xml and the contents be a beerxml file.
+ *        Backup and restore is also done to this card.
  */
 
 

--- a/main/task_sdcard.h	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_sdcard.h	Sun Oct 21 13:07:50 2018 +0200
@@ -3,7 +3,15 @@
 
 /**
  * @file task_sdcard.h
- * @brief The interface to the FreeRTOS SD/MMC card task.
+ * @brief SD/MMC driver. This driver is for a slot for the user on
+ *        the front panel. It will detect an inserted card and then
+ *        mount it. It also detects the removal of the card and then
+ *        unmounts it. Be carefull, only do this in the main menu.
+ *        Also, brew logging is handled here and finished brewlogs
+ *        are copied to the SD card if it is mounted.
+ *        Recipes to import must go into the /sdcard/recipe folder
+ *        and have extension .xml and the contents be a beerxml file.
+ *        Backup and restore is also done to this card.
  */
 
 

--- a/main/task_sound.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_sound.c	Sun Oct 21 13:07:50 2018 +0200
@@ -1,7 +1,6 @@
 /**
  * @file task_sound.c
- * @brief BrewBoard Sound driver. Plays WAVE audio, Microsoft PCM, 8 bit, mono 16000 Hz
- *        files from the /spiffs/sound/ directory.
+ * @brief BrewBoard Sound driver. Uses a simple piezo buzzer.
  */
 
 #include "config.h"

--- a/main/task_sound.h	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_sound.h	Sun Oct 21 13:07:50 2018 +0200
@@ -3,7 +3,7 @@
 
 /**
  * @file task_sound.h
- * @brief Sound player using the ESP32 internal DAC port.
+ * @brief BrewBoard Sound driver. Uses a simple piezo buzzer.
  */
 
 /**

--- a/main/task_tft.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_tft.c	Sun Oct 21 13:07:50 2018 +0200
@@ -1,11 +1,10 @@
 /**
  * @file task_tft.c
- * @brief BrewBoard TFT and Touch screen driver. 
- *        But because the application is controlled using the touch screen,
- *        all the processing of menus is also found here.
- *        It's the first started task, but it does nothing until the
- *        Main_Screen variable is set.
- *
+ * @brief BrewBoard TFT and Touch screen driver for a 320x240 ILI9341 based display.
+ *        But because the application is controlled using the touch screen, all the
+ *        processing of menus is also found here.
+ *        It's the first started task, but it does nothing until the Main_Screen 
+ *        variable is set.
  */
 
 #include "config.h"

--- a/main/task_tft.h	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/task_tft.h	Sun Oct 21 13:07:50 2018 +0200
@@ -3,7 +3,11 @@
 
 /**
  * @file task_tft.h
- * @brief The interface to the TFT with touch module.
+ * @brief BrewBoard TFT and Touch screen driver for a 320x240 ILI9341 based display.
+ *        But because the application is controlled using the touch screen, all the
+ *        processing of menus is also found here.
+ *        It's the first started task, but it does nothing until the Main_Screen 
+ *        variable is set.
  */
 
 /**

--- a/main/updates.c	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/updates.c	Sun Oct 21 13:07:50 2018 +0200
@@ -1,6 +1,7 @@
 /**
  * @file updates.c
- * @brief Updates management.
+ * @brief Updates management. It can download and install new firmware
+ *        downloaded from the internet.
  */
 
 #include "config.h"

--- a/main/updates.h	Sat Oct 20 23:26:33 2018 +0200
+++ b/main/updates.h	Sun Oct 21 13:07:50 2018 +0200
@@ -1,18 +1,20 @@
 /**
  * @file updates.h
- * @brief Updates management.
+ * @brief Updates management. It can download and install new firmware
+ *        downloaded from the internet.
  */
+
 #ifndef _UPDATES_H
 #define _UPDATES_H
 
 /**
- *  * @brief Updates init fases.
- *   */
+ * @brief Updates init fases.
+ */
 void Updates_Init(void);
 
 /**
- *  * @brief Updates loop screens. Non-blocking.
- *   */
+ * @brief Updates loop screens. Blocking.
+ */
 void Updates_Loop(void);
 
 #endif