From: Scott Worley <scottworley@scottworley.com>
Date: Sun, 8 Oct 2023 04:45:13 +0000 (-0700)
Subject: client: Explain config settings
X-Git-Tag: v0.1.0~60
X-Git-Url: http://git.scottworley.com/tattlekey/commitdiff_plain/1d699cc3048d7e1dfed4f13e455cd2ede3d52101

client: Explain config settings
---

diff --git a/client/config.c b/client/config.c
index e3f444b..d2be496 100644
--- 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 7b89ba2..97e2f8c 100644
--- 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