client: lint nits

[tattlekey] / client / config.h

diff --git a/client/config.h b/client/config.h
index fefe7e96703665428d15f21f8163e6727a256651..ee3dba88a147c071cb14963c4a95271c45ee3129 100644 (file)
--- a/client/config.h
+++ b/client/config.h
@@ -4,29 +4,43 @@
 #include "lwip/arch.h"
 
 /* Wi-Fi credentials */
-extern char wifi_ssid[];
-extern char wifi_pass[];
+extern const char config_wifi_ssid[];
+extern const char config_wifi_pass[];
 
 /* Network address of the server to contact */
-extern char tattle_server_ip_address[];
-extern u16_t tattle_port;
+extern const char config_tattle_server_ip_address[];
+extern const u16_t config_tattle_port;
 
 /* For distinguishing reports from multiple tattlekey devices. */
-extern u16_t this_tattler_identity;
+extern const u16_t config_this_tattler_identity;
 
 /* Which GPIO pin is the button connected to?
  * The button should span this pin and ground, connecting this pin to ground
  * when pressed.
  * https://projects.raspberrypi.org/en/projects/introduction-to-the-pico/10
  * recommends pins 18, 22, or 28. */
-extern uint button_pin;
+extern const uint config_button_pin;
 
 /* Don't bother reporting each separate button press when it is pressed many
  * times in short succession.  (We also use this to de-bounce. :) */
-extern u32_t minimum_microseconds_between_button_presses;
+extern const u32_t config_minimum_seconds_between_button_presses;
 
 /* Send each report multiple times. */
-extern uint resend_count;
-extern u32_t resend_interval_ms;
+extern const uint config_resend_count;
+
+/* These control the size of the per-send-count press queues.
+When the button is pressed more than config_maximum_queue_size times
+within the resend interval, some presses will be reported fewer
+than config_resend_count times. This is usually fine because it's
+the old, longest-delyed, most-redundant reports that get dropped;
+fresh, timely reports of new button presses will not get anywhere near
+config_resend_count in a resend interval because the early resend interals
+are so short.  */
+extern const uint config_maximum_queue_size;
+
+/* This is paranoia about unanticipated delays.  Setting this to zero
+would pobably be fine, but imposing a minimum queue size is an easy
+safety measure. */
+extern const uint config_minimum_queue_size;
 
 #endif