DCCpp
This is the library version of a program for Arduino to control railroading DCC devices.
DCCpp.hpp
1 //-------------------------------------------------------------------
2 #ifndef __DCCpp_hpp__
3 #define __DCCpp_hpp__
4 //-------------------------------------------------------------------
5 
6 #include "DCCpp.h"
7 
14 {
15  private:
18  byte activeFlags[4];
19 
23  byte activeFlagsSent[4];
24 
25  inline byte byteNumber(byte inFunctionNumber) { return inFunctionNumber / 8; }
26  inline byte bitNumber(byte inFunctionNumber) { return inFunctionNumber % 8; }
27 
28  public:
32 
35  void clear();
39  void activate(byte inFunctionNumber);
43  void inactivate(byte inFunctionNumber);
48  bool isActivated(byte inFunctionNumber);
50  void statesSent();
56  bool isActivationChanged(byte inFunctionNumber);
57 
58 #ifdef DCCPP_DEBUG_MODE
59 
62  void printActivated();
63 #endif
64 };
65 
70 class DCCpp
71 {
72  private:
73  static bool programMode;
74  static bool panicStopped;
75 
76  static bool setThrottle(volatile RegisterList *inReg, int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward);
77  static int readCv(volatile RegisterList *inReg, byte inCvId, int callBack = 100, int callBackSub = 200) { return inReg->readCVmain(inCvId, callBack, callBackSub); }
78  static void writeCv(volatile RegisterList *inReg, int inCvId, byte inCvValue, int callBack = 100, int callBackSub = 200);
79  static int identifyLocoId(volatile RegisterList *inReg);
80  static void setFunctions(volatile RegisterList *inReg, int nReg, int inLocoId, FunctionsState &inStates);
81 
82  public:
83  static volatile RegisterList mainRegs, progRegs;
84  static CurrentMonitor mainMonitor;
85  static CurrentMonitor progMonitor;
86 
87  public:
88  // begins
91  static void begin();
98  static void beginMain(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor);
105  static void beginProg(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor);
106 
109  static inline void beginMainMotorShield() { beginMain(MOTOR_SHIELD_DIRECTION_MOTOR_CHANNEL_PIN_A, DCC_SIGNAL_PIN_MAIN, MOTOR_SHIELD_SIGNAL_ENABLE_PIN_MAIN, MOTOR_SHIELD_CURRENT_MONITOR_PIN_MAIN); }
112  static inline void beginProgMotorShield() { beginMain(MOTOR_SHIELD_DIRECTION_MOTOR_CHANNEL_PIN_B, DCC_SIGNAL_PIN_PROG, MOTOR_SHIELD_SIGNAL_ENABLE_PIN_PROG, MOTOR_SHIELD_CURRENT_MONITOR_PIN_PROG); }
113 
116  static inline void beginMainPololu() { beginMain(POLOLU_DIRECTION_MOTOR_CHANNEL_PIN_A, DCC_SIGNAL_PIN_MAIN, POLOLU_SIGNAL_ENABLE_PIN_MAIN, POLOLU_CURRENT_MONITOR_PIN_MAIN); }
119  static inline void beginProgPololu() { beginMain(POLOLU_DIRECTION_MOTOR_CHANNEL_PIN_B, DCC_SIGNAL_PIN_PROG, POLOLU_SIGNAL_ENABLE_PIN_PROG, POLOLU_CURRENT_MONITOR_PIN_PROG); }
120 #ifdef USE_ETHERNET
121 
126  static void beginEthernet(uint8_t *inMac, uint8_t *inIp, EthernetProtocol inProtocol = EthernetProtocol::TCP);
127 #endif
128 
129  // DCCpp global functions
130 
133  static void loop();
137  static void panicStop(bool inStop);
140  static void powerOn();
143  static void powerOff();
147  static inline void setCurrentSampleMaxMain(float inMax) { mainMonitor.currentSampleMax = inMax; }
151  static inline void setCurrentSampleMaxProg(float inMax) { progMonitor.currentSampleMax = inMax; }
155  static inline float getCurrentMain() { return mainMonitor.pin == UNDEFINED_PIN ? 0 : mainMonitor.current; }
159  static inline float getCurrentProg() { return progMonitor.pin == UNDEFINED_PIN ? 0 : progMonitor.current; }
160 
161  // Main track functions
162 
170  static inline bool setSpeedMain(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward) { return setThrottle(&(mainRegs), nReg, inLocoId, inStepsNumber, inNewSpeed, inForward); }
174  static inline int identifyLocoIdMain() { return identifyLocoId(&(mainRegs)); }
182  static inline int readCvMain(int inCvId, int callBack = 100, int callBackSub = 200) { return mainRegs.readCVmain(inCvId, callBack, callBackSub); }
190  static inline void writeCvMain(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200) { writeCv(&(mainRegs), inCvId, inValue, callBack, callBackSub); }
196  static inline void setFunctionsMain(int nReg, int inLocoId, FunctionsState &inStates) { setFunctions(&(mainRegs), nReg, inLocoId, inStates); }
197 
198  // Programming track functions
199 
207  static inline bool setSpeedProg(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward) { return setThrottle(&(progRegs), nReg, inLocoId, inStepsNumber, inNewSpeed, inForward); }
211  static inline int identifyLocoIdProg() { return identifyLocoId(&(progRegs)); }
219  static inline int readCvProg(int inCvId, int callBack = 100, int callBackSub = 200) { return progRegs.readCV(inCvId, callBack, callBackSub); }
226  static inline void writeCvProg(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200) { writeCv(&(progRegs), inCvId, inValue, callBack, callBackSub); }
232  static inline void setFunctionsProg(int nReg, int inLocoId, FunctionsState &inStates) { setFunctions(&(progRegs), nReg, inLocoId, inStates); }
233 
234  // Accessories
235 
241  static void setAccessory(int inAddress, byte inSubAddress, byte inActivate);
242 
243 #ifdef DCCPP_PRINT_DCCPP
244 
247  static void showConfiguration();
248 #endif
249 };
250 
251 //-------------------------------------------------------------------
252 #endif
253 //-------------------------------------------------------------------
static void writeCvProg(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:226
static void writeCvMain(int inCvId, byte inValue, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:190
static int readCvMain(int inCvId, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:182
static int identifyLocoIdMain()
Definition: DCCpp.hpp:174
static bool setSpeedMain(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)
Definition: DCCpp.hpp:170
static float getCurrentProg()
Definition: DCCpp.hpp:159
static void setFunctionsProg(int nReg, int inLocoId, FunctionsState &inStates)
Definition: DCCpp.hpp:232
static float getCurrentMain()
Definition: DCCpp.hpp:155
static void setCurrentSampleMaxProg(float inMax)
Definition: DCCpp.hpp:151
static void setCurrentSampleMaxMain(float inMax)
Definition: DCCpp.hpp:147
FunctionsState()
Definition: DCCpp.cpp:24
static void setFunctionsMain(int nReg, int inLocoId, FunctionsState &inStates)
Definition: DCCpp.hpp:196
void activate(byte inFunctionNumber)
Definition: DCCpp.cpp:40
float currentSampleMax
void inactivate(byte inFunctionNumber)
Definition: DCCpp.cpp:45
static bool setSpeedProg(int nReg, int inLocoId, int inStepsNumber, int inNewSpeed, bool inForward)
Definition: DCCpp.hpp:207
void statesSent()
Definition: DCCpp.cpp:60
void clear()
Definition: DCCpp.cpp:29
Definition: DCCpp.hpp:70
bool isActivated(byte inFunctionNumber)
Definition: DCCpp.cpp:50
static int readCvProg(int inCvId, int callBack = 100, int callBackSub = 200)
Definition: DCCpp.hpp:219
static void begin()
Definition: DCCpp.cpp:293
static int identifyLocoIdProg()
Definition: DCCpp.hpp:211
static void loop()
Definition: DCCpp.cpp:92
bool isActivationChanged(byte inFunctionNumber)
Definition: DCCpp.cpp:55
static void beginMain(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)
Definition: DCCpp.cpp:117
static void beginProgPololu()
Definition: DCCpp.hpp:119
static void beginProg(uint8_t inOptionalDirectionMotor, uint8_t inSignalPin, uint8_t inSignalEnablePin, uint8_t inCurrentMonitor)
Definition: DCCpp.cpp:182
static void beginMainMotorShield()
Definition: DCCpp.hpp:109
static void beginProgMotorShield()
Definition: DCCpp.hpp:112
static void setAccessory(int inAddress, byte inSubAddress, byte inActivate)
Definition: DCCpp.cpp:755
static void panicStop(bool inStop)
Definition: DCCpp.cpp:531
static void powerOn()
Definition: DCCpp.cpp:548
static void beginMainPololu()
Definition: DCCpp.hpp:116
static void powerOff()
Definition: DCCpp.cpp:560