]> git.scottworley.com Git - tattlekey/blob - client/config.h
2ffce683b52358cce8c605ad37feed37188c5e1a
[tattlekey] / client / config.h
1 /* tattlekey: A one-key UDP keyboard
2 * Copyright (C) 2023 Scott Worley <scottworley@scottworley.com>
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18 #ifndef CONFIG_H
19 #define CONFIG_H
20
21 #include "lwip/arch.h"
22
23 /* Wi-Fi credentials */
24 extern const char config_wifi_ssid[];
25 extern const char config_wifi_pass[];
26
27 /* Network address of the server to contact */
28 extern const char config_tattle_server_ip_address[];
29 extern const u16_t config_tattle_port;
30
31 /* For distinguishing reports from multiple tattlekey devices. */
32 extern const u16_t config_this_tattler_identity;
33
34 /* Which GPIO pin is the button connected to?
35 * The button should span this pin and ground, connecting this pin to ground
36 * when pressed.
37 * https://projects.raspberrypi.org/en/projects/introduction-to-the-pico/10
38 * recommends pins 18, 22, or 28. */
39 extern const uint config_button_pin;
40
41 /* Don't bother reporting each separate button press when it is pressed many
42 * times in short succession. (We also use this to de-bounce. :) */
43 extern const u32_t config_minimum_seconds_between_button_presses;
44
45 /* Send each report multiple times. */
46 extern const uint config_resend_count;
47
48 /* These control the size of the per-send-count press queues.
49 When the button is pressed more than config_maximum_queue_size times
50 within the resend interval, some presses will be reported fewer
51 than config_resend_count times. This is usually fine because it's
52 the old, longest-delyed, most-redundant reports that get dropped;
53 fresh, timely reports of new button presses will not get anywhere near
54 config_resend_count in a resend interval because the early resend interals
55 are so short. */
56 extern const uint config_maximum_queue_size;
57
58 /* This is paranoia about unanticipated delays. Setting this to zero
59 would pobably be fine, but imposing a minimum queue size is an easy
60 safety measure. */
61 extern const uint config_minimum_queue_size;
62
63 #endif