Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Namespaces | Macros | Typedefs | Variables
Settings.hpp File Reference

Detailed Description

All user settings and debugging options can be changed here.

Definition in file AH/Settings/Settings.hpp.

#include <AH/Types/Frequency.hpp>
#include <AH/Hardware/ADCConfig.hpp>
#include <limits.h>
#include <stddef.h>
#include <stdint.h>
+ Include dependency graph for AH/Settings/Settings.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  AH
 PrintStream library
 

Macros

#define DEBUG_OUT
 The debug output.
 
#define FATAL_ERRORS
 Exit when encountering an error, instead of trying to recover (recommended).
 

Typedefs

using ANALOG_FILTER_TYPE = uint16_t
 The unsigned integer type to use for analog inputs during filtering.
 

Variables

constexpr unsigned long defaultBaudRate = 115200
 The default baud rate for debug output.
 
constexpr uint8_t ADC_BITS = 10
 The bit depth to use for the ADC (Analog to Digital Converter).
 
constexpr uint8_t ANALOG_FILTER_SHIFT_FACTOR = 2
 The factor for the analog filter:
Difference equation: \( y[n] = \alpha\cdot x[n] + (1-\alpha)\cdot y[n-1] \) where \( \alpha = \left(\frac{1}{2}\right)^{ANALOG\_FILTER\_SHIFT\_FACTOR} \).
 
constexpr unsigned long BUTTON_DEBOUNCE_TIME = 25
 The debounce time for momentary push buttons in milliseconds.
 
constexpr unsigned long SELECT_LINE_DELAY = 10
 The time in microseconds to wait for lines of multiplexers and scanning matrices to settle before reading the value.
 
constexpr unsigned long LONG_PRESS_DELAY = 450
 The time in milliseconds before a press is registered as a long press.
 
constexpr unsigned long LONG_PRESS_REPEAT_DELAY = 200
 The time between increments/decremnets during a long press.
 
constexpr unsigned long FILTERED_INPUT_UPDATE_INTERVAL = 1000
 The interval between updating filtered analog inputs, in microseconds.
 
static constexpr Frequency SPI_MAX_SPEED = 8_MHz
 

Macro Definition Documentation

◆ DEBUG_OUT

#define DEBUG_OUT

The debug output.


Use #define DEBUG_OUT Serial to print debugging information to the serial monitor.

Note
Printing debug information can slow down the program dramatically.

Definition at line 27 of file AH/Settings/Settings.hpp.

◆ FATAL_ERRORS

#define FATAL_ERRORS

Exit when encountering an error, instead of trying to recover (recommended).

Definition at line 32 of file AH/Settings/Settings.hpp.