Commanders
Arduino buttons/bus library
Commanders.h File Reference
#include <DIO2.h>
#include "Commander.hpp"
#include "Commanders.hpp"
#include "ButtonsCommander.hpp"
#include "SerialCommander.hpp"
#include "TextInterpreter.hpp"
#include "EventsSequencer.hpp"

Go to the source code of this file.

Macros

#define COMMANDERS_DEBUG_MODE
 
#define COMMANDERS_PRINT_COMMANDERS
 
#define GPIO2_PREFER_SPEED   1
 
#define NO_BUTTONSCOMMANDERENCODER
 
#define NO_BUTTONSCOMMANDERPOTENTIOMETER
 
#define NO_CANCOMMANDER
 
#define NO_DCCCOMMANDER
 
#define NO_I2CCOMMANDER
 
#define COMMANDERS_DEBUG_MODE
 
#define COMMANDERS_DEBUG_VERBOSE_MODE
 
#define COMMANDERS_PRINT_COMMANDERS
 

Detailed Description

Main include file of the library.

Definition in file Commanders.h.

Macro Definition Documentation

#define COMMANDERS_DEBUG_MODE

If this is defined, the library will do many checks during setup and execution, and print errors, warnings and information messages on console. These messages can take a lot of memory, so be careful about the free memory of your program if you activate debug mode.

Definition at line 540 of file Commanders.h.

#define COMMANDERS_DEBUG_MODE

If this is defined, the library will do many checks during setup and execution, and print errors, warnings and information messages on console. These messages can take a lot of memory, so be careful about the free memory of your program if you activate debug mode.

Definition at line 540 of file Commanders.h.

#define COMMANDERS_DEBUG_VERBOSE_MODE

If this is defined, the Verbose mode lets you see all actions done by the library, but with a real flood of text to the console... It has no effect if COMMANDERS_DEBUG_MODE is not activated.

Definition at line 543 of file Commanders.h.

#define COMMANDERS_PRINT_COMMANDERS

If this is defined, the function Commanders::printCommanders() will become available. This is useful to try to understand why a commander, or a commander item is not correctly defined. This function uses a lot of memory, so activate it only if necessary, and be careful about your program's memory. You can use the define PRINT_COMMANDERS() in your sketch instead of a call to Commanders::printCommanders(). If COMMANDERS_PRINT_COMMANDERS is not defined, PRINT_COMMANDERS is defined as empty, so you will not have a compilation error.

Definition at line 549 of file Commanders.h.

#define COMMANDERS_PRINT_COMMANDERS

If this is defined, the function Commanders::printCommanders() will become available. This is useful to try to understand why a commander, or a commander item is not correctly defined. This function uses a lot of memory, so activate it only if necessary, and be careful about your program's memory. You can use the define PRINT_COMMANDERS() in your sketch instead of a call to Commanders::printCommanders(). If COMMANDERS_PRINT_COMMANDERS is not defined, PRINT_COMMANDERS is defined as empty, so you will not have a compilation error.

Definition at line 549 of file Commanders.h.

#define GPIO2_PREFER_SPEED   1

This is used internally by DIO2.h

Definition at line 428 of file Commanders.h.