config_buttons_example.h

// ********************************************************************************************
// Encoder Direction and Actions

// Define the rotation diection for the rotary encoder to increase speed.
//   false = Counter clockwise
//   true = clockwise
// The default value is false (counter clockwise)

// #define ENCODER_ROTATION_CLOCKWISE_IS_INCREASE_SPEED                     false

// Define what the rotary encoder button does.   (Pushing down on the knob)
// By default it will stop the loco if moving, then a second push will change the direction.
// Uncomment and change the action if you wish it to do something else.
// See static.h or README.md for details on the allowed functions.

// #define ENCODER_BUTTON_ACTION SPEED_STOP_THEN_TOGGLE_DIRECTION 

// Define what the rotary encoder button does when the loco is stationary.   (Pushing down on the knob)
//   true = if the locos(s) are stationary, clicking the encoder button will toggle the direction
//   false = does nothing
// this only takes effect if the ENCODER_BUTTON_ACTION (above) is set to SPEED_STOP_THEN_TOGGLE_DIRECTION
// The default value is true

// #define TOGGLE_DIRECTION_ON_ENCODER_BUTTON_PRESSED_WHEN_STATIONAY         true

// Rotary Encoder Debounce Time
// increase if you find the encoder buttons bounce (activate twice) or you get speed changes when you press the encoder button
// #define ROTARY_ENCODER_DEBOUNCE_TIME     200

// If using a bare Rotary Encoder instead of a KY040 encoder module
// Internal GPIO pullups required if the hardware build utilises a bare EC11 rotary encoder in place of a
// KY040 encoder module. (The encoder module has physical pullups fitted)
//   true = bare EC11 used for hardware build WITHOUT any physical pullups, GPIO pullups will ne enabled in main
//   false = KY040 module used in hardware build OR bare EC11 used but with physical pullup resistors 
// The default is false

// #define EC11_PULLUPS_REQUIRED         true

// *******************************************************************************************************************
// Keypad Definitions / Actions

// Define what each button will do as direct press (not in a menu)   * and # cannot be remapped
// See actions.h or README.md for details on the allowed functions

// #define CHOSEN_KEYPAD_0_FUNCTION     FUNCTION_0
// #define CHOSEN_KEYPAD_1_FUNCTION     FUNCTION_1
// #define CHOSEN_KEYPAD_2_FUNCTION     FUNCTION_2
// #define CHOSEN_KEYPAD_3_FUNCTION     FUNCTION_3
// #define CHOSEN_KEYPAD_4_FUNCTION     FUNCTION_4
// #define CHOSEN_KEYPAD_5_FUNCTION     NEXT_THROTTLE
// #define CHOSEN_KEYPAD_6_FUNCTION     SPEED_MULTIPLIER
// #define CHOSEN_KEYPAD_7_FUNCTION     DIRECTION_REVERSE
// #define CHOSEN_KEYPAD_8_FUNCTION     E_STOP
// #define CHOSEN_KEYPAD_9_FUNCTION     DIRECTION_FORWARD
// #define CHOSEN_KEYPAD_A_FUNCTION     CUSTOM_1
// #define CHOSEN_KEYPAD_B_FUNCTION     CUSTOM_2
// #define CHOSEN_KEYPAD_C_FUNCTION     CUSTOM_3
// #define CHOSEN_KEYPAD_D_FUNCTION     CUSTOM_4

// text that will appear when you press #
// if you rearrange the items above, modify this text to suit    * and # cannot be remapped here

// #define CHOSEN_KEYPAD_0_DISPLAY_NAME     "0 Lights"
// #define CHOSEN_KEYPAD_1_DISPLAY_NAME     "1 Bell"
// #define CHOSEN_KEYPAD_2_DISPLAY_NAME     "2 Horn"
// #define CHOSEN_KEYPAD_3_DISPLAY_NAME     "3 F3"
// #define CHOSEN_KEYPAD_4_DISPLAY_NAME     "4 F4"
// #define CHOSEN_KEYPAD_5_DISPLAY_NAME     "5 Nxt Ttl"
// #define CHOSEN_KEYPAD_6_DISPLAY_NAME     "6 X Spd"
// #define CHOSEN_KEYPAD_7_DISPLAY_NAME     "7 Rev"
// #define CHOSEN_KEYPAD_8_DISPLAY_NAME     "8 Estop"
// #define CHOSEN_KEYPAD_9_DISPLAY_NAME     "9 Fwd"

// '#" button action
// By default, # will show the list above. 
//   true = will take you to the Loco Function Labels screen directly
//   false = will take you to the Key Definitions
// The Defualt is false

// #define HASH_SHOWS_FUNCTIONS_INSTEAD_OF_KEY_DEFS         false

// *******************************************************************************************************************
// Maximum number of thtottles

// Define the number of throttles that you want.
// To use multiple throttles, one of the keys or buttons will need to be defined as 
// NEXT_THROTTLE.  (keypad 5 is by default)
// Maximum supported by the WiTcontroller is 6

// uncomment and increase the number if you always need more that two throttles
// #define MAX_THROTTLES                 2 

// *******************************************************************************************************************
// speed increase for each click of the encoder 

// The default is 4
//#define SPEED_STEP                       4

// The default is 3
// #define SPEED_STEP_MULTIPLIER            3          // for 'fast' speed steps

// Additional multiplier.  If the multiplier is enabled from the menu, each rotation of the encoder becomes the speedStep * the AdditionalMultiplier

// The default is 2
// #define SPEED_STEP_ADDITIONAL_MULTIPLIER 2

// by default, the speed will be displayed as the the DCC speed (0-126)
// IMPORTANT: only one should be enabled.  If DISPLAY_SPEED_AS_PERCENT is enabled it will take presidence over DISPLAY_SPEED_AS_0_TO_28
// Note: there will be rounding errors!

// uncomment this line to display the speeds a percentage.
// #define DISPLAY_SPEED_AS_PERCENT         true
// uncomment this line to display the speeds as 0-28.
// #define DISPLAY_SPEED_AS_0_TO_28         true

// *******************************************************************************************************************
// DCC functions in consists
//
// If specified, must be either   CONSIST_ALL_LOCOS  or  CONSIST_LEAD_LOCO
// Default for functions above F2 is CONSIST_LEAD_LOCO

// #define CONSIST_FUNCTION_FOLLOW_F0                  CONSIST_ALL_LOCOS            // lights
// #define CONSIST_FUNCTION_FOLLOW_F1                  CONSIST_LEAD_LOCO            // bell
// #define CONSIST_FUNCTION_FOLLOW_F2                  CONSIST_LEAD_LOCO            // horn

// Defines can optionally be created for CONSIST_FUNCTION_FOLLOW_F3 to CONSIST_FUNCTION_FOLLOW_F31 
// as well.
// If they are not individually specified the CONSIST_FUNCTION_FOLLOW_OTHER_FUNCTIONS option 
// will be used for them.

// *******************************************************************************************************************
// Additional/Optional User Defined Commands

// These can be any legitimate WiThrottle protocol command encosed in quotes or double quotes
// refer to https://www.jmri.org/help/en/package/jmri/jmrit/withrottle/Protocol.shtml

// alert message
// #define CUSTOM_COMMAND_1 "HMHello World"
// set route R500  (DCCEX system route prefix is 'R')
// #define CUSTOM_COMMAND_2 "PRA2R500"
// #define CUSTOM_COMMAND_3 ""
// #define CUSTOM_COMMAND_4 ""
// #define CUSTOM_COMMAND_5 ""
// #define CUSTOM_COMMAND_6 ""
// #define CUSTOM_COMMAND_7 ""

// ********************************************************************************************
// oLED definition

// Uncomment and/or correct one (only) of the #define lines below if you need to override.
// The default .9 inch oLED display settings 
//
// Please select a constructor line for below depending on your display

// U8g2 Constructor List (Frame Buffer)
// The complete list is available here: https://github.com/olikraus/u8g2/wiki/u8g2setupcpp
// Please update the pin numbers according to your setup. Use U8X8_PIN_NONE if the reset pin is not connected

// This is one of the common .9 inch OLED displays and is included by default
// #define OLED_TYPE U8G2_SSD1306_128X64_NONAME_F_HW_I2C u8g2(U8G2_R0, /* reset=*/ U8X8_PIN_NONE, /* clock=*/ 22, /* data=*/ 23);

// This is one of the common 1.3 inch OLED displays
// #define OLED_TYPE U8G2_SH1106_128X64_NONAME_F_HW_I2C u8g2(U8G2_R0, /* reset=*/ U8X8_PIN_NONE, /* clock=*/ 22, /* data=*/ 23);

// *******************************************************************************************************************
// Debugging

// WiTcontroller console debug messages are ENABLED by default
// to disable to console messages, uncomment and set the following to  1    (i.e. 0 = on  1 = off)
// #define WITCONTROLLER_DEBUG    0

// WiThrottle Protocol console debug messages are DISABLED by default
// to enable to console messages, uncomment and set the following to  0    (i.e. 0 = on  1 = off)
// #define WITHROTTLE_PROTOCOL_DEBUG    1

// console debug messages are enabled with the defines above
// the default level is 1
// 0 = errors only 1 = default level 2 = verbose 3 = extreme
// #define DEBUG_LEVEL    1

// *******************************************************************************************************************
// Default function labels

// uncomment any of these lines if you wish to change the labels
//#define F0_LABEL "Light"
//#define F1_LABEL "Bell"
//#define F2_LABEL "Horn"

// *******************************************************************************************************************
// Encoder Hardware
// 
// Uncomment and change as needed
// defaults are for the Small ESP32

// Large EPS32
// #define ROTARY_ENCODER_A_PIN 33
// #define ROTARY_ENCODER_B_PIN 32
// #define ROTARY_ENCODER_BUTTON_PIN 27

// Small ESP32
// #define ROTARY_ENCODER_A_PIN 12
// #define ROTARY_ENCODER_B_PIN 14
// #define ROTARY_ENCODER_BUTTON_PIN 13

// #define ROTARY_ENCODER_VCC_PIN -1 /* 27 put -1 of Rotary encoder Vcc is connected directly to 3,3V; else you can use declared output pin for powering rotary encoder */
// #define ROTARY_ENCODER_STEPS 2 //depending on your encoder - try 1,2 or 4 to get expected behaviour

// *******************************************************************************************************************
// Keypad Hardware
//
// Uncomment and change as needed
// Defaults are for the Small 4x3 keypad

// 4x3 keypad - default
// #define ROW_NUM     4
// #define COLUMN_NUM  3
// #define KEYPAD_KEYS  {'1', '2', '3'}, {'4', '5', '6'}, {'7', '8', '9'}, {'*', '0', '#'}
// #define KEYPAD_ROW_PINS    {19, 18, 17, 16}
// #define KEYPAD_COLUMN_PINS { 4, 0, 2}

// 4x4 keypad
// #define ROW_NUM     4
// #define COLUMN_NUM  4
// #define KEYPAD_KEYS {'1', '2', '3', 'A'},  {'4', '5', '6', 'B'},  {'7', '8', '9', 'C'},  {'*', '0', '#', 'D'}
// #define KEYPAD_ROW_PINS    {19, 18, 17, 16}
// #define KEYPAD_COLUMN_PINS {4, 0, 2, 33}

// Keypad configuration
// Play with these values if you see the keys bounce (activate twice on a single press)
// Times are in miliseconds

// #define KEYPAD_DEBOUNCE_TIME 10
// #define KEYPAD_HOLD_TIME 200

// *******************************************************************************************************************
// Additional / optional buttons
//
// This format for the additional buttons is now depriated
// Use the *New Additional / optional buttons* section instead

// For the 4x3 Keypad 7 buttons can be used
// For the 4x4 keypad, only 6 buttons can be used with the 'normal' pins and the last pin MUST be set to -1, 
//                     or one of pins 34,35,36,39 can be used with additional hardware (see below)

// if you are using the 4x3 keypad - default
// To use the additional buttons, adjust the functions assigned to them in config_buttons.h
// #define ADDITIONAL_BUTTONS_PINS      {5,15,25,26,27,32,33}
// #define ADDITIONAL_BUTTONS_TYPE      {INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP}

// if you are using the 4x4 keypad, pin 33 is not available
// To use the additional buttons, adjust the functions assigned to them in config_buttons.h
// #define ADDITIONAL_BUTTONS_PINS      {5,15,25,26,27,32,-1}  // last pin must be set to -1
// #define ADDITIONAL_BUTTONS_TYPE      {INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP,INPUT_PULLUP}

// set TYPE to either INPUT_PULLUP or INPUT.  If INPUT, the pin will need an external pullup resister (e.g. 10k)
// Note: pins 34,35,36,39 can be used but don't have an internal pullup, 
//       so need additional hardware (resister) if you wish to use one of them

// Additional / optional buttons - Debounce 
// Uncomment and increase this value if you find the buttons bounce. i.e. activate twice on a single press
// Times are in miliseconds
// default = 50
// #define ADDITIONAL_BUTTON_DEBOUNCE_DELAY        50    

// *******************************************************************************************************************
// Additional buttons

// This format for the additional buttons IS NOW DEPRECATED
// Use the *New Additional / optional buttons* section instead

// Define what each of the optional additional buttons will do.
// See static.h or README.md for details on the allowed functions.
// Set the ones you don't need to FUNCTION_NULL. (They will default to FUNCTION_NULL in any case.)
// The button numbers relate to the GPIO pins 5,15,25,26,27,32,33

// #define CHOSEN_ADDITIONAL_BUTTON_0_FUNCTION     FUNCTION_NULL   // GPIO 5
// #define CHOSEN_ADDITIONAL_BUTTON_1_FUNCTION     FUNCTION_NULL   // GPIO 15
// #define CHOSEN_ADDITIONAL_BUTTON_2_FUNCTION     FUNCTION_NULL   // GPIO 25
// #define CHOSEN_ADDITIONAL_BUTTON_3_FUNCTION     FUNCTION_NULL   // GPIO 26
// #define CHOSEN_ADDITIONAL_BUTTON_4_FUNCTION     FUNCTION_NULL   // GPIO 27
// #define CHOSEN_ADDITIONAL_BUTTON_5_FUNCTION     FUNCTION_NULL   // GPIO 32
// #define CHOSEN_ADDITIONAL_BUTTON_6_FUNCTION     FUNCTION_NULL   // GPIO 33

// The following are either 'true' = LATCHING or 'false' = NOT LATCHING
// Only relevant for the buttons that are set to FUNCTION_00 to FUNCTION_32
//
// #define ADDITIONAL_BUTTON_OVERRIDE_DEFAULT_LATCHING true
//
// #define ADDITIONAL_BUTTON_0_LATCHING true
// #define ADDITIONAL_BUTTON_1_LATCHING true
// #define ADDITIONAL_BUTTON_2_LATCHING true
// #define ADDITIONAL_BUTTON_3_LATCHING true
// #define ADDITIONAL_BUTTON_4_LATCHING true
// #define ADDITIONAL_BUTTON_5_LATCHING true
// #define ADDITIONAL_BUTTON_6_LATCHING true

// *******************************************************************************************************************
// New Additional / optional buttons
//
// This new format allows for up to 11 additional buttons
//
// To use the new format USE_NEW_ADDITIONAL_BUTTONS_FORMAT must be set to 'true'
// And NEW_MAX_ADDITIONAL_BUTTONS must be set to the number you want to use. 
// Then the following list MUST have the same number of elements
// Make sure the last entry in each list does NOT have the comma (,)

//   #define USE_NEW_ADDITIONAL_BUTTONS_FORMAT true

// Only relevant for the buttons that are set to FUNCTION_00 to FUNCTION_32
// Either 'true' = LATCHING or 'false' = NOT LATCHING
//   #define ADDITIONAL_BUTTON_OVERRIDE_DEFAULT_LATCHING true

// must be 1 or greater
//    #define NEW_MAX_ADDITIONAL_BUTTONS 11

//    #define NEW_ADDITIONAL_BUTTON_ACTIONS {\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL,\
//                            FUNCTION_NULL\
//                            }

//    #define NEW_ADDITIONAL_BUTTON_LATCHING {\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true,\
//                            true\
//                            }

// Set the pin value to -1 to skip that value.
// For pins on the ESP32 use the number shown on the board/diagram
// If you are using pins on a I2C GPIO Expansion board, they will be numbered: 0-15
//
//    #define NEW_ADDITIONAL_BUTTON_PIN {\
//                            5,\
//                            15,\
//                            25,\
//                            26,\
//                            27,\
//                            32,\
//                            33,\
//                            34,\
//                            35,\
//                            36,\
//                            39\
//                            }

// Set to either INPUT_PULLUP or INPUT.  If INPUT, the pin will need an external pullup resister (e.g. 10k)
// Pins 34,35,36,39 can be used but don't have an internal pullup, so use INPUT for these
//
//    #define NEW_ADDITIONAL_BUTTON_TYPE {\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT_PULLUP,\
//                            INPUT,\
//                            INPUT,\
//                            INPUT,\
//                            INPUT\
//                            }

// *******************************************************************************************************************
// Throttle Pot

// To use a pot instead of the rotary encoder, uncomment the following lines
//
// Set the number of notches and the values of the pot at each notch.  must be 8 values

// #define USE_ROTARY_ENCODER_FOR_THROTTLE false
// #define THROTTLE_POT_PIN 39
// #define THROTTLE_POT_USE_NOTCHES false  // if false, only THROTTLE_POT_NOTCH_VALUES 0 and 7 below (first and last) are use. 
// #define THROTTLE_POT_NOTCH_VALUES {1,585,1170,1755,2340,2925,3510,4094}
// #define THROTTLE_POT_NOTCH_SPEEDS {0,18,36,54,72,90,108,127}  // 0-127 These numbers will be the speed step for each of the 8 throttle notches.

// note: The example values above for THROTTLE_POT_NOTCH_VALUES are useble for a 10k ohm pot 
// but any value pot can be used by altering that values. Just adjust the numbers.
// Numbers can generated by Generate_Throttle__Brake__Reverser__Numbers program by Sumner Patterson

// *******************************************************************************************************************
// Battery Test

// To use a battery test you must add additional hardware. (see the README.)

//  USE_BATTERY_SLEEP_AT_PERCENT - will put the device to sleep if the battery falls below this level
//                               - set to 0 (zero) to disable
//
// #define USE_BATTERY_TEST true
// #define BATTERY_TEST_PIN 34
// #define BATTERY_CONVERSION_FACTOR 1.7
// #define USE_BATTERY_PERCENT_AS_WELL_AS_ICON false
// #define USE_BATTERY_SLEEP_AT_PERCENT 3   // will put the device to sleep if the battery falls below this level

// *******************************************************************************************************************
// Heartbeat 

// If no response is received from the server in the specified period (milliseconds), shut down.
// default is 4 minutes = 240000

// #define MAX_HEARTBEAT_PERIOD 240000

// enable heartbeat by default.  Can be turned on or off in the menus
// #define HEARTBEAT_ENABLED true 

// *******************************************************************************************************************
// Roster Sorting

//   0 = no sorting.  As it comes from the server
//   1 = sort by name (first 10 chars only)
//   2 = sort by DCC Address
// The default is 'sort by name'

// #define ROSTER_SORT_SEQUENCE 1

// *******************************************************************************************************************
// Translations

// Uncomment the appropriate line to change the language displayed.
// If you wish to override any of the translations you can do so individually here,
// but, the define(s) must done before the #include of the base langauge file
//
//
// German - Deutsche
// #include "language_deutsch.h"

// *******************************************************************************************************************
// Startup Commands

// The following commands will be executed, in order, after connection to the WiThrottle Server.
// Each must be ONLY ONE single valid command.  Either a direct action or a menu action.
//
// Note: Selecting from the roster/turnouts etc. is not possible as the commands 
// will execute before the roster loads.

// e.g. this command will automatically acquire loco with a DCC Address of 222  
// then set the speed multplier to *3
// #define STARTUP_COMMAND_1 "*1222#"
// #define STARTUP_COMMAND_2 "6"
// #define STARTUP_COMMAND_3 ""
// #define STARTUP_COMMAND_4 ""

// Enabling this option will automatically acquire the only roster entry after connection to the 
// WiThrottle Server, but only if there is only one roster entry 
// #define ACQUIRE_ROSTER_ENTRY_IF_ONLY_ONE true

// *******************************************************************************************************************
// Display Loco name

// Uncomment if you want to display the loco name instead of DCC address
// #define DISPLAY_LOCO_NAME

// if you want to change the space between two loco names/ dcc addresses
// #define CONSIST_SPACE_BETWEEN_LOCOS " "

// ***************************************************
// loco Acquire
//
// if you never want on-the-fly consists/MUs then uncomment this line
// This can be altered on the fly in the Extras menu

// #define DROP_BEFORE_ACQUIRE true

// ***************************************************
// Restore previously acquired locos on connection
//
// If this option is enabled, and you have deliberately saved the current 
// locos ( # -> 9 -> 9), then the next time you connect the device it 
// will try to load the previously acquired locos.
//
// enabled by default

// #define RESTORE_ACQUIRED_LOCOS false