Arduino Helpers master
Utility library for Arduino
Settings.hpp
Go to the documentation of this file.
1#ifndef AH_SETTINGSWRAPPER_HPP
2#error "Do not include this file directly, use the wrapper!"
3#endif
4
13#include <limits.h> // CHAR_BIT
14#include <stddef.h>
15#include <stdint.h>
16
18
19// ----------------------------- Debug Settings ----------------------------- //
20// ========================================================================== //
21
22#ifndef DEBUG_OUT
27#define DEBUG_OUT
28// #define DEBUG_OUT Serial
29#endif
30
32#define FATAL_ERRORS
33
34// ----------------------------- User Settings ------------------------------ //
35// ========================================================================== //
36
38constexpr unsigned long defaultBaudRate = 115200;
39
55constexpr uint8_t ADC_BITS = ADC_RESOLUTION;
56
66constexpr uint8_t ANALOG_FILTER_SHIFT_FACTOR = 2;
67
73using ANALOG_FILTER_TYPE = uint16_t;
74
76constexpr unsigned long BUTTON_DEBOUNCE_TIME = 25; // milliseconds
77
81constexpr unsigned long SELECT_LINE_DELAY = 10; // microseconds
82
84constexpr unsigned long LONG_PRESS_DELAY = 450; // milliseconds
85
87constexpr unsigned long LONG_PRESS_REPEAT_DELAY = 200; // milliseconds
88
90constexpr unsigned long FILTERED_INPUT_UPDATE_INTERVAL = 1000; // microseconds
91
92constexpr static Frequency SPI_MAX_SPEED = 8_MHz;
93
94// ========================================================================== //
95
This file contains the platform-specific ADC resolutions.
#define ADC_RESOLUTION
The actual maximum resolution of the built-in ADC.
Definition: ADCConfig.hpp:76
#define END_AH_NAMESPACE
#define BEGIN_AH_NAMESPACE
static constexpr Frequency SPI_MAX_SPEED
Definition: Settings.hpp:92
constexpr unsigned long SELECT_LINE_DELAY
The time in microseconds to wait for lines of multiplexers and scanning matrices to settle before rea...
Definition: Settings.hpp:81
constexpr unsigned long LONG_PRESS_REPEAT_DELAY
The time between increments/decremnets during a long press.
Definition: Settings.hpp:87
constexpr uint8_t ANALOG_FILTER_SHIFT_FACTOR
The factor for the analog filter: Difference equation: where .
Definition: Settings.hpp:66
constexpr unsigned long BUTTON_DEBOUNCE_TIME
The debounce time for momentary push buttons in milliseconds.
Definition: Settings.hpp:76
constexpr unsigned long FILTERED_INPUT_UPDATE_INTERVAL
The interval between updating filtered analog inputs, in microseconds.
Definition: Settings.hpp:90
constexpr uint8_t ADC_BITS
The bit depth to use for the ADC (Analog to Digital Converter).
Definition: Settings.hpp:55
constexpr unsigned long defaultBaudRate
The default baud rate for debug output.
Definition: Settings.hpp:38
uint16_t ANALOG_FILTER_TYPE
The unsigned integer type to use for analog inputs during filtering.
Definition: Settings.hpp:73
constexpr unsigned long LONG_PRESS_DELAY
The time in milliseconds before a press is registered as a long press.
Definition: Settings.hpp:84
Type-safe class for frequency values.
Definition: Frequency.hpp:8