Mercurial > brewboard / file diff

--- a/main/config.h	Sat Oct 20 13:23:15 2018 +0200
+++ b/main/config.h	Sat Oct 20 17:09:48 2018 +0200
@@ -80,7 +80,7 @@
 #include "task_http.h"
 
 
-#define	VERSION		"0.2.2"
+#define	VERSION		"0.2.3"		///< Application version
 
 
 /**
@@ -133,6 +133,9 @@
     MAIN_MANUAL_MAIN,			///< Manual control main menu
 } MAIN_MODE;
 
+/**
+ * @brief The differents stages in the mash steps.
+ */
 typedef enum {
     MASH_NONE = 0,			///< Initial Mash state
     MASH_WAITTEMP,			///< Wait to reach temperature.
@@ -142,6 +145,9 @@
     MASH_REMOVE,			///< Wait mash remove
 } MASH_TYPE;
 
+/**
+ * @brief The working mode of the second heater SSR.
+ */
 typedef enum {
     SSR2_OFF = 0,			///< SSR2 not used.
     SSR2_HLT_SHARE,			///< SSR2 for HLT shared with MLT
@@ -177,7 +183,7 @@
     int			RecipeRec;			///< Current recipe record.
     char		uuid[37];			///< Sort of uuid code.
     char		lastSSID[32];			///< Last connected station.
-} config;
+} config;						///< Config record.
 
 /**
  * @brief Write configuration to disk.
@@ -215,7 +221,7 @@
     double	PID_kD;				///< PID D setting.
     bool	PID_POn;			///< PID compute on Measurement or Errors.
     int		SampleTime;			///< PID sample time in seconds.
-} equipment;
+} equipment;					///< Equipment record.
 
 /**
  * @brief Append equipments record to disk.
@@ -251,7 +257,7 @@
     char	SSID[32];			///< Station SSID
     char	Password[64];			///< Station password
     bool	hide;				///< Hide from AP scan.
-} wifiStation;
+} wifiStation;					///< Station record.
 
 /**
  * @brief Add a new station record.
@@ -274,6 +280,11 @@
  */
 void remove_station(uint8_t *SSID);
 
+/**
+ * @brief Blacklist station SSID
+ * @param SSID The SSID to blacklist.
+ * @return -1 if error, else the record number.
+ */
 int blacklist_station(uint8_t *SSID);
 
 
@@ -294,7 +305,7 @@
     bool		UseHLT;				///< Use HLT during brew.
     bool		PumpCooling;			///< Pump during cooling.
     uint32_t		TimeBrewing;			///< Time we are brewing.
-} runtime;
+} runtime;						///< Runtime record.
 
 
 /**
@@ -309,6 +320,10 @@
 void read_runtime(void);
 
 
+
+/**
+ * @brief Addition types
+ */
 typedef enum {
     ADDITION_HOP = 0,
     ADDITION_FERMENTABLE = 1,
@@ -344,7 +359,7 @@
  */
 struct strRecipe {
     uint8_t		Version;			///< Record version number.
-    int			Record;
+    int			Record;				///< Record number
     char		Name[128];			///< Recipe name.
     char		Code[32];			///< Recipe code.
     mashstep_t		MashStep[8];			///< Mash steps.
@@ -357,7 +372,7 @@
     uint16_t		Whirlpool6;			///< Zero or the "Tepid" Whirlpool time 60..66 °
     uint16_t		Whirlpool2;			///< Zero or the Cold Whirlpool time < 30 °
     float		SpargeTemp;			///< Sparge water temperature.
-} recipe;
+} recipe;						///< Recipe record.
 
 /**
  * @brief Append a recipe record. Create file if it doesn't exist.