dani/CommandStation-EX
1
0
Fork 0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2025-01-12 05:41:02 +01:00
Code Releases Activity

Documentation improvements in config.example.h

Browse Source
This commit is contained in:
Harald Barth 2025-01-05 20:18:44 +01:00
parent 42986c3b2d
commit 6f1c7a9e98
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
config.example.h
View File

@ -1,7 +1,7 @@
/* /*
* © 2022 Paul M. Antoine * © 2022 Paul M. Antoine
* © 2021 Neil McKechnie * © 2021 Neil McKechnie
* © 2020-2023 Harald Barth * © 2020-2025 Harald Barth
* © 2020-2021 Fred Decker * © 2020-2021 Fred Decker
* © 2020-2021 Chris Harlow * © 2020-2021 Chris Harlow
* © 2023 Nathan Kellenicki * © 2023 Nathan Kellenicki
@ -45,15 +45,14 @@ The configuration file for DCC-EX Command Station
// the correct resistor could damage the sense pin on your Arduino or destroy // the correct resistor could damage the sense pin on your Arduino or destroy
// the device. // the device.
// //
// DEFINE MOTOR_SHIELD_TYPE BELOW. THESE ARE EXAMPLES. FULL LIST IN MotorDrivers.h // DEFINE MOTOR_SHIELD_TYPE BELOW. THESE ARE EXAMPLES. Full list in MotorDrivers.h
// //
// STANDARD_MOTOR_SHIELD : Arduino Motor shield Rev3 based on the L298 with 18V 2A per channel // STANDARD_MOTOR_SHIELD : Arduino Motor shield Rev3 based on the L298 with 18V 2A per channel
// POLOLU_MOTOR_SHIELD : Pololu MC33926 Motor Driver (not recommended for prog track) // POLOLU_MOTOR_SHIELD : Pololu MC33926 Motor Driver (not recommended for prog track)
// FUNDUMOTO_SHIELD : Fundumoto Shield, no current sensing (not recommended, no short protection)
// FIREBOX_MK1 : The Firebox MK1
// FIREBOX_MK1S : The Firebox MK1S
// IBT_2_WITH_ARDUINO : Arduino Motor Shield for PROG and IBT-2 for MAIN
// EX8874_SHIELD : DCC-EX TI DRV8874 based motor shield // EX8874_SHIELD : DCC-EX TI DRV8874 based motor shield
// EXCSB1 : DCC-EX CSB-1 hardware
// EXCSB1_WITH_EX8874 : DCC-EX CSB-1 hardware with DCC-EX TI DRV8874 shield
// NO_SHIELD : CS without any motor shield (as an accessory only CS)
// | // |
// +-----------------------v // +-----------------------v
// //
@ -81,7 +80,7 @@ The configuration file for DCC-EX Command Station
///////////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////////////
// //
// NOTE: Only supported on Arduino Mega // NOTE: Not supported on Arduino Uno or Nano
// Set to false if you not even want it on the Arduino Mega // Set to false if you not even want it on the Arduino Mega
// //
#define ENABLE_WIFI true #define ENABLE_WIFI true
@ -116,13 +115,13 @@ The configuration file for DCC-EX Command Station
// Your password may not contain ``"'' (double quote, ASCII 0x22). // Your password may not contain ``"'' (double quote, ASCII 0x22).
#define WIFI_PASSWORD "Your network passwd" #define WIFI_PASSWORD "Your network passwd"
// //
// WIFI_HOSTNAME: You probably don't need to change this // WIFI_HOSTNAME: You can change this if you have more than one
// CS to make them show up with different names on the network.
// Otherwise do not touch.
#define WIFI_HOSTNAME "dccex" #define WIFI_HOSTNAME "dccex"
// //
// WIFI_CHANNEL: If the line "#define ENABLE_WIFI true" is uncommented, // WIFI_CHANNEL: The default channel is set to "1". If you need to use an
// WiFi will be enabled (Mega only). The default channel is set to "1" whether // alternate channel (we recommend using only 1,6, or 11) you may change it here.
// this line exists or not. If you need to use an alternate channel (we recommend
// using only 1,6, or 11) you may change it here.
#define WIFI_CHANNEL 1 #define WIFI_CHANNEL 1
// //
// WIFI_FORCE_AP: If you'd like to specify your own WIFI_SSID in AP mode, set this // WIFI_FORCE_AP: If you'd like to specify your own WIFI_SSID in AP mode, set this
@ -132,8 +131,9 @@ The configuration file for DCC-EX Command Station
///////////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////////////
// //
// ENABLE_ETHERNET: Set to true if you have an Arduino Ethernet card (wired). This // ENABLE_ETHERNET: Set to true if you have an Arduino Ethernet card (wired) based
// is not for Wifi. You will then need the Arduino Ethernet library as well // on the W5100/W5500 ethernet chip or an STM32 CS with builin ethernet like the F429ZI.
// This is not for Wifi. You will then need the Arduino Ethernet library as well.
// //
//#define ENABLE_ETHERNET true //#define ENABLE_ETHERNET true
@ -334,7 +334,7 @@ The configuration file for DCC-EX Command Station
// to the sabertooth controller _as_well_. Default: Undefined. // to the sabertooth controller _as_well_. Default: Undefined.
// //
//#define SABERTOOTH 1 //#define SABERTOOTH 1
//
///////////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////////////
// //
// SENSORCAM // SENSORCAM
@ -346,7 +346,7 @@ The configuration file for DCC-EX Command Station
//#define SENSORCAM2_VPIN 600 //define other CAM's if installed. //#define SENSORCAM2_VPIN 600 //define other CAM's if installed.
//#define CAM2 SENSORCAM2_VPIN+ //for EX-RAIL commands e.g. IFLT(CAM2 020,1) //#define CAM2 SENSORCAM2_VPIN+ //for EX-RAIL commands e.g. IFLT(CAM2 020,1)
// //
// For smoother power-up, define a STARTUP_DELAY to allow CAM to initialise ref images // For smoother power-up, when using the CAM, you may need a STARTUP_DELAY.
//#define STARTUP_DELAY 5000 // up to 20sec. CS delay // That is described further above.
// //
///////////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////////////