client: Explain config settings

diff --git a/client/config.c b/client/config.c
index e3f444b7fe519371de45019f1e0be804d8bfa981..d2be496c95dd8f631ceb4a3969c197156f8ec846 100644 (file)
--- a/client/config.c
+++ b/client/config.c
@@ -1,9 +1,12 @@
 #include "config.h"
 
+/* Wi-Fi credentials */
 char wifi_ssid[] = "THEWIFISSID";
 char wifi_pass[] = "THEWIFIPASSWORD";
 
+/* Network address of the server to contact */
 char tattle_server_ip_address[] = "192.168.10.10";
 u16_t tattle_port = 29803; // 'tk'
 
+/* For distinguishing reports from multiple tattlekey devices. */
 u16_t this_tattler_identity = 1;

diff --git a/client/config.h b/client/config.h
index 7b89ba2cb583a3fc014cf93df211e2db7ec28793..97e2f8cfb3be723b1a86808dc26f553f9d83e9d7 100644 (file)
--- a/client/config.h
+++ b/client/config.h
@@ -3,12 +3,15 @@
 
 #include "lwip/arch.h"
 
+/* Wi-Fi credentials */
 extern char wifi_ssid[];
 extern char wifi_pass[];
 
-extern u16_t tattle_port;
+/* Network address of the server to contact */
 extern char tattle_server_ip_address[];
+extern u16_t tattle_port;
 
+/* For distinguishing reports from multiple tattlekey devices. */
 extern u16_t this_tattler_identity;
 
 #endif