]> git.scottworley.com Git - tattlekey/blob - client/config.h
client: Make the queue size bounds configurable
[tattlekey] / client / config.h
1 #ifndef CONFIG_H
2 #define CONFIG_H
3
4 #include "lwip/arch.h"
5
6 /* Wi-Fi credentials */
7 extern char config_wifi_ssid[];
8 extern char config_wifi_pass[];
9
10 /* Network address of the server to contact */
11 extern char config_tattle_server_ip_address[];
12 extern u16_t config_tattle_port;
13
14 /* For distinguishing reports from multiple tattlekey devices. */
15 extern u16_t config_this_tattler_identity;
16
17 /* Which GPIO pin is the button connected to?
18 * The button should span this pin and ground, connecting this pin to ground
19 * when pressed.
20 * https://projects.raspberrypi.org/en/projects/introduction-to-the-pico/10
21 * recommends pins 18, 22, or 28. */
22 extern uint config_button_pin;
23
24 /* Don't bother reporting each separate button press when it is pressed many
25 * times in short succession. (We also use this to de-bounce. :) */
26 extern u32_t config_minimum_seconds_between_button_presses;
27
28 /* Send each report multiple times. */
29 extern uint config_resend_count;
30
31 /* These control the size of the per-send-count press queues.
32 When the button is pressed more than config_maximum_queue_size times
33 within the resend interval, some presses will be reported fewer
34 than config_resend_count times. This is usually fine because it's
35 the old, longest-delyed, most-redundant reports that get dropped;
36 fresh, timely reports of new button presses will not get anywhere near
37 config_resend_count in a resend interval because the early resend interals
38 are so short. */
39 extern uint config_maximum_queue_size;
40
41 /* This is paranoia about unanticipated delays. Setting this to zero
42 would pobably be fine, but imposing a minimum queue size is an easy
43 safety measure. */
44 extern uint config_minimum_queue_size;
45
46 #endif