d5/d4f/AH_2Settings_2Settings_8hpp_source.html

#ifndef AH_SETTINGSWRAPPER_HPP

#error "Do not include this file directly, use the wrapper!"

#endif


#include <AH/Types/Frequency.hpp>

#include <AH/Hardware/ADCConfig.hpp>

#include <limits.h> // CHAR_BIT

#include <stddef.h>

#include <stdint.h>


BEGIN_AH_NAMESPACE


// ----------------------------- Debug Settings ----------------------------- //

// ========================================================================== //


#ifndef DEBUG_OUT

#define DEBUG_OUT

// #define DEBUG_OUT Serial

#endif


#define FATAL_ERRORS


// ----------------------------- User Settings ------------------------------ //

// ========================================================================== //


constexpr unsigned long defaultBaudRate = 115200;


constexpr uint8_t ADC_BITS = ADC_RESOLUTION;


constexpr uint8_t ANALOG_FILTER_SHIFT_FACTOR = 2;


using ANALOG_FILTER_TYPE = uint16_t;


constexpr unsigned long BUTTON_DEBOUNCE_TIME = 25; // milliseconds


constexpr unsigned long LONG_PRESS_DELAY = 450; // milliseconds


constexpr unsigned long LONG_PRESS_REPEAT_DELAY = 200; // milliseconds


constexpr unsigned long FILTERED_INPUT_UPDATE_INTERVAL = 1000; // microseconds


constexpr static Frequency SPI_MAX_SPEED = 8_MHz;


// ========================================================================== //


END_AH_NAMESPACE

ADCConfig.hpp
This file contains the platform-specific ADC resolutions.

ADC_RESOLUTION
#define ADC_RESOLUTION
The actual maximum resolution of the built-in ADC.
Definition: ADCConfig.hpp:76

END_AH_NAMESPACE
#define END_AH_NAMESPACE
Definition: AH/Settings/NamespaceSettings.hpp:10

BEGIN_AH_NAMESPACE
#define BEGIN_AH_NAMESPACE
Definition: AH/Settings/NamespaceSettings.hpp:9

Frequency.hpp

AH::Frequency
Type-safe class for frequency values.
Definition: Frequency.hpp:11

AH::SPI_MAX_SPEED
static constexpr Frequency SPI_MAX_SPEED
Definition: AH/Settings/Settings.hpp:87

AH::LONG_PRESS_REPEAT_DELAY
constexpr unsigned long LONG_PRESS_REPEAT_DELAY
The time between increments/decremnets during a long press.
Definition: AH/Settings/Settings.hpp:82

AH::ANALOG_FILTER_SHIFT_FACTOR
constexpr uint8_t ANALOG_FILTER_SHIFT_FACTOR
The factor for the analog filter:   Difference equation:  where .
Definition: AH/Settings/Settings.hpp:66

AH::BUTTON_DEBOUNCE_TIME
constexpr unsigned long BUTTON_DEBOUNCE_TIME
The debounce time for momentary push buttons in milliseconds.
Definition: AH/Settings/Settings.hpp:76

AH::FILTERED_INPUT_UPDATE_INTERVAL
constexpr unsigned long FILTERED_INPUT_UPDATE_INTERVAL
The interval between updating filtered analog inputs, in microseconds.
Definition: AH/Settings/Settings.hpp:85

AH::ADC_BITS
constexpr uint8_t ADC_BITS
The bit depth to use for the ADC (Analog to Digital Converter).
Definition: AH/Settings/Settings.hpp:55

AH::defaultBaudRate
constexpr unsigned long defaultBaudRate
The default baud rate for debug output.
Definition: AH/Settings/Settings.hpp:38

AH::ANALOG_FILTER_TYPE
uint16_t ANALOG_FILTER_TYPE
The unsigned integer type to use for analog inputs during filtering.
Definition: AH/Settings/Settings.hpp:73

AH::LONG_PRESS_DELAY
constexpr unsigned long LONG_PRESS_DELAY
The time in milliseconds before a press is registered as a long press.
Definition: AH/Settings/Settings.hpp:79