Control Surface  1.2.0
MIDI Control Surface library for Arduino
Classes | Typedefs | Variables
Def.hpp File Reference
#include "Channel.hpp"
#include "Cable.hpp"
#include <AH/Containers/Array.hpp>
#include <AH/Hardware/Hardware-Types.hpp>
#include <Settings/NamespaceSettings.hpp>
#include <stddef.h>
#include <stdint.h>
+ Include dependency graph for Def.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EncoderSwitchPinList
 A struct for the pins of a rotary (quadrature) encoder with a switch. More...
 
struct  EncoderPinList
 A struct for the pins of a rotary (quadrature) encoder without a switch. More...
 
struct  Potentiometer
 
struct  MotorFader
 
struct  Display
 
struct  PixelLocation
 A simple struct representing a pixel with integer coordinates. More...
 

Typedefs

using MappingFunction = analog_t(*)(analog_t)
 
template<uint8_t nb_rows, uint8_t nb_cols>
using AddressMatrix = Array2D< uint8_t, nb_rows, nb_cols >
 
using setting_t = uint8_t
 The type used for Selectors. More...
 

Variables

constexpr setting_t NO_SETTING = 1 << (8 * sizeof(setting_t) - 1)
 A special setting that indicates an unused or invalid setting. More...
 

Class Documentation

◆ EncoderPinList

struct EncoderPinList

A struct for the pins of a rotary (quadrature) encoder without a switch.

Definition at line 44 of file Def.hpp.

+ Collaboration diagram for EncoderPinList:
Class Members
uint8_t A The pin connected to the A pin of the encoder.
uint8_t B The pin connected to the B pin of the encoder.

◆ Potentiometer

struct Potentiometer

Definition at line 55 of file Def.hpp.

+ Collaboration diagram for Potentiometer:

◆ MotorFader

struct MotorFader

Definition at line 56 of file Def.hpp.

+ Collaboration diagram for MotorFader:

◆ Display

struct Display

Definition at line 57 of file Def.hpp.

+ Collaboration diagram for Display:

◆ PixelLocation

struct PixelLocation

A simple struct representing a pixel with integer coordinates.

Definition at line 60 of file Def.hpp.

+ Collaboration diagram for PixelLocation:
Class Members
int16_t x
int16_t y

Typedef Documentation

◆ MappingFunction

using MappingFunction = analog_t (*)(analog_t)

Definition at line 20 of file Def.hpp.

◆ AddressMatrix

using AddressMatrix = Array2D<uint8_t, nb_rows, nb_cols>
Todo:
This should be an array of type MIDIAddress.

Definition at line 27 of file Def.hpp.

◆ setting_t

using setting_t = uint8_t

The type used for Selectors.

Definition at line 50 of file Def.hpp.

Variable Documentation

◆ NO_SETTING

constexpr setting_t NO_SETTING = 1 << (8 * sizeof(setting_t) - 1)
constexpr

A special setting that indicates an unused or invalid setting.

Definition at line 52 of file Def.hpp.